MGIS 3.1.0
Loading...
Searching...
No Matches
UniformEvaluator.hxx File Reference

File which defines the UniformEvaluator class, an evaluator which returns the same value at each integration point of a space. More...

#include <span>
#include <array>
#include <type_traits>
#include "MGIS/Config.hxx"
#include "MGIS/Function/SpaceConcept.hxx"
#include "MGIS/Function/EvaluatorConcept.hxx"
#include "MGIS/Function/UniformEvaluator.ixx"

Classes

struct  mgis::function::UniformEvaluator< Space, N >
 class describing a uniform evaluator, i.e. an evaluator which returns the same value at each integration point of a space More...

Namespaces

namespace  mgis
 the namespace mgis encloses all the MGIS project.

Functions

template<SpaceConcept SpaceType>
 mgis::function::UniformEvaluator (const SpaceType &, real) -> UniformEvaluator< SpaceType, 1 >
 deduction guide: a UniformEvaluator built from a scalar value is a scalar valued evaluator
template<SpaceConcept SpaceType, std::size_t N>
 mgis::function::UniformEvaluator (const SpaceType &, const real(&)[N]) -> UniformEvaluator< SpaceType, N >
 deduction guide: a UniformEvaluator built from a C array of N values has N components
template<SpaceConcept SpaceType, std::size_t N>
 mgis::function::UniformEvaluator (const SpaceType &, std::array< real, N >) -> UniformEvaluator< SpaceType, N >
 deduction guide: a UniformEvaluator built from a std::array of N values has N components
template<SpaceConcept SpaceType, std::size_t N>
 mgis::function::UniformEvaluator (const SpaceType &, std::span< real, N >) -> UniformEvaluator< SpaceType, N >
 deduction guide: a UniformEvaluator built from a std::span of N values has N components
template<SpaceConcept Space, std::size_t N>
constexpr bool mgis::function::check (AbstractErrorHandler &, const UniformEvaluator< Space, N > &) MGIS_NOEXCEPT
 checks that a uniform evaluator is consistent with the space on which it is defined
template<SpaceConcept Space, std::size_t N>
constexpr const Space & mgis::function::getSpace (const UniformEvaluator< Space, N > &) MGIS_NOEXCEPT
 return the space on which a uniform evaluator is defined
template<SpaceConcept Space, std::size_t N>
constexpr mgis::size_type mgis::function::getNumberOfComponents (const UniformEvaluator< Space, N > &) MGIS_NOEXCEPT
 return the number of components of a uniform evaluator

Detailed Description

File which defines the UniformEvaluator class, an evaluator which returns the same value at each integration point of a space.

Author
Thomas Helfer
Date
06/10/2025

Function Documentation

◆ check()

template<SpaceConcept Space, std::size_t N>
bool mgis::function::check ( AbstractErrorHandler & ,
const UniformEvaluator< Space, N > &  )
constexpr

checks that a uniform evaluator is consistent with the space on which it is defined

Template Parameters
Spacetype of the space on which the evaluator is defined
Nnumber of components of the evaluator values
Parameters
[in]ehunused error handler
[in]euniform evaluator to be checked
Returns
always true: the values of a uniform evaluator are stored in the evaluator itself and are always valid

◆ getNumberOfComponents()

template<SpaceConcept Space, std::size_t N>
mgis::size_type mgis::function::getNumberOfComponents ( const UniformEvaluator< Space, N > & )
constexpr

return the number of components of a uniform evaluator

Template Parameters
Spacetype of the space on which the evaluator is defined
Nnumber of components of the evaluator values
Parameters
[in]euniform evaluator whose number of components is queried
Returns
N, the number of components of the evaluator values

◆ getSpace()

template<SpaceConcept Space, std::size_t N>
const Space & mgis::function::getSpace ( const UniformEvaluator< Space, N > & e)
constexpr

return the space on which a uniform evaluator is defined

Template Parameters
Spacetype of the space on which the evaluator is defined
Nnumber of components of the evaluator values
Parameters
[in]euniform evaluator
Returns
the space on which the evaluator is defined

◆ UniformEvaluator() [1/4]

template<SpaceConcept SpaceType, std::size_t N>
mgis::function::UniformEvaluator ( const SpaceType & ,
const real(&)[N] )->UniformEvaluator< SpaceType, N >

deduction guide: a UniformEvaluator built from a C array of N values has N components

Template Parameters
SpaceTypetype of the space on which the evaluator is defined
Nnumber of components, which must be greater than one

◆ UniformEvaluator() [2/4]

template<SpaceConcept SpaceType>
mgis::function::UniformEvaluator ( const SpaceType & ,
real  )->UniformEvaluator< SpaceType, 1 >

deduction guide: a UniformEvaluator built from a scalar value is a scalar valued evaluator

Template Parameters
SpaceTypetype of the space on which the evaluator is defined

◆ UniformEvaluator() [3/4]

template<SpaceConcept SpaceType, std::size_t N>
mgis::function::UniformEvaluator ( const SpaceType & ,
std::array< real, N >  )->UniformEvaluator< SpaceType, N >

deduction guide: a UniformEvaluator built from a std::array of N values has N components

Template Parameters
SpaceTypetype of the space on which the evaluator is defined
Nnumber of components, which must be greater than one

◆ UniformEvaluator() [4/4]

template<SpaceConcept SpaceType, std::size_t N>
mgis::function::UniformEvaluator ( const SpaceType & ,
std::span< real, N >  )->UniformEvaluator< SpaceType, N >

deduction guide: a UniformEvaluator built from a std::span of N values has N components

Template Parameters
SpaceTypetype of the space on which the evaluator is defined
Nnumber of components, which must be greater than one