mgis::function::QuantityModifier< EvaluatorType, UnitType > Struct Template Reference

an evaluator returning the values of a function view as a fixed size span or a scalar More...

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

Inheritance diagram for mgis::function::QuantityModifier< EvaluatorType, UnitType >:

Public Types
using	Space = evaluator_space< EvaluatorType >

Public Member Functions
constexpr	QuantityModifier (const EvaluatorType &)
	constructor
template<bool doPreconditionsCheck>
constexpr	QuantityModifier (const PreconditionsCheck< doPreconditionsCheck > &, const EvaluatorType &)
	constructor
constexpr bool	check (AbstractErrorHandler &) const
	perform consistency checks
decltype(auto)	getSpace () const
	return the underlying space
constexpr size_type	getNumberOfComponents () const
constexpr auto	operator() (const element_index< Space > &) const
	call operator
constexpr auto	operator() (const element_workspace< Space > &, const element_index< Space > &) const
	call operator
constexpr auto	operator() (const cell_index< Space > &, const quadrature_point_index< Space > &) const
	call operator
constexpr auto	operator() (const cell_workspace< Space > &, const cell_index< Space > &, const quadrature_point_index< Space > &) const
	call operator

Static Public Member Functions
static constexpr bool	checkPreconditions (AbstractErrorHandler &, const EvaluatorType &)
	method checking that the precondition of the constructor are met.

Detailed Description

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>
struct mgis::function::QuantityModifier< EvaluatorType, UnitType >

an evaluator returning the values of a function view as a fixed size span or a scalar

Template Parameters

Space	functional space
N	size of the returned value

Constructor & Destructor Documentation

QuantityModifier() [1/2]

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>

constexpr mgis::function::QuantityModifier< EvaluatorType, UnitType >::QuantityModifier ( const EvaluatorType &  e )

constexpr

constructor

Parameters

[in]

values

function

QuantityModifier() [2/2]

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>

template<bool doPreconditionsCheck>

constexpr mgis::function::QuantityModifier< EvaluatorType, UnitType >::QuantityModifier ( const PreconditionsCheck< doPreconditionsCheck > &  pcheck, const EvaluatorType &  e  )

constexpr

constructor

Parameters

[in]	pcheck	object stating if preconditions must be checked
[in]	values	function

Member Function Documentation

checkPreconditions()

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>

constexpr bool mgis::function::QuantityModifier< EvaluatorType, UnitType >::checkPreconditions ( AbstractErrorHandler &  eh, const EvaluatorType &  values  )

staticconstexpr

method checking that the precondition of the constructor are met.

Parameters

[in]	eh	error handler
[in]	e	evaluator

getNumberOfComponents()

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>

constexpr size_type mgis::function::QuantityModifier< EvaluatorType, UnitType >::getNumberOfComponents ( ) const

constexpr

Returns

the number of components

operator()() [1/4]

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>

constexpr auto mgis::function::QuantityModifier< EvaluatorType, UnitType >::operator() ( const cell_index< Space > &  , const quadrature_point_index< Space > &    ) const

constexpr

call operator

Parameters

[in]	e	cell index
[in]	i	integration point index

operator()() [2/4]

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>
requires ((internals::EvaluatorResultQuery<EvaluatorType>::b4) && (isEvaluatorResultTypeMappable<EvaluatorType>))

constexpr auto mgis::function::QuantityModifier< EvaluatorType, UnitType >::operator() ( const cell_workspace< Space > &  wk, const cell_index< Space > &  e, const quadrature_point_index< Space > &  i  ) const

constexpr

call operator

Parameters

[in]	e	cell index
[in]	i	integration point index

operator()() [3/4]

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>
requires ((internals::EvaluatorResultQuery<EvaluatorType>::b1) && (isEvaluatorResultTypeMappable<EvaluatorType>))

constexpr auto mgis::function::QuantityModifier< EvaluatorType, UnitType >::operator() ( const element_index< Space > &  i ) const

constexpr

call operator

Parameters

[in]

i

integration point index

operator()() [4/4]

template<EvaluatorConcept EvaluatorType, ::tfel::math::unit::UnitConcept UnitType>
requires ((internals::EvaluatorResultQuery<EvaluatorType>::b2) && (isEvaluatorResultTypeMappable<EvaluatorType>))

constexpr auto mgis::function::QuantityModifier< EvaluatorType, UnitType >::operator() ( const element_workspace< Space > &  wk, const element_index< Space > &  i  ) const

constexpr

call operator

Parameters

[in]

i

integration point index

---

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

• QuantityModifier.hxx
• QuantityModifier.ixx