This option adds the thermal inertia of a solid phase into the energy equation. It assumes that the solid is in thermal equilibrium with the surrounding fluid phase. More...

Inheritance diagram for solidEquilibriumEnergySource:

[legend]

Collaboration diagram for solidEquilibriumEnergySource:

[legend]

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

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

	solidEquilibriumEnergySource (const solidEquilibriumEnergySource &)=delete
	Disallow default bitwise copy construction. More...

virtual	~solidEquilibriumEnergySource ()
	Destructor. More...

virtual void	addSup (const volScalarField &, fvMatrix< scalar > &, const label)
	Explicit and implicit sources for compressible equations. More...

virtual void	addSup (const volScalarField &, const volScalarField &, fvMatrix< scalar > &, const label)
	Explicit and implicit sources for phase equations. More...

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

void	operator= (const solidEquilibriumEnergySource &)=delete
	Disallow default bitwise assignment. 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 ()
	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 bool	isActive ()
	Is the source active? 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< 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< 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	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...

Additional Inherited Members
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...

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...

Detailed Description

This option adds the thermal inertia of a solid phase into the energy equation. It assumes that the solid is in thermal equilibrium with the surrounding fluid phase.

The volume fraction of the solid phase is read from constant/alpha.<phase>, and the associated thermophysical properties are specified in constant/thermophysicalProperties.<phase>.

Usage

Property	Description	Req'd?	Default
`phase`	Name of the solid phase	yes
`field`	Name of the energy field to apply the option to	yes

Example specification:

    <fvOptionName>
    {
        type        solidEquilibriumEnergySource;
        phase       solid;
        field       e;
    }

Definition at line 87 of file solidEquilibriumEnergySource.H.

Constructor & Destructor Documentation

◆ solidEquilibriumEnergySource() [1/2]

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

Construct from components.

Definition at line 97 of file solidEquilibriumEnergySource.C.

References alpha(), Foam::read(), and thermo.

Here is the call graph for this function:

◆ solidEquilibriumEnergySource() [2/2]

solidEquilibriumEnergySource ( const solidEquilibriumEnergySource & )

delete

Disallow default bitwise copy construction.

◆ ~solidEquilibriumEnergySource()

~solidEquilibriumEnergySource ( )

virtual

Destructor.

Definition at line 115 of file solidEquilibriumEnergySource.C.

References solidEquilibriumEnergySource::addSup().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "solidEquilibriumEnergySource" )

Runtime type information.

◆ addSup() [1/2]

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

virtual

Explicit and implicit sources for compressible equations.

Reimplemented from option.

Definition at line 122 of file solidEquilibriumEnergySource.C.

References alpha(), Foam::fvm::ddt(), Foam::fvm::laplacian(), IOobject::name(), fvMatrix< Type >::psi(), rho, and thermo.

Referenced by solidEquilibriumEnergySource::~solidEquilibriumEnergySource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSup() [2/2]

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

virtual

Explicit and implicit sources for phase equations.

Reimplemented from option.

Definition at line 145 of file solidEquilibriumEnergySource.C.

References alpha(), Foam::fvm::ddt(), Foam::fvm::laplacian(), IOobject::name(), fvMatrix< Type >::psi(), rho, and thermo.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from option.

Definition at line 168 of file solidEquilibriumEnergySource.C.

References option::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const solidEquilibriumEnergySource & )

delete

Disallow default bitwise assignment.

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

src/fvOptions/sources/derived/solidEquilibriumEnergySource/solidEquilibriumEnergySource.H
src/fvOptions/sources/derived/solidEquilibriumEnergySource/solidEquilibriumEnergySource.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ solidEquilibriumEnergySource() [1/2]

◆ solidEquilibriumEnergySource() [2/2]

◆ ~solidEquilibriumEnergySource()

Member Function Documentation

◆ TypeName()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ read()

◆ operator=()