MGIS 3.1.0
Loading...
Searching...
No Matches
mgis::function::EvaluatorConcept Concept Reference

a concept that must satisfy an evaluator More...

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

Concept definition

template<typename EvaluatorType>
concept mgis::function::EvaluatorConcept = std::is_move_constructible_v<EvaluatorType> &&
std::is_copy_constructible_v<EvaluatorType> && SpaceConcept<
std::decay_t<decltype(getSpace(std::declval<EvaluatorType>()))>> &&
requires(const EvaluatorType& e) {
{ getNumberOfComponents(e) } -> std::same_as<mgis::size_type>;
} && requires(const EvaluatorType& e, AbstractErrorHandler& eh) {
{ check(eh, e) } -> std::same_as<bool>;
? std::same_as<
EvaluatorType>::ResultType1,
: true) &&
(internals::EvaluatorResultQuery<EvaluatorType>::b2
? std::same_as<
typename internals::EvaluatorResultQuery<
EvaluatorType>::ResultType2,
typename internals::EvaluatorResultQuery<EvaluatorType>::type>
: true) &&
(internals::EvaluatorResultQuery<EvaluatorType>::b3
? std::same_as<
typename internals::EvaluatorResultQuery<
EvaluatorType>::ResultType3,
typename internals::EvaluatorResultQuery<EvaluatorType>::type>
: true) &&
(internals::EvaluatorResultQuery<EvaluatorType>::b4
? std::same_as<
typename internals::EvaluatorResultQuery<
EvaluatorType>::ResultType4,
typename internals::EvaluatorResultQuery<EvaluatorType>::type>
: true)
MGIS_HOST_DEVICE constexpr mgis::size_type getNumberOfComponents(const BinaryOperationModifier< CallableType, FirstEvaluatorType, SecondEvaluatorType > &)
return the number of components of the values returned by a binary operation
Definition BinaryOperation.ixx:80
a concept that must satisfy an evaluator
Definition EvaluatorConcept.hxx:295
a concept describing a space
Definition SpaceConcept.hxx:216
base class for error handlers This class shall be used as arguments to checkPreconditions methods
Definition AbstractErrorHandler.hxx:38
alias used to determine how an evaluator can be called and the type of the values it returns
Definition EvaluatorConcept.hxx:270

Detailed Description

a concept that must satisfy an evaluator

An evaluator is an object which:

  • can be moved and copied,
  • is defined on a space, i.e. for which the getSpace function is available,
  • provides the number of components of the values it returns through the getNumberOfComponents function,
  • can check the values it computes through the check function,
  • can be called with either an element index, or an element workspace and an element index, or a cell index and a quadrature point index, or a cell workspace, a cell index and a quadrature point index. All the valid calls return the same type.

Contrary to a function, an evaluator is called with a constant object and returns constant values.

Template Parameters
EvaluatorTypeevaluator type