ExcitationSpatialFunction Class Reference

Detailed Description

ExcitationSpatialFunction inherited from ceps::Function.

We need a function of time and space because no distinction can be made between f(x) and f(u) functions...

Definition at line 150 of file CompactSupport.hpp.

#include <CompactSupport.hpp>

Inheritance diagram for ExcitationSpatialFunction:

Public Member Functions
	ExcitationSpatialFunction (const CepsString &profile)
	constructor with default parameters More...
	ExcitationSpatialFunction (const CepsString &profile, const CepsReal3D &origin, const CepsReal &diameter, const CepsReal &scaleFactor=1.)
	constructor with custom parameters More...
	~ExcitationSpatialFunction () override
	destructor More...
CepsReal	eval (CepsStandardArgs args) override
	call operator More...
CepsEnum	getFlags () const override
	property : Space dependant More...
Public Member Functions inherited from SAFunc< CepsReal >
	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...

Protected Attributes
ceps::Function< CepsReal(CepsReal)> *	m_adimProfile
	Normalized profile of the function. More...
CepsReal3D	m_origin
	the center of the function More...
CepsReal	m_diameter
	the diameter More...
CepsReal	m_radius
	the radius More...
CepsReal	m_scaleFactor = 1
	the scale_factor More...

Additional Inherited Members
Public Types inherited from SAFunc< CepsReal >
using	BaseFunction = ceps::Function< CepsReal(CepsStandardArgs)>
	Typedef for the function type. More...

Constructor & Destructor Documentation

ExcitationSpatialFunction() [1/2]

ExcitationSpatialFunction::ExcitationSpatialFunction ( const CepsString &  profile )

explicit

constructor with default parameters

Definition at line 192 of file CompactSupport.cpp.

ExcitationSpatialFunction() [2/2]

ExcitationSpatialFunction::ExcitationSpatialFunction	(	const CepsString &	profile,
		const CepsReal3D &	origin,
		const CepsReal &	diameter,
		const CepsReal &	scaleFactor = 1.
	)

constructor with custom parameters

Definition at line 203 of file CompactSupport.cpp.

~ExcitationSpatialFunction()

ExcitationSpatialFunction::~ExcitationSpatialFunction ( )

override

destructor

Definition at line 217 of file CompactSupport.cpp.

Member Function Documentation

eval()

CepsReal ExcitationSpatialFunction::eval ( CepsStandardArgs  args )

override

call operator

Definition at line 223 of file CompactSupport.cpp.

getFlags()

CepsEnum ExcitationSpatialFunction::getFlags ( ) const

overridevirtual

property : Space dependant

Implements SAFunc< CepsReal >.

Definition at line 232 of file CompactSupport.cpp.

Field Documentation

m_adimProfile

ceps::Function<CepsReal (CepsReal)>* ExcitationSpatialFunction::m_adimProfile

protected

Normalized profile of the function.

Definition at line 175 of file CompactSupport.hpp.

m_diameter

CepsReal ExcitationSpatialFunction::m_diameter

protected

the diameter

Definition at line 177 of file CompactSupport.hpp.

m_origin

CepsReal3D ExcitationSpatialFunction::m_origin

protected

the center of the function

Definition at line 176 of file CompactSupport.hpp.

m_radius

CepsReal ExcitationSpatialFunction::m_radius

protected

the radius

Definition at line 178 of file CompactSupport.hpp.

m_scaleFactor

CepsReal ExcitationSpatialFunction::m_scaleFactor = 1

protected

the scale_factor

Definition at line 179 of file CompactSupport.hpp.

---

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

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