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

File which defines the TensorModifier class, an evaluator returning the values computed by an evaluator as TFEL's tensorial objects. More...

Classes

struct  mgis::function::TensorModifier< TensorType, EvaluatorType >
 an evaluator returning the values computed by an evaluator as TFEL's tensorial objects More...

Namespaces

namespace  mgis
 the namespace mgis encloses all the MGIS project.

Functions

template<TensorConcept TensorType, EvaluatorConcept EvaluatorType>
constexpr bool mgis::function::check (AbstractErrorHandler &, const TensorModifier< TensorType, EvaluatorType > &)
 perform consistency checks
template<TensorConcept TensorType, EvaluatorConcept EvaluatorType>
constexpr mgis::size_type mgis::function::getNumberOfComponents (const TensorModifier< TensorType, EvaluatorType > &) MGIS_NOEXCEPT
 return the number of components

Variables

template<TensorConcept TensorType, EvaluatorConcept EvaluatorType>
constexpr bool mgis::function::areTensorModifierRequirementsSatisfied
 a variable stating if the requirements of the TensorModifier class are met

Detailed Description

File which defines the TensorModifier class, an evaluator returning the values computed by an evaluator as TFEL's tensorial objects.

Author
Thomas Helfer
Date
13/05/2025

Function Documentation

◆ check()

template<TensorConcept TensorType, EvaluatorConcept EvaluatorType>
bool mgis::function::check ( AbstractErrorHandler & eh,
const TensorModifier< TensorType, EvaluatorType > & e )
nodiscardconstexpr

perform consistency checks

Template Parameters
TensorTypetype of the tensorial object to be exposed
EvaluatorTypetype of the underlying evaluator
Parameters
[in]eherror handler used to report the errors
[in]etensor modifier
Returns
true if the values computed by the modifier are valid

◆ getNumberOfComponents()

template<TensorConcept TensorType, EvaluatorConcept EvaluatorType>
mgis::size_type mgis::function::getNumberOfComponents ( const TensorModifier< TensorType, EvaluatorType > & e)
constexpr

return the number of components

Template Parameters
TensorTypetype of the tensorial object to be exposed
EvaluatorTypetype of the underlying evaluator
Parameters
[in]etensor modifier
Returns
the number of components of the modifier, which is the number of components of the tensorial type

Variable Documentation

◆ areTensorModifierRequirementsSatisfied

template<TensorConcept TensorType, EvaluatorConcept EvaluatorType>
bool mgis::function::areTensorModifierRequirementsSatisfied
inlineconstexpr
Initial value:
=
EvaluatorType,
constexpr size_type compile_time_size
number of components (size) of a type if known at compile time, dynamic_extent otherwise
Definition CompileTimeSize.hxx:126
constexpr bool checkEvaluatorNumberOfComponentsCompatibility() MGIS_NOEXCEPT
checks if the number of components of an evaluator is compatible with the number of components expect...
Definition EvaluatorConcept.hxx:514
constexpr auto isEvaluatorResultTypeMappable
true if the result of an evaluator is a mappable type, i.e. a type for which the getDataPointer funct...
Definition EvaluatorConcept.hxx:448

a variable stating if the requirements of the TensorModifier class are met

The values returned by the evaluator must be mappable to memory and their number of components must be compatible with the number of components of the tensorial type, i.e. be equal to it or be only known at run time.

Template Parameters
TensorTypetype of the tensorial object to be exposed
EvaluatorTypetype of the underlying evaluator