Inheritance diagram for CodedSource< Type >:

Collaboration diagram for CodedSource< Type >:

[legend]

Public Member Functions
	TypeName ("coded")

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

fv::option &	redirectOption () const

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

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

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

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

virtual bool	read (const dictionary &dict)

Public Member Functions inherited from cellSetOption
	TypeName ("cellSetOption")

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

virtual	~cellSetOption ()=default

scalar	timeStart () const noexcept

scalar	duration () const noexcept

bool	inTimeLimits (const scalar timeValue) const

selectionModeType	selectionMode () const noexcept

bool	useSubMesh () const noexcept

const word &	cellSetName () const noexcept

scalar	V () const noexcept

const labelList &	cells () const noexcept

scalar	timeStart (scalar val) noexcept

scalar	duration (scalar val) noexcept

virtual bool	isActive ()

Public Member Functions inherited from option
	TypeName ("option")

	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)

autoPtr< option >	clone () const

virtual	~option ()=default

const word &	name () const noexcept

const fvMesh &	mesh () const noexcept

const dictionary &	coeffs () const noexcept

bool	active () const noexcept

void	setApplied (const label fieldi)

bool	active (const bool on) noexcept

virtual label	applyToField (const word &fieldName) const

virtual void	checkApplied () const

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

virtual void	writeFooter (Ostream &) const

virtual void	writeData (Ostream &) const

Static Public Attributes
static constexpr const char *const	codeTemplateC = "codedFvOptionTemplate.C"

static constexpr const char *const	codeTemplateH = "codedFvOptionTemplate.H"

Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_

Protected Member Functions
virtual dlLibraryTable &	libs () const

virtual string	description () const

virtual void	clearRedirect () const

virtual const dictionary &	codeDict () const

virtual void	prepare (dynamicCode &, const dynamicCodeContext &) const

Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)

void	setCellSelection ()

void	setVol ()

Protected Member Functions inherited from option
void	resetApplied ()

Protected Member Functions inherited from codedBase
dynamicCodeContext &	codeContext ()

void	setCodeContext (const dictionary &dict)

void	append (const std::string &str)

void	updateLibrary (const word &name, const dynamicCodeContext &context) const

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

void	updateLibrary (const word &name) const

	codedBase (const codedBase &)=delete

void	operator= (const codedBase &)=delete

	ClassName ("codedBase")

	codedBase ()=default

virtual	~codedBase ()=default

Protected Attributes
word	name_

string	codeCorrect_

string	codeAddSup_

string	codeAddSupRho_

string	codeConstrain_

autoPtr< fv::option >	redirectOptionPtr_

Protected Attributes inherited from cellSetOption
scalar	timeStart_

scalar	duration_

selectionModeType	selectionMode_

word	cellSetName_

List< point >	points_

labelList	cells_

scalar	V_

Protected Attributes inherited from option
const word	name_

const word	modelType_

const fvMesh &	mesh_

dictionary	dict_

dictionary	coeffs_

wordList	fieldNames_

List< bool >	applied_

bool	active_

Additional Inherited Members
Public Types inherited from cellSetOption
enum	selectionModeType { smAll, smCellSet, smCellZone, smPoints }

Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)

Public Attributes inherited from option
bool	log

Static Protected Member Functions inherited from codedBase
static void	writeCodeDict (Ostream &os, const dictionary &dict)

static const dictionary &	codeDict (const objectRegistry &obr, const word &dictName="codeDict")

Detailed Description

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

Definition at line 149 of file CodedFvSource.H.

Constructor & Destructor Documentation

◆ CodedSource()

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

Definition at line 134 of file CodedFvSource.C.

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

Here is the call graph for this function:

Member Function Documentation

◆ libs()

Foam::dlLibraryTable & libs

protectedvirtual

Implements codedBase.

Definition at line 32 of file CodedFvSource.C.

References dlLibraryTable::libs().

Here is the call graph for this function:

◆ description()

Foam::string description

protectedvirtual

Implements codedBase.

Definition at line 39 of file CodedFvSource.C.

◆ clearRedirect()

void clearRedirect

protectedvirtual

Implements codedBase.

Definition at line 46 of file CodedFvSource.C.

◆ codeDict()

const Foam::dictionary & codeDict

protectedvirtual

Implements codedBase.

Definition at line 53 of file CodedFvSource.C.

◆ prepare()

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

protectedvirtual

Implements codedBase.

Definition at line 61 of file CodedFvSource.C.

References dynamicCode::addCompileFile(), dynamicCode::addCopyFile(), DetailInfo, Foam::endl(), dynamicCodeContext::libs(), dynamicCodeContext::options(), dynamicCode::setFilterVariable(), dynamicCode::setMakeOptions(), and dynamicCodeContext::sha1().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "coded" )

◆ redirectOption()

Foam::fv::option & redirectOption

Definition at line 201 of file CodedFvSource.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

Definition at line 222 of file CodedFvSource.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

Definition at line 237 of file CodedFvSource.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

Definition at line 253 of file CodedFvSource.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

Definition at line 270 of file CodedFvSource.C.

References DebugInfo, and Foam::endl().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from cellSetOption.

Definition at line 150 of file CodedFvSource.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ name_

word name_

protected

Definition at line 158 of file CodedFvSource.H.

◆ codeCorrect_

string codeCorrect_

protected

Definition at line 160 of file CodedFvSource.H.

◆ codeAddSup_

string codeAddSup_

protected

Definition at line 161 of file CodedFvSource.H.

◆ codeAddSupRho_

string codeAddSupRho_

protected

Definition at line 162 of file CodedFvSource.H.

◆ codeConstrain_

string codeConstrain_

protected

Definition at line 163 of file CodedFvSource.H.

◆ redirectOptionPtr_

autoPtr<fv::option> redirectOptionPtr_

mutableprotected

Definition at line 166 of file CodedFvSource.H.

◆ codeTemplateC

constexpr const char* const codeTemplateC = "codedFvOptionTemplate.C"

staticconstexpr

Definition at line 193 of file CodedFvSource.H.

◆ codeTemplateH

constexpr const char* const codeTemplateH = "codedFvOptionTemplate.H"

staticconstexpr

Definition at line 197 of file CodedFvSource.H.

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

src/fvOptions/sources/general/codedSource/CodedFvSource.H
src/fvOptions/sources/general/codedSource/CodedFvSource.C

Public Member Functions

Static Public Attributes

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()

◆ description()

◆ clearRedirect()

◆ codeDict()

◆ prepare()

◆ TypeName()

◆ redirectOption()

◆ correct()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ constrain()

◆ read()

Member Data Documentation

◆ name_

◆ codeCorrect_

◆ codeAddSup_

◆ codeAddSupRho_

◆ codeConstrain_

◆ redirectOptionPtr_

◆ codeTemplateC

◆ codeTemplateH

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