Inheritance diagram for CodedSource< Type >:

Collaboration diagram for CodedSource< Type >:

Public Member Functions
	TypeName ("coded")
	Runtime type information. More...

	CodedSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

option &	redirectFvOption () const
	Dynamically compiled fvOption. More...

virtual void	correct (GeometricField< Type, fvPatchField, volMesh > &)
	Correct field. More...

virtual void	addSup (fvMatrix< Type > &eqn, const label fieldi)
	Explicit/implicit matrix contributions. More...

virtual void	addSup (const volScalarField &rho, fvMatrix< Type > &eqn, const label fieldi)
	Explicit/implicit matrix contributions to compressible equation. More...

virtual void	constrain (fvMatrix< Type > &eqn, const label fieldi)
	Set value. More...

virtual bool	read (const dictionary &dict)
	Read source dictionary. More...

Public Member Functions inherited from cellSetOption
	TypeName ("cellSetOption")
	Runtime type information. More...

	cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

virtual	~cellSetOption ()=default
	Destructor. More...

scalar	timeStart () const
	Return const access to the time start. More...

scalar	duration () const
	Return const access to the duration. More...

bool	inTimeLimits (const scalar time) const
	Return true if within time limits. More...

const selectionModeType &	selectionMode () const
	Return const access to the cell selection mode. More...

const word &	cellSetName () const
	Return const access to the name of cell set for "cellSet". More...

scalar	V () const
	Return const access to the total cell volume. More...

const labelList &	cells () const
	Return const access to the cell set. More...

scalar &	timeStart ()
	Return access to the time start. More...

scalar &	duration ()
	Return access to the duration. More...

virtual bool	isActive ()
	Is the source active? More...

Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))

	option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components. More...

autoPtr< option >	clone () const
	Return clone. More...

virtual	~option ()=default
	Destructor. More...

const word &	name () const
	Return const access to the source name. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs () const
	Return dictionary. More...

bool	active () const
	Return const access to the source active flag. More...

void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi. More...

Switch &	active ()
	Return access to the source active flag. More...

virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list. More...

virtual void	checkApplied () const
	Check that the source has been applied. More...

virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< scalar > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< vector > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< symmTensor > &eqn, const label fieldi)

virtual void	constrain (fvMatrix< tensor > &eqn, const label fieldi)

virtual void	correct (volScalarField &field)

virtual void	correct (volVectorField &field)

virtual void	correct (volSphericalTensorField &field)

virtual void	correct (volSymmTensorField &field)

virtual void	correct (volTensorField &field)

virtual void	postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

virtual void	postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

virtual void	postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)

virtual void	writeHeader (Ostream &) const
	Write the source header information. More...

virtual void	writeFooter (Ostream &) const
	Write the source footer information. More...

virtual void	writeData (Ostream &) const
	Write the source properties. More...

Protected Member Functions
virtual dlLibraryTable &	libs () const
	Mutable access to the loaded dynamic libraries. More...

virtual void	prepare (dynamicCode &, const dynamicCodeContext &) const
	Adapt the context for the current object. More...

virtual string	description () const
	Return a description (type + name) for the output. More...

virtual void	clearRedirect () const
	Clear any redirected objects. More...

virtual const dictionary &	codeDict () const
	Get the dictionary to initialize the codeContext. More...

Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)
	Set the cellSet or points selection. More...

void	setCellSet ()
	Set the cell set based on the user input selection mode. More...

void	setVol ()
	Recalculate the volume. More...

Protected Member Functions inherited from codedBase
void	setCodeContext (const dictionary &dict)
	Set code context from a dictionary. More...

void	append (const std::string &str)
	Add content to SHA1 hashing. More...

void	updateLibrary (const word &name, const dynamicCodeContext &context) const
	Update library as required, using the given context. More...

void	updateLibrary (const word &name, const dictionary &dict) const

void	updateLibrary (const word &name) const

	codedBase (const codedBase &)=delete
	No copy construct. More...

void	operator= (const codedBase &)=delete
	No copy assignment. More...

	ClassName ("codedBase")
	Runtime type information. More...

	codedBase ()=default
	Default construct. More...

virtual	~codedBase ()=default
	Destructor. More...

Protected Attributes
word	name_

string	codeCorrect_

string	codeAddSup_

string	codeConstrain_

autoPtr< option >	redirectFvOptionPtr_
	Underlying functionObject. More...

Protected Attributes inherited from cellSetOption
scalar	timeStart_
	Start time of fvOption. More...

scalar	duration_
	Duration of fvOption execution starting from timeStart. More...

selectionModeType	selectionMode_
	Cell selection mode. More...

word	cellSetName_
	Name of set/zone for "cellSet" and "cellZone" selectionMode. More...

List< point >	points_
	List of points for "points" selectionMode. More...

labelList	cells_
	Set of cells to apply source to. More...

scalar	V_
	Sum of cell volumes. More...

Protected Attributes inherited from option
const word	name_
	Source name. More...

const word	modelType_
	Model type. More...

const fvMesh &	mesh_
	Reference to the mesh database. More...

dictionary	dict_
	Top level source dictionary. More...

dictionary	coeffs_
	Dictionary containing source coefficients. More...

Switch	active_
	Source active flag. More...

wordList	fieldNames_
	Field names to apply source to - populated by derived models. More...

