mgis::function::FixedSizeView< FunctionType, N > 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/FixedSizeView.hxx>

Inheritance diagram for mgis::function::FixedSizeView< FunctionType, N >:

Public Types
using	Space = function_space< FunctionType >
using	mutable_value_type = std::conditional_t< N==1, real &, std::span< real, N > >
	value returned by non-const call operator

Public Member Functions
constexpr	FixedSizeView (FunctionType &)
	constructor
template<bool doPreconditionsCheck> requires (N > 0)
constexpr	FixedSizeView (const PreconditionsCheck< doPreconditionsCheck > &, FunctionType &)
	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 mutable_value_type	operator() (const element_index< Space > &)
	call operator
constexpr mutable_value_type	operator() (const element_workspace< Space > &, const element_index< Space > &)
	call operator
constexpr mutable_value_type	operator() (const cell_index< Space > &, const quadrature_point_index< Space > &)
	call operator
constexpr mutable_value_type	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, size_type N>
requires (N > 0)
struct mgis::function::FixedSizeView< FunctionType, N >

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

FixedSizeView() [1/2]

template<FunctionConcept FunctionType, size_type N>
requires (N > 0)

constexpr mgis::function::FixedSizeView< FunctionType, N >::FixedSizeView ( FunctionType &  values )

constexpr

constructor

Parameters

[in]

values

function

FixedSizeView() [2/2]

template<FunctionConcept FunctionType, size_type N>
requires (N > 0)

template<bool doPreconditionsCheck>
requires (N > 0)

constexpr mgis::function::FixedSizeView< FunctionType, N >::FixedSizeView ( const PreconditionsCheck< doPreconditionsCheck > &  pcheck, FunctionType &  values  )

constexpr

constructor

Parameters

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

Member Function Documentation

checkPreconditions()

template<FunctionConcept FunctionType, size_type N>
requires (N > 0)

constexpr bool mgis::function::FixedSizeView< FunctionType, N >::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, size_type N>
requires (N > 0)

constexpr size_type mgis::function::FixedSizeView< FunctionType, N >::getNumberOfComponents ( ) const

constexprnoexcept

Returns

the number of components

operator()() [1/8]

template<FunctionConcept FunctionType, size_type N>

constexpr mutable_value_type mgis::function::FixedSizeView< FunctionType, N >::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, size_type N>

constexpr auto mgis::function::FixedSizeView< FunctionType, N >::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, size_type N>
requires ((internals::FunctionResultQuery<FunctionType>::b4) && (isFunctionResultTypeMappable<FunctionType>))

constexpr FixedSizeView< FunctionType, N >::mutable_value_type mgis::function::FixedSizeView< FunctionType, N >::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, size_type N>
requires ((internals::FunctionResultQuery<FunctionType>::b4) && (isFunctionConstResultTypeMappable<FunctionType>))

constexpr auto mgis::function::FixedSizeView< FunctionType, N >::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, size_type N>
requires ((internals::FunctionResultQuery<FunctionType>::b1) && (isFunctionResultTypeMappable<FunctionType>))

constexpr FixedSizeView< FunctionType, N >::mutable_value_type mgis::function::FixedSizeView< FunctionType, N >::operator() ( const element_index< Space > &  i )

constexpr

call operator

Parameters

[in]

i

integration point index

operator()() [6/8]

template<FunctionConcept FunctionType, size_type N>
requires ((internals::FunctionResultQuery<FunctionType>::b1) && (isFunctionConstResultTypeMappable<FunctionType>))

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

constexpr

call operator

Parameters

[in]

i

integration point index

operator()() [7/8]

template<FunctionConcept FunctionType, size_type N>
requires ((internals::FunctionResultQuery<FunctionType>::b2) && (isFunctionResultTypeMappable<FunctionType>))

constexpr FixedSizeView< FunctionType, N >::mutable_value_type mgis::function::FixedSizeView< FunctionType, N >::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, size_type N>
requires ((internals::FunctionResultQuery<FunctionType>::b2) && (isFunctionConstResultTypeMappable<FunctionType>))

constexpr auto mgis::function::FixedSizeView< FunctionType, N >::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:

• FixedSizeView.hxx
• FixedSizeView.ixx