MGIS 3.1.0
Loading...
Searching...
No Matches
mgis::function::internals::quantity_modifier< UnitType > Struct Template Reference

structure used to modify a function or an evaluator so that it returns its values as quantities, i.e. scalar values associated with a physical unit More...

#include </home/runner/work/MFrontGenericInterfaceSupport/MFrontGenericInterfaceSupport/include/MGIS/Function/TFEL/Quantity.hxx>

Public Types

using Tag = ::mgis::function::EvaluatorModifierTag
 this alias allows to match the Evaluator Modifier concept

Public Member Functions

template<ViewableFunctionArgumentConcept QualifiedFunctionArgumentType>
requires (internals::checkNumberOfComponentsCompatibility< QualifiedFunctionArgumentType, 1u>())
constexpr auto operator() (QualifiedFunctionArgumentType &&f) const
 create a new view
template<EvaluatorConcept EvaluatorType>
requires ( checkEvaluatorNumberOfComponentsCompatibility<EvaluatorType, 1u>())
constexpr auto operator() (const EvaluatorType &e) const
 create a new modifier

Detailed Description

template<::tfel::math::unit::UnitConcept UnitType>
struct mgis::function::internals::quantity_modifier< UnitType >

structure used to modify a function or an evaluator so that it returns its values as quantities, i.e. scalar values associated with a physical unit

Template Parameters
UnitTypeunit of the quantities returned by the modified function or evaluator

Member Function Documentation

◆ operator()() [1/2]

template<::tfel::math::unit::UnitConcept UnitType>
template<EvaluatorConcept EvaluatorType>
requires ( checkEvaluatorNumberOfComponentsCompatibility<EvaluatorType, 1u>())
auto mgis::function::internals::quantity_modifier< UnitType >::operator() ( const EvaluatorType & e) const
inlineconstexpr

create a new modifier

Template Parameters
EvaluatorTypeevaluator type
Parameters
[in]eevaluator
Returns
an evaluator returning the values computed by the given evaluator as quantities with the unit UnitType
Note
only available if the number of components of the evaluator is compatible with a quantity, i.e. is equal to one or is only known at run time

◆ operator()() [2/2]

template<::tfel::math::unit::UnitConcept UnitType>
template<ViewableFunctionArgumentConcept QualifiedFunctionArgumentType>
requires (internals::checkNumberOfComponentsCompatibility< QualifiedFunctionArgumentType, 1u>())
auto mgis::function::internals::quantity_modifier< UnitType >::operator() ( QualifiedFunctionArgumentType && f) const
inlineconstexpr

create a new view

Template Parameters
QualifiedFunctionArgumentTypetype of the function, which may be a qualified type (reference, const, etc...)
Parameters
[in]ffunction
Returns
a view returning the values of the function as quantities with the unit UnitType
Note
only available if the number of components of the function is compatible with a quantity, i.e. is equal to one or is only known at run time

The documentation for this struct was generated from the following file: