Class managing a standard dataset function. More...

#include <arcane/core/StandardCaseFunction.h>

Inheritance diagram for Arcane::StandardCaseFunction:

Collaboration diagram for Arcane::StandardCaseFunction:

Public Member Functions
	StandardCaseFunction (const CaseFunctionBuildInfo &info)
	Constructs a dataset function.
virtual IBinaryMathFunctor< Real, Real, Real > *	getFunctorRealRealToReal () override
virtual IBinaryMathFunctor< Real, Real3, Real > *	getFunctorRealReal3ToReal () override
virtual IBinaryMathFunctor< Real, Real, Real3 > *	getFunctorRealRealToReal3 () override
virtual IBinaryMathFunctor< Real, Real3, Real3 > *	getFunctorRealReal3ToReal3 () override
Public Member Functions inherited from Arcane::CaseFunction
	CaseFunction (const CaseFunctionBuildInfo &info)
	Constructs a dataset function.
String	name () const override
	function name
void	setName (const String &new_name) override
	Sets the function name to new_name.
eParamType	paramType () const override
	Function parameter type.
void	setParamType (eParamType type) override
	Sets the function parameter type.
eValueType	valueType () const override
	Function value type.
void	setValueType (eValueType type) override
	Sets the function value type.
void	setTransformValueFunction (const String &str) override
	Sets a value transformation function. For now, this is just a multiplicative coefficient. The string str must be convertible to the value type.
String	transformValueFunction () const override
	Returns the value transformation function.
void	setTransformParamFunction (const String &str) override
	Sets a parameter transformation function. For now, this is just a multiplicative coefficient. It is only applied to real parameters. The string str must be convertible to a real number.
String	transformParamFunction () const override
	Parameter transformation function.
void	setDeltatCoef (Real v) override
	Sets the value of the deltat multiplier coefficient.
Real	deltatCoef () const override
	Value of the deltat multiplier coefficient.
bool	checkIfValid () const override
	Checks the validity of the function.
Ref< ICaseFunction >	toReference ()
ITraceMng *	traceMng () const
Public Member Functions inherited from Arcane::ICaseFunction
virtual	~ICaseFunction ()=default
	Releases resources.
Public Member Functions inherited from Arcane::ReferenceCounterImpl
void	addReference ()
void	removeReference ()
void	_internalAddReference ()
bool	_internalRemoveReference ()

Private Member Functions
void	value (Real param, Real &v) const override
	Value v of the option for parameter param.
void	value (Real param, Integer &v) const override
	Value v of the option for parameter param.
void	value (Real param, bool &v) const override
	Value v of the option for parameter param.
void	value (Real param, String &v) const override
	Value v of the option for parameter param.
void	value (Real param, Real3 &v) const override
	Value v of the option for parameter param.
void	value (Integer param, Real &v) const override
	Value v of the option for parameter param.
void	value (Integer param, Integer &v) const override
	Value v of the option for parameter param.
void	value (Integer param, bool &v) const override
void	value (Integer param, String &v) const override
	Value v of the option for parameter param.
void	value (Integer param, Real3 &v) const override
	Value v of the option for parameter param.

Additional Inherited Members
Public Types inherited from Arcane::ICaseFunction
enum	eParamType { ParamUnknown = 0 , ParamReal = 1 , ParamInteger = 2 }
	Type of a function parameter. More...
enum	eValueType { ValueUnknown = 0 , ValueReal = 1 , ValueInteger = 2 , ValueBool = 3 , ValueString = 4 , ValueReal3 = 5 }
	Type of a function value. More...
Protected Member Functions inherited from Arcane::CaseFunction
template<typename ParamType>
void	_applyParamTransform2 (ParamType &param) const
Real	_applyValueComulTransform (Real v, Real comul) const
Integer	_applyValueComulTransform (Integer v, Integer comul) const
String	_applyValueComulTransform (const String &v, const String &comul) const
bool	_applyValueComulTransform (bool v, bool comul) const
Real3	_applyValueComulTransform (Real3 v, Real3 comul) const
void	_applyValueTransform (Real &value) const
void	_applyValueTransform (Integer &value) const
void	_applyValueTransform (String &value) const
void	_applyValueTransform (Real3 &value) const
void	_applyValueTransform (bool &value) const
template<typename ValueType>
void	_applyValueTransform2 (ValueType &value) const
void	_applyParamTransform (Real &value) const
void	_applyParamTransform (Integer &value) const

Detailed Description

Class managing a standard dataset function.

This class must be inherited and the derived class must override one of the methods that returns an IFunctionWithArgAndReturn2. Without overriding, all these methods return a null pointer. The derived class is not required to override all the getFunctor* methods but can limit itself to overriding only those it wishes.

Definition at line 41 of file StandardCaseFunction.h.

Constructor & Destructor Documentation

◆ StandardCaseFunction()

Arcane::StandardCaseFunction::StandardCaseFunction ( const CaseFunctionBuildInfo & info )

explicit

Constructs a dataset function.

Definition at line 30 of file StandardCaseFunction.cc.

References Arcane::CaseFunction::CaseFunction().

Here is the call graph for this function:

◆ ~StandardCaseFunction()

Arcane::StandardCaseFunction::~StandardCaseFunction ( )

override

Definition at line 39 of file StandardCaseFunction.cc.

Member Function Documentation

◆ getFunctorRealReal3ToReal()

IBinaryMathFunctor< Real, Real3, Real > * Arcane::StandardCaseFunction::getFunctorRealReal3ToReal ( )

overridevirtual

Implements Arcane::IStandardFunction.

Definition at line 166 of file StandardCaseFunction.cc.

◆ getFunctorRealReal3ToReal3()

IBinaryMathFunctor< Real, Real3, Real3 > * Arcane::StandardCaseFunction::getFunctorRealReal3ToReal3 ( )

overridevirtual

Implements Arcane::IStandardFunction.

Definition at line 184 of file StandardCaseFunction.cc.

◆ getFunctorRealRealToReal()

IBinaryMathFunctor< Real, Real, Real > * Arcane::StandardCaseFunction::getFunctorRealRealToReal ( )

overridevirtual

Implements Arcane::IStandardFunction.

Definition at line 157 of file StandardCaseFunction.cc.

◆ getFunctorRealRealToReal3()

IBinaryMathFunctor< Real, Real, Real3 > * Arcane::StandardCaseFunction::getFunctorRealRealToReal3 ( )

overridevirtual

Implements Arcane::IStandardFunction.

Definition at line 175 of file StandardCaseFunction.cc.

◆ value() [1/10]

void Arcane::StandardCaseFunction::value	(	Integer	param,
		bool &	v ) const

overrideprivatevirtual

Implements Arcane::ICaseFunction.

Definition at line 124 of file StandardCaseFunction.cc.