List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry. More...

Additional Inherited Members
Public Types inherited from cellSetOption
enum	selectionModeType { smPoints, smCellSet, smCellZone, smAll }
	Enumeration for selection mode types. More...

Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvOption model. More...

Public Attributes inherited from option
bool	log
	Switch write log to Info. More...

Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_
	List of selection mode type names. More...

Static Protected Member Functions inherited from codedBase
static void	writeCodeDict (Ostream &os, const dictionary &dict)
	Write code-dictionary contents. More...

Detailed Description

template<class Type>
class Foam::fv::CodedSource< Type >

Definition at line 123 of file CodedSource.H.

Constructor & Destructor Documentation

◆ CodedSource()

CodedSource	(	const word &	name,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

Construct from components.

Definition at line 119 of file CodedSource.C.

References dict, and Foam::blockMeshTools::read().

Here is the call graph for this function:

Member Function Documentation

◆ libs()

Foam::dlLibraryTable & libs ( ) const

protectedvirtual

Mutable access to the loaded dynamic libraries.

Implements codedBase.

Definition at line 88 of file CodedSource.C.

References dlLibraryTable::libs().

Here is the call graph for this function:

◆ prepare()

void prepare	(	dynamicCode &	dynCode,
		const dynamicCodeContext &	context
	)		const

protectedvirtual

Adapt the context for the current object.

Implements codedBase.

Definition at line 39 of file CodedSource.C.

References dynamicCode::addCompileFile(), dynamicCode::addCopyFile(), dynamicCodeContext::libs(), dynamicCodeContext::options(), dynamicCode::setFilterVariable(), and dynamicCode::setMakeOptions().

Here is the call graph for this function:

◆ description()

Foam::string description ( ) const

protectedvirtual

Return a description (type + name) for the output.

Implements codedBase.

Definition at line 95 of file CodedSource.C.

◆ clearRedirect()

void clearRedirect ( ) const

protectedvirtual

Clear any redirected objects.

Implements codedBase.

Definition at line 102 of file CodedSource.C.

◆ codeDict()

const Foam::dictionary & codeDict ( ) const

protectedvirtual

Get the dictionary to initialize the codeContext.

Implements codedBase.

Definition at line 109 of file CodedSource.C.

◆ TypeName()

TypeName ( "coded" )

Runtime type information.

◆ redirectFvOption()

Foam::fv::option & redirectFvOption ( ) const

Dynamically compiled fvOption.

Definition at line 135 of file CodedSource.C.

References dictionary::changeKeyword(), Foam::New(), and dictionary::set().

Here is the call graph for this function:

◆ correct()

void correct ( GeometricField< Type, fvPatchField, volMesh > & field )

virtual

Correct field.

Definition at line 156 of file CodedSource.C.

References DebugInfo, Foam::endl(), and field().

Here is the call graph for this function:

◆ addSup() [1/2]

void addSup	(	fvMatrix< Type > &	eqn,
		const label	fieldi
	)

virtual

Explicit/implicit matrix contributions.

Definition at line 171 of file CodedSource.C.

References DebugInfo, and Foam::endl().

Here is the call graph for this function:

◆ addSup() [2/2]

void addSup	(	const volScalarField &	rho,
		fvMatrix< Type > &	eqn,
		const label	fieldi
	)

virtual

Explicit/implicit matrix contributions to compressible equation.

Definition at line 187 of file CodedSource.C.

References DebugInfo, Foam::endl(), and rho.

Here is the call graph for this function:

◆ constrain()

void constrain	(	fvMatrix< Type > &	eqn,
		const label	fieldi
	)

virtual

Set value.

Definition at line 204 of file CodedSource.C.

References DebugInfo, and Foam::endl().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read source dictionary.

Reimplemented from cellSetOption.

Definition at line 34 of file CodedSourceIO.C.

References append(), dict, Foam::constant::electromagnetic::e, Foam::stringOps::inplaceExpand(), and Foam::blockMeshTools::read().

Here is the call graph for this function:

Member Data Documentation

◆ name_

word name_

protected

Definition at line 132 of file CodedSource.H.

◆ codeCorrect_

string codeCorrect_

protected

Definition at line 134 of file CodedSource.H.

◆ codeAddSup_

string codeAddSup_

protected

Definition at line 135 of file CodedSource.H.

◆ codeConstrain_

string codeConstrain_

protected

Definition at line 136 of file CodedSource.H.

◆ redirectFvOptionPtr_

autoPtr<option> redirectFvOptionPtr_

mutableprotected

Underlying functionObject.

Definition at line 139 of file CodedSource.H.

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

src/fvOptions/sources/general/codedSource/CodedSource.H
src/fvOptions/sources/general/codedSource/CodedSource.C
src/fvOptions/sources/general/codedSource/CodedSourceIO.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::fv::CodedSource< Type >

Constructor & Destructor Documentation

◆ CodedSource()

Member Function Documentation

◆ libs()

◆ prepare()

◆ description()

◆ clearRedirect()

◆ codeDict()

◆ TypeName()

◆ redirectFvOption()

◆ correct()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ constrain()

◆ read()

Member Data Documentation

◆ name_

◆ codeCorrect_

◆ codeAddSup_

◆ codeConstrain_

◆ redirectFvOptionPtr_

template<class Type>
class Foam::fv::CodedSource< Type >