SAFunc< _Result > Class Template Reference

Detailed Description

template<typename _Result>
class SAFunc< _Result >

A SAFunc is a ceps::Function that uses CepsStandardArgs as argument of call operator (), hence the name. Moreover, an object is stored as ptr in the class. This object can be used to evaluate the result.

Template Parameters

_Result

Definition at line 99 of file SAFunc.hpp.

#include <SAFunc.hpp>

Inheritance diagram for SAFunc< _Result >:

Public Types
using	BaseFunction = ceps::Function< _Result(CepsStandardArgs)>
	Typedef for the function type. More...

Public Member Functions
	SAFunc (const SAFunc &)=default
	We allow the copy from a functor to another. More...
SAFunc &	operator= (const SAFunc &)=default
	We allow the assignement from a functor to another. More...
virtual CepsEnum	getFlags () const =0
	Could be none, but better make it pure virtual. More...
virtual void	getLocalData ()
	Authorize access to data for solvecSAFunc, other derived classes : nothing. More...
virtual void	releaseLocalData ()
	Authorize access to data for solvecSAFunc, other derived classes : nothing. More...
CepsBool	hasOption (CepsFunctionFlag flag)
	Tells if option is activated. More...

Member Typedef Documentation

BaseFunction

template<typename _Result >

using SAFunc< _Result >::BaseFunction = ceps::Function<_Result(CepsStandardArgs)>

Typedef for the function type.

Definition at line 104 of file SAFunc.hpp.

Constructor & Destructor Documentation

SAFunc()

template<typename _Result >

SAFunc< _Result >::SAFunc ( const SAFunc< _Result > &  )

default

We allow the copy from a functor to another.

Member Function Documentation

getFlags()

template<typename _Result >

virtual CepsEnum SAFunc< _Result >::getFlags ( ) const

pure virtual

Could be none, but better make it pure virtual.

Implemented in OperatorSAFunc< _Op, _Res1, _Res2 >, DicoFuncTimeSelector, TimeOnlySAFunc< _Result >, TimeOnlySAFunc< CepsReal >, ExcitationSpatialFunction, BoundaryCondition< _Result >, CardiacProblem::FiberAligner, AbstractPacemakerProblem::PowerSupply, SolVecSAFunc, FctPiecewiseSAFunc< _Result >, CstPiecewiseSAFunc< _Result >, CoeffInterpolatorSAFunc< _Result >, FileInterpolatorSAFunc, ConstantSAFunc< _Result >, and ArraySAFunc< _Result >.

getLocalData()

template<typename _Result >

virtual void SAFunc< _Result >::getLocalData ( )

virtual

Authorize access to data for solvecSAFunc, other derived classes : nothing.

Reimplemented in OperatorSAFunc< _Op, _Res1, _Res2 >, and SolVecSAFunc.

hasOption()

template<typename _Result >

CepsBool SAFunc< _Result >::hasOption

(

CepsFunctionFlag

flag

)

Tells if option is activated.

operator=()

template<typename _Result >

SAFunc& SAFunc< _Result >::operator= ( const SAFunc< _Result > &  )

default

We allow the assignement from a functor to another.

releaseLocalData()

template<typename _Result >

virtual void SAFunc< _Result >::releaseLocalData ( )

virtual

Authorize access to data for solvecSAFunc, other derived classes : nothing.

Reimplemented in OperatorSAFunc< _Op, _Res1, _Res2 >, and SolVecSAFunc.

---

The documentation for this class was generated from the following file:

• /builds/xxjFYZX3/0/carmen/ceps/src/pde/common/functions/SAFunc.hpp