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

File which declares the TensorView class, an evaluator returning the values of a function as TFEL's tensorial objects. More...

Classes

struct  mgis::function::TensorView< FunctionType, TensorType >
 an evaluator returning the values of a function as TFEL's tensorial objects More...
struct  mgis::function::LightweightViewTraits< TensorView< FunctionType, TensorType > >
 partial specialisation stating that a TensorView is its own view: it only stores a view of the underlying function, so copying it is cheap More...

Namespaces

namespace  mgis
 the namespace mgis encloses all the MGIS project.

Functions

template<FunctionConcept FunctionType, TensorConcept TensorType>
constexpr decltype(auto) mgis::function::getSpace (const TensorView< FunctionType, TensorType > &)
 return the underlying space
template<FunctionConcept FunctionType, TensorConcept TensorType>
constexpr bool mgis::function::check (AbstractErrorHandler &, const TensorView< FunctionType, TensorType > &)
 perform consistency checks
template<FunctionConcept FunctionType, TensorConcept TensorType>
constexpr size_type mgis::function::getNumberOfComponents (const TensorView< FunctionType, TensorType > &) MGIS_NOEXCEPT
 return the number of components

Detailed Description

File which declares the TensorView class, an evaluator returning the values of a function as TFEL's tensorial objects.

Author
Thomas Helfer
Date
09/05/2025

Function Documentation

◆ check()

template<FunctionConcept FunctionType, TensorConcept TensorType>
bool mgis::function::check ( AbstractErrorHandler & eh,
const TensorView< FunctionType, TensorType > & v )
nodiscardconstexpr

perform consistency checks

Template Parameters
FunctionTypetype of the underlying function
TensorTypetype of the tensorial objects returned by the view
Parameters
[in]eherror handler used to report the errors
[in]vtensor view
Returns
true if the values returned by the view are valid

◆ getNumberOfComponents()

template<FunctionConcept FunctionType, TensorConcept TensorType>
size_type mgis::function::getNumberOfComponents ( const TensorView< FunctionType, TensorType > & v)
nodiscardconstexpr

return the number of components

Template Parameters
FunctionTypetype of the underlying function
TensorTypetype of the tensorial objects returned by the view
Parameters
[in]vtensor view
Returns
the number of components of the view, which is the number of components of the tensorial type

◆ getSpace()

template<FunctionConcept FunctionType, TensorConcept TensorType>
decltype(auto) mgis::function::getSpace ( const TensorView< FunctionType, TensorType > & t)
nodiscardconstexpr

return the underlying space

Template Parameters
FunctionTypetype of the underlying function
TensorTypetype of the tensorial objects returned by the view
Parameters
[in]vtensor view
Returns
the space on which the view is defined