MGIS 3.1.0
Loading...
Searching...
No Matches
QuantityModifier.ixx File Reference

File which contains the implementation of the QuantityModifier class declared in MGIS/Function/TFEL/QuantityModifier.hxx. More...

#include "MGIS/Raise.hxx"

Namespaces

namespace  mgis
 the namespace mgis encloses all the MGIS project.

Functions

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>
constexpr decltype(auto) mgis::function::getSpace (const QuantityModifier< EvaluatorType, UnitType > &)
 return the underlying space
template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>
constexpr bool mgis::function::check (AbstractErrorHandler &, const QuantityModifier< EvaluatorType, UnitType > &)
 perform consistency checks
template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>
constexpr size_type mgis::function::getNumberOfComponents (const QuantityModifier< EvaluatorType, UnitType > &)
 return the number of components

Detailed Description

File which contains the implementation of the QuantityModifier class declared in MGIS/Function/TFEL/QuantityModifier.hxx.

Author
Thomas Helfer
Date
16/08/2026

Function Documentation

◆ check()

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>
bool mgis::function::check ( AbstractErrorHandler & eh,
const QuantityModifier< EvaluatorType, UnitType > & e )
nodiscardconstexpr

perform consistency checks

Template Parameters
EvaluatorTypetype of the underlying evaluator
UnitTypeunit of the quantities returned by the modifier
Parameters
[in]eherror handler used to report the errors
[in]equantity modifier
Returns
true if the values computed by the modifier are valid

◆ getNumberOfComponents()

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>
size_type mgis::function::getNumberOfComponents ( const QuantityModifier< EvaluatorType, UnitType > & e)
nodiscardconstexpr

return the number of components

Template Parameters
EvaluatorTypetype of the underlying evaluator
UnitTypeunit of the quantities returned by the modifier
Parameters
[in]equantity modifier
Returns
the number of components of the modifier, which is one

◆ getSpace()

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>
decltype(auto) mgis::function::getSpace ( const QuantityModifier< EvaluatorType, UnitType > & e)
nodiscardconstexpr

return the underlying space

Template Parameters
EvaluatorTypetype of the underlying evaluator
UnitTypeunit of the quantities returned by the modifier
Parameters
[in]equantity modifier
Returns
the space on which the modifier is defined