default implementation of a function More...

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

Inheritance diagram for mgis::function::TensorialFunction< Space, TensorType >:

Public Types
using	UnderlyingFunctionType = Function< Space, tfel::math::getUnderlyingArrayMinimalSize< typename TensorType::indexing_policy >()>
	a simple alias

using	UnderlyingTensorView = TensorView< Function< Space, tfel::math::getUnderlyingArrayMinimalSize< typename TensorType::indexing_policy >()>, TensorType >
	a simple alias

Public Types inherited from mgis::function::TensorView< Function< Space, tfel::math::getUnderlyingArrayMinimalSize< TensorType::indexing_policy >()>, TensorType >
using	Space = function_space< FunctionType >

Public Member Functions
constexpr	TensorialFunction (const Space &)
	constructor from a space Vieparam[in] s: space

template<bool doPreconditionsCheck> requires (LinearElementSpaceConcept<Space> \|\| LinearQuadratureSpaceConcept<Space>)
constexpr	TensorialFunction (const PreconditionsCheck< doPreconditionsCheck > &, const Space &)
	constructor from a space

constexpr	TensorialFunction (TensorialFunction &&)
	move constructor

constexpr	TensorialFunction (const TensorialFunction &)
	copy constructor

constexpr UnderlyingTensorView &	view () noexcept
	return a view of the function

constexpr const UnderlyingTensorView &	view () const noexcept
	return a view of the function

Public Member Functions inherited from mgis::function::TensorView< Function< Space, tfel::math::getUnderlyingArrayMinimalSize< TensorType::indexing_policy >()>, TensorType >
constexpr	TensorView (FunctionType &)
	constructor

constexpr	TensorView (const PreconditionsCheck< doPreconditionsCheck > &, FunctionType &)
	constructor

constexpr bool	check (AbstractErrorHandler &) const
	perform consistency checks

constexpr const Space &	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 Space &)
	constructor from a space and a data size

Static Public Member Functions inherited from mgis::function::TensorView< Function< Space, tfel::math::getUnderlyingArrayMinimalSize< TensorType::indexing_policy >()>, TensorType >
static constexpr bool	checkPreconditions (AbstractErrorHandler &, const FunctionType &)
	method checking that the precondition of the constructor are met.

Detailed Description

template<FunctionalSpaceConcept Space, TensorConcept TensorType>
requires (LinearElementSpaceConcept<Space> || LinearQuadratureSpaceConcept<Space>)
struct mgis::function::TensorialFunction< Space, TensorType >

default implementation of a function

Template Parameters

Space	type of the functional space
TensorType	tensor type

Note: the data stride is equal to the data size

Constructor & Destructor Documentation

◆ TensorialFunction()

template<FunctionalSpaceConcept Space, TensorConcept TensorType>
requires (LinearElementSpaceConcept<Space> || LinearQuadratureSpaceConcept<Space>)

template<bool doPreconditionsCheck>
requires (LinearElementSpaceConcept<Space> || LinearQuadratureSpaceConcept<Space>)

constexpr mgis::function::TensorialFunction< Space, TensorType >::TensorialFunction	(	const PreconditionsCheck< doPreconditionsCheck > &	pcheck,
		const Space &	s
	)

constexpr

constructor from a space

Parameters

[in] s space

Member Function Documentation

◆ checkPreconditions()

template<FunctionalSpaceConcept Space, TensorConcept TensorType>
requires (LinearElementSpaceConcept<Space> || LinearQuadratureSpaceConcept<Space>)

constexpr bool mgis::function::TensorialFunction< Space, TensorType >::checkPreconditions	(	AbstractErrorHandler &	,
		const Space &
	)

staticconstexpr

constructor from a space and a data size

Parameters

[in]	eh	error handler
[in]	s	space

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

◆ TensorialFunction()

Member Function Documentation

◆ checkPreconditions()