|
MGIS 3.1.0
|
File which defines the concept an evaluator must satisfy and the helpers used to query the space on which an evaluator is defined and the type of the values it returns. More...
#include <concepts>#include <type_traits>#include "MGIS/Config.hxx"#include "MGIS/AbstractErrorHandler.hxx"#include "MGIS/Function/CompileTimeSize.hxx"#include "MGIS/Function/SpaceConcept.hxx"#include "MGIS/Function/EvaluatorConcept.ixx"Classes | |
| struct | mgis::function::internals::EvaluatorResultQueryImplementation1< bool, EvaluatorType > |
| helper class used to determine the type returned by an evaluator called with an element index, which is an invalid type if the evaluator cannot be called this way More... | |
| struct | mgis::function::internals::EvaluatorResultQueryImplementation1< true, EvaluatorType > |
| specialization used when the evaluator can be called this way More... | |
| struct | mgis::function::internals::EvaluatorResultQueryImplementation2< bool, EvaluatorType > |
| helper class used to determine the type returned by an evaluator called with an element workspace and an element index, which is an invalid type if the evaluator cannot be called this way More... | |
| struct | mgis::function::internals::EvaluatorResultQueryImplementation2< true, EvaluatorType > |
| specialization used when the evaluator can be called this way More... | |
| struct | mgis::function::internals::EvaluatorResultQueryImplementation3< bool, EvaluatorType > |
| helper class used to determine the type returned by an evaluator called with a cell index and a quadrature point index, which is an invalid type if the evaluator cannot be called this way More... | |
| struct | mgis::function::internals::EvaluatorResultQueryImplementation3< true, EvaluatorType > |
| specialization used when the evaluator can be called this way More... | |
| struct | mgis::function::internals::EvaluatorResultQueryImplementation4< bool, EvaluatorType > |
| helper class used to determine the type returned by an evaluator called with a cell workspace, a cell index and a quadrature point index, which is an invalid type if the evaluator cannot be called this way More... | |
| struct | mgis::function::internals::EvaluatorResultQueryImplementation4< true, EvaluatorType > |
| specialization used when the evaluator can be called this way More... | |
| struct | mgis::function::internals::EvaluatorResultQueryImplementation< bool, EvaluatorType > |
| helper class used to determine how an evaluator can be called and the type of the values it returns More... | |
| struct | mgis::function::internals::EvaluatorResultQueryImplementation< true, EvaluatorType > |
| specialization used when the evaluator provides a getSpace function More... | |
| struct | mgis::function::internals::EvaluatorResultQuery< EvaluatorType > |
| alias used to determine how an evaluator can be called and the type of the values it returns More... | |
| struct | mgis::function::internals::NumberOfComponents< EvaluatorType > |
| number of components of an evaluator when known at compile-time, dynamic_extent otherwise More... | |
Namespaces | |
| namespace | mgis |
| the namespace mgis encloses all the MGIS project. | |
Concepts | |
| concept | mgis::function::EvaluatorConcept |
| a concept that must satisfy an evaluator | |
| concept | mgis::function::ElementEvaluatorConcept |
| concept defining evaluators working on an element space | |
| concept | mgis::function::QuadratureEvaluatorConcept |
| concept defining evaluators working on a quadrature space | |
| concept | mgis::function::internals::is_pointer_to_real |
| concept satisfied by a pointer to a scalar value, possibly constant | |
| concept | mgis::function::internals::is_real |
| concept satisfied by real, possibly const or a reference | |
Typedefs | |
| template<EvaluatorConcept EvaluatorType> | |
| using | mgis::function::evaluator_space |
| alias giving the type of the space on which an evaluator is defined | |
| template<EvaluatorConcept EvaluatorType> | |
| using | mgis::function::evaluator_result |
| type of the result of an evaluator, i.e. the type of the constant values returned by the evaluator, which can be a scalar value, a constant std::span or a constant std::array | |
Functions | |
| constexpr bool | mgis::function::checkMatchingSpaces (AbstractErrorHandler &ctx, const EvaluatorConcept auto &e1, const EvaluatorConcept auto &e2) |
| check if the given evaluators share the same space | |
| template<typename ResultType> requires ( requires(ResultType & rr) { { rr.data() } -> internals::is_pointer_to_real; }) | |
| constexpr auto | mgis::function::getDataPointer (ResultType &&r) |
| returns a pointer to the values held by an object with a data method, such as std::span, std::array or the tensorial objects of TFEL/Math | |
| template<internals::is_real ScalarType> | |
| constexpr auto | mgis::function::getDataPointer (ScalarType &&r) MGIS_NOEXCEPT |
| returns a pointer to a scalar value | |
| template<EvaluatorConcept EvaluatorType> | |
| constexpr decltype(auto) | mgis::function::internals::disambiguateGetSpace (const EvaluatorType &e) |
| This helper function allows to disambiguate the call to the getSpace function. | |
| template<EvaluatorConcept EvaluatorType> | |
| constexpr bool | mgis::function::internals::disambiguateCheck (AbstractErrorHandler &eh, const EvaluatorType &e) |
| This helper function allows to disambiguate the call to the check function. | |
| template<EvaluatorConcept EvaluatorType> | |
| constexpr mgis::size_type | mgis::function::internals::disambiguateGetNumberOfComponents (const EvaluatorType &e) |
| This helper function allows to disambiguate the call to the getNumberOfComponents function. | |
| template<EvaluatorConcept EvaluatorType, size_type N> | |
| constexpr bool | mgis::function::internals::checkEvaluatorNumberOfComponentsCompatibility () MGIS_NOEXCEPT |
| checks if the number of components of an evaluator is compatible with the number of components expected by a modifier | |
Variables | |
| template<EvaluatorConcept EvaluatorType> | |
| constexpr auto | mgis::function::isEvaluatorResultTypeMappable |
| true if the result of an evaluator is a mappable type, i.e. a type for which the getDataPointer function returns a pointer to the values it holds | |
File which defines the concept an evaluator must satisfy and the helpers used to query the space on which an evaluator is defined and the type of the values it returns.
| using mgis::function::evaluator_result |
type of the result of an evaluator, i.e. the type of the constant values returned by the evaluator, which can be a scalar value, a constant std::span or a constant std::array
| EvaluatorType | evaluator type |
| using mgis::function::evaluator_space |
alias giving the type of the space on which an evaluator is defined
| EvaluatorType | evaluator type |
|
nodiscardconstexpr |
checks if the number of components of an evaluator is compatible with the number of components expected by a modifier
The check is always satisfied if the number of components of the evaluator is only known at run time.
| EvaluatorType | evaluator type |
| N | number of components expected by the modifier |
|
nodiscardconstexpr |
check if the given evaluators share the same space
implementation of the checkMatchingSpaces function
| [in] | ctx | error handler used to report the errors |
| [in] | e1 | first evaluator |
| [in] | e2 | second evaluator |
|
nodiscardconstexpr |
This helper function allows to disambiguate the call to the check function.
forwards the call to the check function of the evaluator
| EvaluatorType | evaluator type |
| [in] | eh | error handler |
| [in] | e | evaluator |
|
nodiscardconstexpr |
This helper function allows to disambiguate the call to the getNumberOfComponents function.
forwards the call to the getNumberOfComponents function
| EvaluatorType | evaluator type |
| [in] | e | evaluator |
|
constexpr |
This helper function allows to disambiguate the call to the getSpace function.
forwards the call to the getSpace function of the evaluator
| EvaluatorType | evaluator type |
| [in] | e | evaluator |
|
nodiscardconstexpr |
returns a pointer to the values held by an object with a data method, such as std::span, std::array or the tensorial objects of TFEL/Math
| ResultType | type of the object |
| [in] | r | object exposing a data method returning a pointer to scalar values |
|
nodiscardconstexpr |
returns a pointer to a scalar value
| ScalarType | type of the scalar value, which may be a constant reference or a mutable reference |
| [in] | r | scalar value |
|
inlineconstexpr |
true if the result of an evaluator is a mappable type, i.e. a type for which the getDataPointer function returns a pointer to the values it holds
| EvaluatorType | evaluator type |