a modifier returning the values of a function view as a quantity More...

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

Inheritance diagram for mgis::function::QuantityView< FunctionType, UnitType >:

Public Types
using	Space = function_space< FunctionType >

using	ConstructorArgumentType = std::conditional_t< LightweightViewConcept< FunctionType >, FunctionType, FunctionType & >
	a simple alias used to workaround what seems to be a bug in gcc 16.x

Public Member Functions
constexpr	QuantityView (ConstructorArgumentType)
	constructor

template<bool doPreconditionsCheck>
constexpr	QuantityView (const PreconditionsCheck< doPreconditionsCheck > &, ConstructorArgumentType)
	constructor

constexpr bool	check (AbstractErrorHandler &) const
	perform consistency checks

constexpr decltype(auto)	getSpace () const
	return the underlying space

constexpr size_type	getNumberOfComponents () const noexcept

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

constexpr auto	operator() (const element_index< Space > &)
	call operator

constexpr auto	operator() (const element_workspace< Space > &, const element_index< Space > &)
	call operator

constexpr auto	operator() (const cell_index< Space > &, const quadrature_point_index< Space > &)
	call operator

constexpr auto	operator() (const cell_workspace< Space > &, const cell_index< Space > &, const quadrature_point_index< Space > &)
	call operator

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

Detailed Description

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>
struct mgis::function::QuantityView< FunctionType, UnitType >

a modifier returning the values of a function view as a quantity

Template Parameters

Space functional space

Constructor & Destructor Documentation

◆ QuantityView() [1/2]

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>

constexpr mgis::function::QuantityView< FunctionType, UnitType >::QuantityView ( ConstructorArgumentType values )

constexpr

constructor

Parameters

[in] values function

◆ QuantityView() [2/2]

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>

template<bool doPreconditionsCheck>

constexpr mgis::function::QuantityView< FunctionType, UnitType >::QuantityView	(	const PreconditionsCheck< doPreconditionsCheck > &	pcheck,
		ConstructorArgumentType	values
	)

constexpr

constructor

Parameters

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

Member Function Documentation

◆ checkPreconditions()

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>

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

staticconstexpr

method checking that the precondition of the constructor are met.

Parameters

[in]	eh	error handler
[in]	values	function

◆ getNumberOfComponents()

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>

constexpr size_type mgis::function::QuantityView< FunctionType, UnitType >::getNumberOfComponents ( ) const

constexprnoexcept

Returns: the number of components

◆ operator()() [1/8]

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>

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

constexpr

call operator

Parameters

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

◆ operator()() [2/8]

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>

constexpr auto mgis::function::QuantityView< FunctionType, 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()() [3/8]

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>
requires ((internals::FunctionResultQuery<FunctionType>::b4) && (isFunctionResultTypeMappable<FunctionType>))

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

constexpr

call operator

Parameters

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

◆ operator()() [4/8]

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>
requires ((internals::FunctionResultQuery<FunctionType>::b4) && (isFunctionConstResultTypeMappable<FunctionType>))

constexpr auto mgis::function::QuantityView< FunctionType, 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()() [5/8]

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>
requires ((internals::FunctionResultQuery<FunctionType>::b1) && (isFunctionResultTypeMappable<FunctionType>))

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

constexpr

call operator

Parameters

[in] i integration point index

◆ operator()() [6/8]

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>
requires ((internals::FunctionResultQuery<FunctionType>::b1) && (isFunctionConstResultTypeMappable<FunctionType>))

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

constexpr

call operator

Parameters

[in] i integration point index

◆ operator()() [7/8]

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>
requires ((internals::FunctionResultQuery<FunctionType>::b2) && (isFunctionResultTypeMappable<FunctionType>))

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

constexpr

call operator

Parameters

[in] i integration point index

◆ operator()() [8/8]

template<FunctionConcept FunctionType, ::tfel::math::unit::UnitConcept UnitType>
requires ((internals::FunctionResultQuery<FunctionType>::b2) && (isFunctionConstResultTypeMappable<FunctionType>))

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

constexpr

call operator

Parameters

[in]	wk	element workspace
[in]	i	integration point index

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

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QuantityView() [1/2]

◆ QuantityView() [2/2]

Member Function Documentation

◆ checkPreconditions()

◆ getNumberOfComponents()

◆ operator()() [1/8]

◆ operator()() [2/8]

◆ operator()() [3/8]

◆ operator()() [4/8]

◆ operator()() [5/8]

◆ operator()() [6/8]

◆ operator()() [7/8]

◆ operator()() [8/8]