SourceTermManager Class Reference

Detailed Description

Source term manager to create and manage SourceTerm objects.

Definition at line 39 of file SourceTermManager.hpp.

#include <SourceTermManager.hpp>

Inheritance diagram for SourceTermManager:

Public Types
using	Manager = CepsMap< CepsString, ScalarSourceTerm * >
	Alias for manager inside. More...

Public Member Functions
	SourceTermManager (FunctionDictionary *dico)
	Construct a new Source Term Manager object, linked with dictionary of functions. More...
	SourceTermManager (const SourceTermManager &that)=delete
	No copy constructor. More...
SourceTermManager &	operator= (const SourceTermManager &that)=delete
	No assignement operator. More...
	~SourceTermManager () final
	Destroy the Source Term Manager object : default destructor. More...
void	setDofsInfos (DistributedInfos< DegreeOfFreedom * > *dofs)
	Set dofs infos in this class. More...
void	add (const CepsString &params, CepsBool computeSupport=false)
	Add a source term from parameters. More...
void	add (const CepsString &key, const CepsString &params, CepsBool computeSupport=false)
	Add a source term from key and parameters. More...
void	add (const CepsString &key, CepsString &dicokey, const CepsString &params, CepsBool computeSupport=false)
	Add a source term with the key, dico key and parameters. More...
void	add (const CepsString &key, const CepsString &params, ScalarSAFunc *functor, CepsBool computeSupport=false)
	Add a source term with the key, parameters and the functor. More...
void	add (const CepsString &key, ScalarSourceTerm *sourceTerm)
	Add an already configured source term. More...
void	actualizeAll (CepsReal time)
	Actualize all data inside. More...
ScalarSourceTerm *	getSourceTerm (CepsString label) const
	Get a source term, nullptr if not found. More...
CepsVector< ScalarSourceTerm * >	asVector () const
	Get a vector of all source terms. More...
Manager *const	getManager () const
	Get a map of all source terms. More...
CepsUInt	getNbOfSourceTermsOf (CepsSourceTermFlag flag) const
	Number of registered source terms of type flag. More...
CepsUInt	getNbOfSourceTermsOf (CepsEnum flag) const
	Number of registered source terms of type flag. More...
Public Member Functions inherited from CepsObject
	CepsObject ()=default
	default constructor More...
	CepsObject (const CepsObject &)=default
	Copy constructor. More...
virtual	~CepsObject ()=default
	Destructor. More...
CepsObject &	operator= (const CepsObject &)=default
	Assignment operator. More...
CepsObject *	toBaseObject ()
	Returns a pointer to CepsObject class. More...
const CepsObject *	toBaseObject () const
	Returns a pointer to CepsObject class, const version. More...
Profiler *	getProfiler () const
	Access to profiler. More...

Protected Attributes
DistributedInfos< DegreeOfFreedom * > *	m_dofs
	dofs More...
Manager *	m_manager
	the manager More...
FunctionDictionary *	m_dictionary
	the dictionary More...

Additional Inherited Members
Static Protected Attributes inherited from CepsObject
static Profiler	m_profiler
	The same profiler for each big object. More...

Member Typedef Documentation

Manager

using SourceTermManager::Manager = CepsMap<CepsString,ScalarSourceTerm*>

Alias for manager inside.

Definition at line 43 of file SourceTermManager.hpp.

Constructor & Destructor Documentation

SourceTermManager() [1/2]

SourceTermManager::SourceTermManager ( FunctionDictionary *  dico )

explicit

Construct a new Source Term Manager object, linked with dictionary of functions.

Parameters

dico	the dictionary

Definition at line 34 of file SourceTermManager.cpp.

SourceTermManager() [2/2]

SourceTermManager::SourceTermManager ( const SourceTermManager &  that )

delete

No copy constructor.

~SourceTermManager()

SourceTermManager::~SourceTermManager ( )

final

Destroy the Source Term Manager object : default destructor.

