#include <CodedFvSource.H>

Inheritance diagram for CodedSource< Type >:

[legend]

Collaboration diagram for CodedSource< Type >:

[legend]

Public Member Functions
	TypeName ("coded")
	Runtime type information.
	CodedSource (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
fv::option &	redirectOption () const
	Dynamically compiled fvOption.
virtual void	correct (GeometricField< Type, fvPatchField, volMesh > &)
	Correct field.
virtual void	addSup (fvMatrix< Type > &eqn, const label fieldi)
	Explicit/implicit matrix contributions.
virtual void	addSup (const volScalarField &rho, fvMatrix< Type > &eqn, const label fieldi)
	Explicit/implicit matrix contributions to compressible equation.
virtual void	constrain (fvMatrix< Type > &eqn, const label fieldi)
	Set value.
virtual bool	read (const dictionary &dict)
	Read source dictionary.
Public Member Functions inherited from cellSetOption
	TypeName ("cellSetOption")
	Runtime type information.
	cellSetOption (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
virtual	~cellSetOption ()=default
	Destructor.
scalar	timeStart () const noexcept
	Return const access to the time start.
scalar	duration () const noexcept
	Return const access to the duration.
bool	inTimeLimits (const scalar timeValue) const
	True if within time limits.
bool	useSubMesh () const noexcept
	True if sub-selection should be used.
selectionModeType	selectionMode () const noexcept
	Return the cell selection mode.
const wordRes &	selectionNames () const noexcept
	Return const access to the selection names (set or zone selection).
const wordRe &	zoneName () const
	Return const access to the first set/zone name.
scalar	V () const noexcept
	Return const access to the total cell volume.
const labelList &	cells () const noexcept
	Return const access to the cell selection.
bool	isSelectionUpdated () const noexcept
	Return flag for selection updates.
scalar	timeStart (scalar val) noexcept
	Adjust the time start, return the old value.
scalar	duration (scalar val) noexcept
	Adjust the duration, return the old value.
virtual bool	isActive ()
	Is the source active?
const word &	cellSetName () const
	The name of the cell set/zone [as a word] for "cellSet" / "cellZone" selection modes).
Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information.
	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.
autoPtr< option >	clone () const
	Return clone.
virtual	~option ()=default
	Destructor.
const word &	name () const noexcept
	Return const access to the source name.
const fvMesh &	mesh () const noexcept
	Return const access to the mesh database.
const dictionary &	coeffs () const noexcept
	Return dictionary.
bool	active () const noexcept
	True if source is active.
void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi.
bool	active (const bool on) noexcept
	Change source active flag, return previous value.
virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list.
virtual void	checkApplied () const
	Check that the source has been applied.
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	correct (surfaceScalarField &field)
virtual void	correct (surfaceVectorField &field)
virtual void	correct (surfaceTensorField &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	postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	writeHeader (Ostream &) const
	Write the source header information.
virtual void	writeFooter (Ostream &) const
	Write the source footer information.
virtual void	writeData (Ostream &) const
	Write the source properties.

Static Public Attributes
static constexpr const char *const	codeTemplateC = "codedFvOptionTemplate.C"
	Name of the C code template to be used.
static constexpr const char *const	codeTemplateH = "codedFvOptionTemplate.H"
	Name of the H code template to be used.
Static Public Attributes inherited from cellSetOption
static const Enum< selectionModeType >	selectionModeTypeNames_
	List of selection mode type names.

Protected Member Functions
virtual dlLibraryTable &	libs () const
	Mutable access to the loaded dynamic libraries.
virtual string	description () const
	Description (type + name) for the output.
virtual void	clearRedirect () const
	Clear redirected object(s).
virtual const dictionary &	codeDict () const
	Get the dictionary to initialize the code context.
virtual void	prepare (dynamicCode &, const dynamicCodeContext &) const
	Adapt the context for the current object.
Protected Member Functions inherited from cellSetOption
void	setSelection (const dictionary &dict)
	Set cell selection name or points selection from dictionary input.
void	setCellSelection ()
	Set the cell selection based on user input selection mode.
void	setVol ()
	Recalculate the volume.
Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries.
Protected Member Functions inherited from codedBase
dynamicCodeContext &	codeContext ()
	Access to the dynamic code context.
void	setCodeContext (const dictionary &dict)
	Set code context from a dictionary.
void	append (const std::string &str)
	Add content to SHA1 hashing.
void	updateLibrary (const word &name, const dynamicCodeContext &context) const
	Update library as required, using the given context.
void	updateLibrary (const word &name, const dictionary &dict) const
	Update library as required, using the given code dictionary to use for the context.
void	updateLibrary (const word &name) const
	Update library as required, using the predefined context or use the codeDict() to generate one.
	ClassName ("codedBase")
	Runtime type information.
	codedBase (const codedBase &)=delete
	No copy construct.
void	operator= (const codedBase &)=delete
	No copy assignment.
	codedBase ()=default
	Default construct.
virtual	~codedBase ()=default
	Destructor.

Protected Attributes
word	name_
string	codeCorrect_
string	codeAddSup_
string	codeAddSupRho_
string	codeConstrain_
autoPtr< fv::option >	redirectOptionPtr_
	Underlying code.
Protected Attributes inherited from cellSetOption
selectionModeType	selectionMode_
	Cell selection mode.
bool	updateSelection_
	Flag to enable dictionary-based updates of selections.
scalar	timeStart_
	Start time of fvOption.
scalar	duration_
	Duration of fvOption execution starting from timeStart.
wordRes	selectionNames_
	Face selection names (for set or zone selections).
List< point >	points_
	List of points for "points" selectionMode.
PtrList< Function1< point > >	movingPoints_
	List of points for "movingPoints" selectionMode.
dictionary	geometricSelection_
	Dictionary entries for "geometric" (topoSetCellSource) selection.
labelList	cells_
	Set of cells to apply source to.
scalar	V_
	Sum of cell volumes.
Protected Attributes inherited from option
const word	name_
	Source name.
const word	modelType_
	Model type.
const fvMesh &	mesh_
	Reference to the mesh database.
dictionary	dict_
	Top level source dictionary.
dictionary	coeffs_
	Dictionary containing source coefficients.
wordList	fieldNames_
	Field names to apply source to - populated by derived models.
List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry.
bool	active_
	Source active flag.

Additional Inherited Members
Public Types inherited from cellSetOption
enum	selectionModeType : char { smAll , smCellSet , smCellZone , smPoints , smMovingPoints , smGeometric , smCellType }
	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.
Public Attributes inherited from option
bool	log
	Switch write log to Info.
Static Protected Member Functions inherited from codedBase
static void	writeCodeDict (Ostream &os, const dictionary &dict)
	Write code-dictionary contents.
static const dictionary &	codeDict (const objectRegistry &obr, const word &dictName="codeDict")
	Return "codeDict" from objectRegistry or read from disk.

Detailed Description

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

Definition at line 149 of file CodedFvSource.H.

Constructor & Destructor Documentation

◆ CodedSource()

template<class Type>

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

Construct from components.

Definition at line 133 of file CodedFvSource.C.

References cellSetOption::cellSetOption(), dict, option::mesh(), option::name(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ libs()

template<class Type>

Foam::dlLibraryTable & libs ( ) const

protectedvirtual

Mutable access to the loaded dynamic libraries.

Implements codedBase.

Definition at line 32 of file CodedFvSource.C.

References option::mesh_.

◆ description()

template<class Type>

Foam::string description ( ) const

protectedvirtual

Description (type + name) for the output.

Implements codedBase.

Definition at line 39 of file CodedFvSource.C.

References name_.

◆ clearRedirect()

template<class Type>

void clearRedirect ( ) const

protectedvirtual

Clear redirected object(s).

Implements codedBase.

Definition at line 46 of file CodedFvSource.C.

References redirectOptionPtr_.

◆ codeDict()

template<class Type>

const Foam::dictionary & codeDict ( ) const

protectedvirtual

Get the dictionary to initialize the code context.

Implements codedBase.

Definition at line 53 of file CodedFvSource.C.

References option::coeffs_.

◆ prepare()

template<class Type>

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

protectedvirtual

Adapt the context for the current object.

Implements codedBase.

Definition at line 60 of file CodedFvSource.C.

References dynamicCode::addCompileFile(), dynamicCode::addCopyFile(), codeAddSup_, codeAddSupRho_, codeConstrain_, codeCorrect_, codeTemplateC, codeTemplateH, DetailInfo, Foam::endl(), dynamicCodeContext::libs(), name_, dynamicCodeContext::options(), dynamicCode::setFilterVariable(), dynamicCode::setMakeOptions(), and dynamicCodeContext::sha1().

Here is the call graph for this function:

◆ TypeName()

template<class Type>

TypeName ( "coded" )

Runtime type information.

References dict, option::mesh(), option::name(), and rho.

Here is the call graph for this function:

◆ redirectOption()

template<class Type>

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

Dynamically compiled fvOption.

Definition at line 201 of file CodedFvSource.C.

References dictionary::changeKeyword(), option::dict_, option::mesh_, option::modelType_, name_, option::New(), redirectOptionPtr_, and dictionary::set().

Referenced by addSup(), addSup(), constrain(), and correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correct()

template<class Type>

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

virtual

Correct field.

Definition at line 221 of file CodedFvSource.C.

References DebugInfo, Foam::endl(), field(), name_, redirectOption(), and codedBase::updateLibrary().

Here is the call graph for this function:

◆ addSup() [1/2]

template<class Type>

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

virtual

Explicit/implicit matrix contributions.

Definition at line 236 of file CodedFvSource.C.

References DebugInfo, Foam::endl(), name_, redirectOption(), and codedBase::updateLibrary().

Here is the call graph for this function:

◆ addSup() [2/2]

template<class Type>

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

virtual

Explicit/implicit matrix contributions to compressible equation.

Definition at line 252 of file CodedFvSource.C.

References DebugInfo, Foam::endl(), name_, redirectOption(), rho, and codedBase::updateLibrary().

Here is the call graph for this function:

◆ constrain()

template<class Type>

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

virtual

Set value.

Definition at line 269 of file CodedFvSource.C.

References DebugInfo, Foam::endl(), name_, redirectOption(), and codedBase::updateLibrary().

Here is the call graph for this function:

◆ read()

template<class Type>

bool read ( const dictionary & dict )

virtual

Read source dictionary.

Reimplemented from cellSetOption.

Definition at line 150 of file CodedFvSource.C.

References codeAddSup_, codeAddSupRho_, codeConstrain_, codedBase::codeContext(), codeCorrect_, option::coeffs_, dict, option::fieldNames_, keyType::LITERAL, name_, cellSetOption::read(), option::resetApplied(), and codedBase::setCodeContext().

Referenced by CodedSource().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ name_

template<class Type>

word name_

protected

Definition at line 158 of file CodedFvSource.H.

Referenced by addSup(), addSup(), constrain(), correct(), description(), prepare(), read(), and redirectOption().

◆ codeCorrect_

template<class Type>

string codeCorrect_

protected

Definition at line 160 of file CodedFvSource.H.

Referenced by prepare(), and read().

◆ codeAddSup_

template<class Type>

string codeAddSup_

protected

Definition at line 161 of file CodedFvSource.H.

Referenced by prepare(), and read().

◆ codeAddSupRho_

template<class Type>

string codeAddSupRho_

protected

Definition at line 162 of file CodedFvSource.H.

Referenced by prepare(), and read().

◆ codeConstrain_

template<class Type>

string codeConstrain_

protected

Definition at line 163 of file CodedFvSource.H.

Referenced by prepare(), and read().

◆ redirectOptionPtr_

template<class Type>

autoPtr<fv::option> redirectOptionPtr_

mutableprotected

Underlying code.

Definition at line 168 of file CodedFvSource.H.

Referenced by clearRedirect(), and redirectOption().

◆ codeTemplateC

template<class Type>

const char* const codeTemplateC = "codedFvOptionTemplate.C"

staticconstexpr

Name of the C code template to be used.

Definition at line 206 of file CodedFvSource.H.

Referenced by prepare().

◆ codeTemplateH

template<class Type>

const char* const codeTemplateH = "codedFvOptionTemplate.H"

staticconstexpr

Name of the H code template to be used.

Definition at line 212 of file CodedFvSource.H.

Referenced by prepare().

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

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