|
| constexpr | Function (const Space &) |
| | constructor from a space, for a function whose number of components is known at compile time
|
| constexpr | Function (const Space &, const size_type) |
| | constructor from a space and a data size, for a function whose number of components is only known at run time
|
template<bool doPreconditionsCheck>
requires (N != dynamic_extent) |
| constexpr | Function (const PreconditionsCheck< doPreconditionsCheck > &, const Space &) |
| | constructor from a space, for a function whose number of components is known at compile time
|
template<bool doPreconditionsCheck>
requires (N == dynamic_extent) |
| constexpr | Function (const PreconditionsCheck< doPreconditionsCheck > &, const Space &, const size_type) |
| | constructor from a space and a data size, for a function whose number of components is only known at run time
|
| constexpr | Function (const Function &) |
| | copy constructor when the number of components is only known at run time: copies the values of the function and rebinds the view to them
|
| constexpr | Function (Function &&) |
| | move constructor when the number of components is only known at run time: moves the values of the function and rebinds the view to them
|
| constexpr | Function (const Function &) |
| | copy constructor when the number of components is known at compile time: copies the values of the function and rebinds the view to them
|
| constexpr | Function (Function &&) |
| | move constructor when the number of components is known at compile time: moves the values of the function and rebinds the view to them
|
| constexpr FunctionView< Space, simple_data_layout_description< N >, true > | view () & |
| | return a mutable view of the function
|
| constexpr FunctionView< Space, simple_data_layout_description< N >, false > | view () const & |
| | return an immutable view of the function
|
|
auto | view () &&=delete |
| | deletion of the view of a rvalue function to prevent creating a view pointing to values which are about to be destroyed
|
| constexpr bool | fill (AbstractErrorHandler &, std::span< const real >) MGIS_NOEXCEPT |
| | fill the structure using raw data
|
| constexpr bool | fill (AbstractErrorHandler &, std::initializer_list< real >) MGIS_NOEXCEPT |
| | fill the structure using raw data
|
|
constexpr | ~Function () |
| | destructor
|
| constexpr | FunctionStorage (const Space &s) |
| | constructor for a function whose number of components is known at compile time: allocates N * getSpaceSize(s) values initialized to zero
|
|
constexpr | ~FunctionStorage ()=default |
| | destructor
|
| constexpr | FunctionView (const Space &, ExternalData, const size_type) |
| | constructor when the number of components is known at compile time and the stride is only known at run time
|
| constexpr | FunctionView (const PreconditionsCheck< doPreconditionsCheck > &, const Space &, ExternalData, const size_type) |
| | constructor when the number of components is known at compile time and the stride is only known at run time
|
| constexpr | FunctionView (const Space &, ExternalData, const size_type, const size_type) |
| | constructor when both the number of components and the stride are only known at run time
|
| constexpr | FunctionView (const PreconditionsCheck< doPreconditionsCheck > &, const Space &, ExternalData, const size_type, const size_type) |
| | constructor when both the number of components and the stride are only known at run time
|
| constexpr | FunctionView (const Space &, ExternalData, const size_type) |
| | constructor when both the number of components and the stride are only known at run time, the stride being taken equal to the number of components
|
| constexpr | FunctionView (const PreconditionsCheck< doPreconditionsCheck > &, const Space &, ExternalData, const size_type) |
| | constructor when both the number of components and the stride are only known at run time, the stride being taken equal to the number of components
|
| constexpr | FunctionView (const Space &, ExternalData, const size_type) |
| | constructor when the number of components is only known at run time and the stride is known at compile time
|
| constexpr | FunctionView (const PreconditionsCheck< doPreconditionsCheck > &, const Space &, ExternalData, const size_type) |
| | constructor when the number of components is only known at run time and the stride is known at compile time
|
| constexpr | FunctionView (const Space &, ExternalData) |
| | constructor when both the number of components and the stride are known at compile time
|
| constexpr | FunctionView (const PreconditionsCheck< doPreconditionsCheck > &, const Space &, ExternalData) |
| | constructor when both the number of components and the stride are known at compile time
|
| constexpr | FunctionView (const Space &, ExternalData, const FunctionDataLayout< layout > &) |
| | constructor when both the number of components and the stride are only known at run time and are given by a data layout object
|
| constexpr | FunctionView (const PreconditionsCheck< doPreconditionsCheck > &, const Space &, ExternalData, const FunctionDataLayout< layout > &) |
| | constructor when both the number of components and the stride are only known at run time and are given by a data layout object
|
| constexpr | FunctionView (const Space &, ExternalData, const FunctionDataLayout< layout > &) |
| | constructor when the number of components is known at compile time and the stride is only known at run time and given by a data layout object
|
| constexpr | FunctionView (const PreconditionsCheck< doPreconditionsCheck > &, const Space &, ExternalData, const FunctionDataLayout< layout > &) |
| | constructor when the number of components is known at compile time and the stride is only known at run time and given by a data layout object
|
| constexpr | FunctionView (const Space &, ExternalData, const FunctionDataLayout< layout > &) |
| | constructor when the number of components is only known at run time and given by a data layout object, the stride being known at compile time
|
| constexpr | FunctionView (const PreconditionsCheck< doPreconditionsCheck > &, const Space &, ExternalData, const FunctionDataLayout< layout > &) |
| | constructor when the number of components is only known at run time and given by a data layout object, the stride being known at compile time
|
|
constexpr | FunctionView (FunctionView &&)=default |
| | move constructor
|
|
constexpr | FunctionView (const FunctionView &)=default |
| | copy constructor
|
| constexpr const Space & | getSpace () const MGIS_NOEXCEPT |
| constexpr real * | data (mgis::attributes::UnsafeAttribute, const size_type) |
| | return a pointer to the values associated with an integration point, given its offset
|
| constexpr real * | data (mgis::attributes::UnsafeAttribute, const size_type, const size_type) |
| | return a pointer to the values associated with an integration point, given the index of its cell and its own index
|
| constexpr const real * | data (mgis::attributes::UnsafeAttribute, const size_type) const |
| | return a pointer to the constant values associated with an integration point, given its offset
|
| constexpr const real * | data (mgis::attributes::UnsafeAttribute, const size_type, const size_type) const |
| | return a pointer to the constant values associated with an integration point, given the index of its cell and its own index
|
| constexpr ValuesView | operator() (const size_type) |
| | return the values associated with an integration point, given its offset
|
| constexpr ValuesView | operator() (const size_type, const size_type) |
| | return the values associated with an integration point, given the index of its cell and its own index
|
| constexpr ConstValuesView | operator() (const size_type) const |
| | return the constant values associated with an integration point, given its offset
|
| constexpr ConstValuesView | operator() (const size_type, const size_type) const |
| | return the constant values associated with an integration point, given the index of its cell and its own index
|
| constexpr bool | checkCompatibility (const FunctionView &) const |
| | check if the given view can be used in place of the current one
|
| constexpr std::span< real > | data () |
| constexpr std::span< const real > | data () const |
|
constexpr | ~FunctionView ()=default |
| | destructor
|
|
| FunctionDataLayout ()=default |
| | default constructor
|
|
| FunctionDataLayout (FunctionDataLayout &&)=default |
| | move constructor
|
|
| FunctionDataLayout (const FunctionDataLayout &)=default |
| | copy constructor
|
|
FunctionDataLayout & | operator= (FunctionDataLayout &&)=default |
| | move assignment operator
|
|
FunctionDataLayout & | operator= (const FunctionDataLayout &)=default |
| | copy assignment operator
|
|
| ~FunctionDataLayout ()=default |
| | destructor
|
| constexpr bool | isScalar () const MGIS_NOEXCEPT |
| constexpr size_type | getNumberOfComponents () const MGIS_NOEXCEPT |
| constexpr size_type | getDataStride () const MGIS_NOEXCEPT |
|
| static constexpr bool | checkPreconditions (AbstractErrorHandler &, const Space &) |
| | check that the preconditions to build the function are met when the number of components is known at compile time
|
| static constexpr bool | checkPreconditions (AbstractErrorHandler &, const Space &, const size_type) |
| | check that the preconditions to build the function are met when the number of components is only known at run time
|
| static constexpr bool | checkPreconditions (AbstractErrorHandler &, const Space &, ExternalData) |
| | check that the preconditions to build the view are met when the number of components and the stride are known at compile time
|
| static constexpr bool | checkPreconditions (AbstractErrorHandler &, const Space &, ExternalData, const size_type) |
| | check that the preconditions to build the view are met when the number of components is only known at run time and the stride is known at compile time
|
| static constexpr bool | checkPreconditions (AbstractErrorHandler &, const Space &, ExternalData, const size_type) |
| | check that the preconditions to build the view are met when the number of components is known at compile time and the stride is only known at run time
|
| static constexpr bool | checkPreconditions (AbstractErrorHandler &, const Space &, ExternalData, const size_type) |
| | check that the preconditions to build the view are met when both the number of components and the stride are only known at run time, the stride being taken equal to the number of components
|
| static constexpr bool | checkPreconditions (AbstractErrorHandler &, const Space &, ExternalData, const size_type, const size_type) |
| | check that the preconditions to build the view are met when both the number of components and the stride are only known at run time
|
| static constexpr bool | checkPreconditions (AbstractErrorHandler &, const Space &, ExternalData, const FunctionDataLayout< layout > &) |
| | check that the preconditions to build the view are met when both the number of components and the stride are only known at run time and are given by a data layout object
|
template<LinearFunctionalSpaceConcept Space,
size_type N = dynamic_extent>
requires (N > 0)
struct mgis::function::Function< Space, N >
default implementation of a function, which owns its values
A Function stores its values in a FunctionStorage and derives from the corresponding mutable FunctionView, so it can be called like a function. It matches the FunctionConcept concept but not the EvaluatorConcept concept, whose check function is deleted: a view shall be created to evaluate a function.
- Template Parameters
-
| Space | type of the functional space |
| N | number of components, which may be dynamic_extent and which must be greater than zero |
- Note
- the data stride is equal to the data size