Definition at line 41 of file SourceTermManager.cpp.

Member Function Documentation

actualizeAll()

void SourceTermManager::actualizeAll

(

CepsReal

time

)

Actualize all data inside.

Definition at line 254 of file SourceTermManager.cpp.

add() [1/5]

void SourceTermManager::add	(	const CepsString &	key,
		CepsString &	dicokey,
		const CepsString &	params,
		CepsBool	computeSupport = false
	)

Add a source term with the key, dico key and parameters.

Parameters

key	the key of the object
dicokey	the dictionary key to look at the functor
params	the parameters
computeSupport	compute support of source term

Definition at line 94 of file SourceTermManager.cpp.

add() [2/5]

void SourceTermManager::add	(	const CepsString &	key,
		const CepsString &	params,
		CepsBool	computeSupport = false
	)

Add a source term from key and parameters.

Parameters

key	the key of the object
params	the parameters
computeSupport	compute support of source term

Definition at line 75 of file SourceTermManager.cpp.

add() [3/5]

void SourceTermManager::add	(	const CepsString &	key,
		const CepsString &	params,
		ScalarSAFunc *	functor,
		CepsBool	computeSupport = false
	)

Add a source term with the key, parameters and the functor.

Parameters

key	the key of the object
params	the parameters of the source term
functor	the functor associated to the source term
computeSupport	compute support of source term

Definition at line 117 of file SourceTermManager.cpp.

add() [4/5]

void SourceTermManager::add	(	const CepsString &	key,
		ScalarSourceTerm *	sourceTerm
	)

Add an already configured source term.

Parameters

key	the key of the object
sourceTerm	the object itself

Definition at line 236 of file SourceTermManager.cpp.

add() [5/5]

void SourceTermManager::add	(	const CepsString &	params,
		CepsBool	computeSupport = false
	)

Add a source term from parameters.

Parameters

params	the parameters need to begin with a key
computeSupport	compute support of source term

Definition at line 56 of file SourceTermManager.cpp.

asVector()

CepsVector< ScalarSourceTerm * > SourceTermManager::asVector

(

)

const

Get a vector of all source terms.

Definition at line 273 of file SourceTermManager.cpp.

getManager()

SourceTermManager::Manager *const SourceTermManager::getManager

(

)

const

Get a map of all source terms.

Definition at line 279 of file SourceTermManager.cpp.

getNbOfSourceTermsOf() [1/2]

CepsUInt SourceTermManager::getNbOfSourceTermsOf

(

CepsEnum

flag

)

const

Number of registered source terms of type flag.

Definition at line 292 of file SourceTermManager.cpp.

getNbOfSourceTermsOf() [2/2]

CepsUInt SourceTermManager::getNbOfSourceTermsOf

(

CepsSourceTermFlag

flag

)

const

Number of registered source terms of type flag.

Definition at line 285 of file SourceTermManager.cpp.

getSourceTerm()

ScalarSourceTerm * SourceTermManager::getSourceTerm

(

CepsString

label

)

const

Get a source term, nullptr if not found.

Definition at line 263 of file SourceTermManager.cpp.

operator=()

SourceTermManager& SourceTermManager::operator= ( const SourceTermManager &  that )

delete

No assignement operator.

setDofsInfos()

void SourceTermManager::setDofsInfos

(

DistributedInfos< DegreeOfFreedom * > *

dofs

)

Set dofs infos in this class.

Definition at line 49 of file SourceTermManager.cpp.

Field Documentation

m_dictionary

FunctionDictionary* SourceTermManager::m_dictionary

protected

the dictionary

Definition at line 152 of file SourceTermManager.hpp.

m_dofs

DistributedInfos<DegreeOfFreedom*>* SourceTermManager::m_dofs

protected

dofs

Definition at line 150 of file SourceTermManager.hpp.

m_manager

Manager* SourceTermManager::m_manager

protected

the manager

Definition at line 151 of file SourceTermManager.hpp.

---

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

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