MGIS 3.1.0
Loading...
Searching...
No Matches
TensorialFunction.hxx File Reference

File which defines the TensorialFunction class, a function which owns its values and returns them as TFEL's tensorial objects, and the aliases for the most common tensorial functions. More...

Classes

struct  mgis::function::TensorialFunction< Space, TensorType >
 default implementation of a function whose values are TFEL's tensorial objects More...

Namespaces

namespace  mgis
 the namespace mgis encloses all the MGIS project.

Typedefs

template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::StensorFunction
 a function whose values are symmetric tensors of dimension N
template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::TensorFunction = TensorialFunction<Space, tfel::math::tensor<N, real>>
 a function whose values are tensors of dimension N
template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::ST2toST2Function
 a function whose values are fourth order tensors mapping symmetric tensors to symmetric tensors, of dimension N
template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::T2toST2Function
 a function whose values are fourth order tensors mapping tensors to symmetric tensors, of dimension N
template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::ST2toT2Function
 a function whose values are fourth order tensors mapping symmetric tensors to tensors, of dimension N
template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::T2toT2Function = TensorialFunction<Space, tfel::math::t2tot2<N, real>>
 a function whose values are fourth order tensors mapping tensors to tensors, of dimension N

Functions

template<FunctionalSpaceConcept Space, TensorConcept TensorType>
constexpr decltype(auto) mgis::function::getSpace (const TensorialFunction< Space, TensorType > &)
 return the underlying space
template<FunctionalSpaceConcept Space, TensorConcept TensorType>
constexpr auto mgis::function::view (TensorialFunction< Space, TensorType > &)
 convert a tensorial function to a mutable view
template<FunctionalSpaceConcept Space, TensorConcept TensorType>
constexpr auto mgis::function::view (const TensorialFunction< Space, TensorType > &)
 convert a tensorial function to a read-only view
template<FunctionalSpaceConcept Space, TensorConcept TensorType>
auto mgis::function::view (TensorialFunction< Space, TensorType > &&)=delete
 creating a view of a temporary tensorial function is forbidden
template<FunctionalSpaceConcept Space, TensorConcept TensorType>
constexpr mgis::size_type mgis::function::getNumberOfComponents (const TensorialFunction< Space, TensorType > &) MGIS_NOEXCEPT
 return the number of components

Detailed Description

File which defines the TensorialFunction class, a function which owns its values and returns them as TFEL's tensorial objects, and the aliases for the most common tensorial functions.

Author
Thomas Helfer
Date
28/08/2025

Typedef Documentation

◆ ST2toST2Function

template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::ST2toST2Function
Initial value:
default implementation of a function whose values are TFEL's tensorial objects
Definition TensorialFunction.hxx:58

a function whose values are fourth order tensors mapping symmetric tensors to symmetric tensors, of dimension N

Template Parameters
Spacetype of the functional space
Ndimension of the symmetric tensors mapped, which must be equal to 1, 2 or 3

◆ ST2toT2Function

template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::ST2toT2Function
Initial value:

a function whose values are fourth order tensors mapping symmetric tensors to tensors, of dimension N

Template Parameters
Spacetype of the functional space
Ndimension of the tensors mapped, which must be equal to 1, 2 or 3

◆ StensorFunction

template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::StensorFunction
Initial value:

a function whose values are symmetric tensors of dimension N

Template Parameters
Spacetype of the functional space
Ndimension of the symmetric tensors, which must be equal to 1, 2 or 3

◆ T2toST2Function

template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::T2toST2Function
Initial value:

a function whose values are fourth order tensors mapping tensors to symmetric tensors, of dimension N

Template Parameters
Spacetype of the functional space
Ndimension of the tensors mapped, which must be equal to 1, 2 or 3

◆ T2toT2Function

template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::T2toT2Function = TensorialFunction<Space, tfel::math::t2tot2<N, real>>

a function whose values are fourth order tensors mapping tensors to tensors, of dimension N

Template Parameters
Spacetype of the functional space
Ndimension of the tensors mapped, which must be equal to 1, 2 or 3

◆ TensorFunction

template<FunctionalSpaceConcept Space, unsigned short N>
using mgis::function::TensorFunction = TensorialFunction<Space, tfel::math::tensor<N, real>>

a function whose values are tensors of dimension N

Template Parameters
Spacetype of the functional space
Ndimension of the tensors, which must be equal to 1, 2 or 3

Function Documentation

◆ getNumberOfComponents()

template<FunctionalSpaceConcept Space, TensorConcept TensorType>
mgis::size_type mgis::function::getNumberOfComponents ( const TensorialFunction< Space, TensorType > & f)
constexpr

return the number of components

Template Parameters
Spacetype of the functional space
TensorTypetype of the tensorial objects returned by the function
Parameters
[in]ftensorial function
Returns
the number of components of the function, which is the number of components of the tensorial type

◆ getSpace()

template<FunctionalSpaceConcept Space, TensorConcept TensorType>
decltype(auto) mgis::function::getSpace ( const TensorialFunction< Space, TensorType > & f)
constexpr

return the underlying space

Template Parameters
Spacetype of the functional space
TensorTypetype of the tensorial objects returned by the function
Parameters
[in]ftensorial function
Returns
the space on which the function is defined

◆ view() [1/3]

template<FunctionalSpaceConcept Space, TensorConcept TensorType>
auto mgis::function::view ( const TensorialFunction< Space, TensorType > & f)
constexpr

convert a tensorial function to a read-only view

Template Parameters
Spacetype of the functional space
TensorTypetype of the tensorial objects returned by the function
Parameters
[in]ftensorial function
Returns
a read-only view of the values of the function

◆ view() [2/3]

template<FunctionalSpaceConcept Space, TensorConcept TensorType>
auto mgis::function::view ( TensorialFunction< Space, TensorType > && )
delete

creating a view of a temporary tensorial function is forbidden

Template Parameters
Spacetype of the functional space
TensorTypetype of the tensorial objects returned by the function

◆ view() [3/3]

template<FunctionalSpaceConcept Space, TensorConcept TensorType>
auto mgis::function::view ( TensorialFunction< Space, TensorType > & f)
constexpr

convert a tensorial function to a mutable view

Template Parameters
Spacetype of the functional space
TensorTypetype of the tensorial objects returned by the function
Parameters
[in]ftensorial function
Returns
a mutable view of the values of the function