TimeOnlySAFunc< _Result > Class Template Reference

Detailed Description

template<class _Result>
class TimeOnlySAFunc< _Result >

================================================================================================ Derivation of SAFunc for constants (no dependance in space) but dependance in time

Abstract field functor (scalar, vector, tensor) dependent of time only. Basically, a f(t) function. This intermediate classs is there just to define the getFlags method. Otherwise, the eval operator must be defined in a derived class (which may use its own attributes as parameters for eval)

See also

ExcitationTimeFunction for an example

Definition at line 111 of file ConstantSAFunc.hpp.

#include <ConstantSAFunc.hpp>

Inheritance diagram for TimeOnlySAFunc< _Result >:

Public Types
using	ResultType = std::remove_pointer_t< _Result >
	The result is the object or the pointed object. More...
Public Types inherited from SAFunc< std::remove_pointer_t< _Result > >
using	BaseFunction = ceps::Function< std::remove_pointer_t< _Result >(CepsStandardArgs)>
	Typedef for the function type. More...

Public Member Functions
	TimeOnlySAFunc ()=default
	Constructor with pointer. Stops if no argument. More...
	TimeOnlySAFunc (const TimeOnlySAFunc &)=default
	We allow the copy from a functor to another. More...
TimeOnlySAFunc &	operator= (const TimeOnlySAFunc &)=default
	We allow the assignement from a functor to another. More...
CepsEnum	getFlags () const override
	Eval operator, must be defined in child classes. More...
Public Member Functions inherited from SAFunc< std::remove_pointer_t< _Result > >
	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 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

ResultType

template<class _Result >

using TimeOnlySAFunc< _Result >::ResultType = std::remove_pointer_t<_Result>

The result is the object or the pointed object.

Definition at line 117 of file ConstantSAFunc.hpp.

Constructor & Destructor Documentation

TimeOnlySAFunc() [1/2]

template<class _Result >

TimeOnlySAFunc< _Result >::TimeOnlySAFunc ( )

default

Constructor with pointer. Stops if no argument.

TimeOnlySAFunc() [2/2]

template<class _Result >

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

default

We allow the copy from a functor to another.

Member Function Documentation

getFlags()

template<class _Result >

CepsEnum TimeOnlySAFunc< _Result >::getFlags ( ) const

overridevirtual

Eval operator, must be defined in child classes.

None and Time, None to tell that is does not depend on space

Implements SAFunc< std::remove_pointer_t< _Result > >.

operator=()

template<class _Result >

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

default

We allow the assignement from a functor to another.

---

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

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