This source condition is applied to the temperature field, but provides a uniform fixed energy into the energy equation when the source is positive, and the internal value when it is negative (i.e., a sink) More...

Inheritance diagram for uniformInletOutletEnergyTemperatureFvScalarFieldSource:

[legend]

Collaboration diagram for uniformInletOutletEnergyTemperatureFvScalarFieldSource:

[legend]

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

	uniformInletOutletEnergyTemperatureFvScalarFieldSource (const DimensionedField< scalar, volMesh > &, const dictionary &dict)
	Construct from internal field and dictionary. More...

	uniformInletOutletEnergyTemperatureFvScalarFieldSource (const uniformInletOutletEnergyTemperatureFvScalarFieldSource &, const DimensionedField< scalar, volMesh > &)
	Copy constructor setting internal field reference. More...

virtual autoPtr< fvScalarFieldSource >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual	~uniformInletOutletEnergyTemperatureFvScalarFieldSource ()
	Destructor. More...

virtual tmp< DimensionedField< scalar, volMesh > >	sourceHeValue (const fvSource &model, const DimensionedField< scalar, volMesh > &source) const
	Return the source energy value. More...

virtual tmp< scalarField >	sourceHeValue (const fvSource &model, const scalarField &source, const labelUList &cells) const
	Return the source energy value. More...

virtual tmp< DimensionedField< scalar, volMesh > >	internalCoeff (const fvSource &model, const DimensionedField< scalar, volMesh > &source) const
	Return the internal coefficient. More...

virtual tmp< scalarField >	internalCoeff (const fvSource &model, const scalarField &source, const labelUList &cells) const
	Return the internal coefficient. More...

virtual void	write (Ostream &) const
	Write. More...

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

	energyCalculatedTemperatureFvScalarFieldSource (const DimensionedField< scalar, volMesh > &, const dictionary &dict)
	Construct from internal field and dictionary. More...

	energyCalculatedTemperatureFvScalarFieldSource (const energyCalculatedTemperatureFvScalarFieldSource &, const DimensionedField< scalar, volMesh > &)
	Copy constructor setting internal field reference. More...

virtual	~energyCalculatedTemperatureFvScalarFieldSource ()
	Destructor. More...

virtual tmp< DimensionedField< scalar, volMesh > >	sourceValue (const fvSource &model, const DimensionedField< scalar, volMesh > &source) const
	Return the source value. Not implemented. More...

virtual tmp< scalarField >	sourceValue (const fvSource &model, const scalarField &source, const labelUList &cells) const
	Return the source value. Not implemented. More...

Detailed Description

This source condition is applied to the temperature field, but provides a uniform fixed energy into the energy equation when the source is positive, and the internal value when it is negative (i.e., a sink)

Usage

Property	Description	Required	Default value
`uniformInletHe`	uniform inlet energy value	yes

Example of the boundary condition specification:

    <sourceName>
    {
        type            uniformInletOutletEnergyTemperature;
        uniformInletHe  3700000;
    }

Source files

Definition at line 76 of file uniformInletOutletEnergyTemperatureFvScalarFieldSource.H.

Constructor & Destructor Documentation

◆ uniformInletOutletEnergyTemperatureFvScalarFieldSource() [1/2]

uniformInletOutletEnergyTemperatureFvScalarFieldSource	(	const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from internal field and dictionary.

Definition at line 34 of file uniformInletOutletEnergyTemperatureFvScalarFieldSource.C.

◆ uniformInletOutletEnergyTemperatureFvScalarFieldSource() [2/2]

uniformInletOutletEnergyTemperatureFvScalarFieldSource	(	const uniformInletOutletEnergyTemperatureFvScalarFieldSource &	field,
		const DimensionedField< scalar, volMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 55 of file uniformInletOutletEnergyTemperatureFvScalarFieldSource.C.

◆ ~uniformInletOutletEnergyTemperatureFvScalarFieldSource()

~uniformInletOutletEnergyTemperatureFvScalarFieldSource ( )

virtual

Destructor.

Definition at line 69 of file uniformInletOutletEnergyTemperatureFvScalarFieldSource.C.

Member Function Documentation

◆ TypeName()

TypeName ( "uniformInletOutletEnergyTemperature" )

Runtime type information.

◆ clone()

virtual autoPtr<fvScalarFieldSource> clone ( const DimensionedField< scalar, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 111 of file uniformInletOutletEnergyTemperatureFvScalarFieldSource.H.

◆ sourceHeValue() [1/2]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > sourceHeValue	(	const fvSource &	model,
		const DimensionedField< scalar, volMesh > &	source
	)		const

virtual

Return the source energy value.

Implements energyCalculatedTemperatureFvScalarFieldSource.

Definition at line 77 of file uniformInletOutletEnergyTemperatureFvScalarFieldSource.C.

References Foam::dimensions(), fvModel::name(), and DimensionedField< Type, GeoMesh, PrimitiveField >::New().

Here is the call graph for this function:

◆ sourceHeValue() [2/2]

Foam::tmp< Foam::scalarField > sourceHeValue	(	const fvSource &	model,
		const scalarField &	source,
		const labelUList &	cells
	)		const

virtual

Return the source energy value.

Implements energyCalculatedTemperatureFvScalarFieldSource.

Definition at line 98 of file uniformInletOutletEnergyTemperatureFvScalarFieldSource.C.

References List< T >::size().

Here is the call graph for this function:

◆ internalCoeff() [1/2]

Foam::tmp< Foam::DimensionedField< Foam::scalar, Foam::volMesh > > internalCoeff	(	const fvSource &	model,
		const DimensionedField< scalar, volMesh > &	source
	)		const

virtual

Return the internal coefficient.

Definition at line 111 of file uniformInletOutletEnergyTemperatureFvScalarFieldSource.C.

References Foam::neg0().

Here is the call graph for this function:

◆ internalCoeff() [2/2]

Foam::tmp< Foam::scalarField > internalCoeff	(	const fvSource &	model,
		const scalarField &	source,
		const labelUList &	cells
	)		const

virtual

Return the internal coefficient.

Definition at line 122 of file uniformInletOutletEnergyTemperatureFvScalarFieldSource.C.

References Foam::neg0().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 133 of file uniformInletOutletEnergyTemperatureFvScalarFieldSource.C.

References Foam::dimEnergy, Foam::dimMass, Foam::vtkWriteOps::write(), and Foam::writeEntry().

Here is the call graph for this function:

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

src/thermophysicalModels/basic/derivedFvFieldSources/uniformInletOutletEnergyTemperature/uniformInletOutletEnergyTemperatureFvScalarFieldSource.H
src/thermophysicalModels/basic/derivedFvFieldSources/uniformInletOutletEnergyTemperature/uniformInletOutletEnergyTemperatureFvScalarFieldSource.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ uniformInletOutletEnergyTemperatureFvScalarFieldSource() [1/2]

◆ uniformInletOutletEnergyTemperatureFvScalarFieldSource() [2/2]

◆ ~uniformInletOutletEnergyTemperatureFvScalarFieldSource()

Member Function Documentation

◆ TypeName()

◆ clone()

◆ sourceHeValue() [1/2]

◆ sourceHeValue() [2/2]

◆ internalCoeff() [1/2]

◆ internalCoeff() [2/2]

◆ write()