Applies buoyancy energy sources (i.e. Sb) to the energy equation for compressible flows. More...

Inheritance diagram for buoyancyEnergy:

Collaboration diagram for buoyancyEnergy:

Public Member Functions
	TypeName ("buoyancyEnergy")

	buoyancyEnergy (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)

	buoyancyEnergy (const buoyancyEnergy &)=delete

void	operator= (const buoyancyEnergy &)=delete

virtual	~buoyancyEnergy ()=default

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

virtual bool	read (const dictionary &dict)

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

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

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

Protected Member Functions inherited from option
void	resetApplied ()

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_

Detailed Description

Applies buoyancy energy sources (i.e. Sb) to the energy equation for compressible flows.

$S_b = \rho (\vec{U} \cdot \vec{g})$

where

	=	Buoyancy energy source term
$\rho$	=	Fluid density
$\vec{U}$	=	Velocity field
$\vec{g}$	=	Gravitational acceleration field

Sources applied to either of the below, if exist:

      e         | Internal energy                            [m2/s2]
      h         | Enthalphy                                  [m2/s2]

Required fields:

      U         | Velocity                                   [m/s]
      rho       | Fluid density                              [kg/m3]

Usage

Minimal example by using constant/fvOptions:

buoyancyEnergy1
{
    // Mandatory entries (unmodifiable)
    type             buoyancyEnergy;
    fields           (h);

    // Optional entries (runtime modifiable)
    U                U;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: buoyancyEnergy	word	yes	-
`fields`	Name of operand energy field	word	yes	-
`U`	Name of operand velocity field	word	no	U

The inherited entries are elaborated in:

fvOption.H

Note

The entry fields accepts only a single field name.
The sources are applied onto the entire computational domain.

See also

Source files

Definition at line 154 of file buoyancyEnergy.H.

Constructor & Destructor Documentation

◆ buoyancyEnergy() [1/2]

buoyancyEnergy	(	const word &	sourceName,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

Definition at line 42 of file buoyancyEnergy.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ buoyancyEnergy() [2/2]

buoyancyEnergy ( const buoyancyEnergy & )

delete

◆ ~buoyancyEnergy()

virtual ~buoyancyEnergy ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "buoyancyEnergy" )

◆ operator=()

void operator= ( const buoyancyEnergy & )

delete

◆ addSup()

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

virtual

Reimplemented from option.

Definition at line 67 of file buoyancyEnergy.C.

References g, Foam::New(), rho, and U.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Reimplemented from option.

Definition at line 82 of file buoyancyEnergy.C.

References option::coeffs_, dict, option::read(), and dictionary::readIfPresent().

Here is the call graph for this function:

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ buoyancyEnergy() [1/2]

◆ buoyancyEnergy() [2/2]

◆ ~buoyancyEnergy()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ addSup()

◆ read()