mixedEnergyCalculatedTemperatureFvPatchScalarField Class Reference

Base class for temperature boundary conditions in which the parameters of the mixed energy condition can be set directly. More...

Inheritance diagram for mixedEnergyCalculatedTemperatureFvPatchScalarField:

Collaboration diagram for mixedEnergyCalculatedTemperatureFvPatchScalarField:

Public Member Functions
	TypeName ("mixedEnergyCalculatedTemperature")
	Run-time type information. More...
	mixedEnergyCalculatedTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...
	mixedEnergyCalculatedTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...
	mixedEnergyCalculatedTemperatureFvPatchScalarField (const mixedEnergyCalculatedTemperatureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given fixedValueTypeFvPatchField. More...
	mixedEnergyCalculatedTemperatureFvPatchScalarField (const mixedEnergyCalculatedTemperatureFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. More...
	mixedEnergyCalculatedTemperatureFvPatchScalarField (const mixedEnergyCalculatedTemperatureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Copy constructor setting internal field reference. More...
virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...
virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...
scalarField &	heRefValue ()
	Access the energy value. More...
const scalarField &	heRefValue () const
	Access the energy value. More...
scalarField &	heRefGrad ()
	Access the energy gradient. More...
const scalarField &	heRefGrad () const
	Access the energy gradient. More...
scalarField &	heValueFraction ()
	Access the energy fraction. More...
const scalarField &	heValueFraction () const
	Access the energy fraction. More...
virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...
virtual void	rmap (const fvPatchScalarField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...
virtual void	reset (const fvPatchScalarField &)
	Reset the fvPatchField to the given fvPatchField. More...

Detailed Description

Base class for temperature boundary conditions in which the parameters of the mixed energy condition can be set directly.

Source files

• mixedEnergyCalculatedTemperatureFvPatchScalarField.H
• mixedEnergyCalculatedTemperatureFvPatchScalarField.C

Definition at line 49 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.H.

Constructor & Destructor Documentation

mixedEnergyCalculatedTemperatureFvPatchScalarField() [1/5]

mixedEnergyCalculatedTemperatureFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 44 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.C.

Referenced by mixedEnergyCalculatedTemperatureFvPatchScalarField::clone(), and mixedEnergyCalculatedTemperatureFvPatchScalarField::mixedEnergyCalculatedTemperatureFvPatchScalarField().

Here is the caller graph for this function:

mixedEnergyCalculatedTemperatureFvPatchScalarField() [2/5]

mixedEnergyCalculatedTemperatureFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 58 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.C.

References Foam::evaluate(), and mixedEnergyCalculatedTemperatureFvPatchScalarField::mixedEnergyCalculatedTemperatureFvPatchScalarField().

Here is the call graph for this function:

mixedEnergyCalculatedTemperatureFvPatchScalarField() [3/5]

mixedEnergyCalculatedTemperatureFvPatchScalarField	(	const mixedEnergyCalculatedTemperatureFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given fixedValueTypeFvPatchField.

onto a new patch

Definition at line 75 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.C.

References mixedEnergyCalculatedTemperatureFvPatchScalarField::mixedEnergyCalculatedTemperatureFvPatchScalarField().

Here is the call graph for this function:

mixedEnergyCalculatedTemperatureFvPatchScalarField() [4/5]

mixedEnergyCalculatedTemperatureFvPatchScalarField ( const mixedEnergyCalculatedTemperatureFvPatchScalarField &  )

delete

Disallow copy without setting internal field reference.

mixedEnergyCalculatedTemperatureFvPatchScalarField() [5/5]

mixedEnergyCalculatedTemperatureFvPatchScalarField	(	const mixedEnergyCalculatedTemperatureFvPatchScalarField &	ptf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 91 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.C.

References mixedEnergyCalculatedTemperatureFvPatchScalarField::autoMap().

Here is the call graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"mixedEnergyCalculatedTemperature"

)

Run-time type information.

clone()

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented in specieTransferTemperatureFvPatchScalarField.

Definition at line 115 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.H.

References mixedEnergyCalculatedTemperatureFvPatchScalarField::mixedEnergyCalculatedTemperatureFvPatchScalarField().

Here is the call graph for this function:

fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

Return true if this patch field fixes a value.

Definition at line 135 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.H.

heRefValue() [1/2]

scalarField& heRefValue ( )

inline

Access the energy value.

Definition at line 141 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.H.

Referenced by mixedEnergyFvPatchScalarField::updateCoeffs(), and specieTransferTemperatureFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

heRefValue() [2/2]

const scalarField& heRefValue ( ) const

inline

Access the energy value.

Definition at line 147 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.H.

heRefGrad() [1/2]

scalarField& heRefGrad ( )

inline

Access the energy gradient.

Definition at line 153 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.H.

Referenced by mixedEnergyFvPatchScalarField::updateCoeffs(), and specieTransferTemperatureFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

heRefGrad() [2/2]

const scalarField& heRefGrad ( ) const

inline

Access the energy gradient.

Definition at line 159 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.H.

heValueFraction() [1/2]

scalarField& heValueFraction ( )

inline

Access the energy fraction.

Definition at line 165 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.H.

Referenced by mixedEnergyFvPatchScalarField::updateCoeffs(), and specieTransferTemperatureFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

heValueFraction() [2/2]

const scalarField& heValueFraction ( ) const

inline

Access the energy fraction.

Definition at line 171 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.H.

References mixedEnergyCalculatedTemperatureFvPatchScalarField::autoMap(), mixedEnergyCalculatedTemperatureFvPatchScalarField::reset(), and mixedEnergyCalculatedTemperatureFvPatchScalarField::rmap().

Here is the call graph for this function:

autoMap()

void autoMap ( const fvPatchFieldMapper &  m )

virtual

Map (and resize as needed) from self given a mapping object.

Used to update fields following mesh topology change

Definition at line 106 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.C.

References mixedEnergyCalculatedTemperatureFvPatchScalarField::rmap().

Referenced by mixedEnergyCalculatedTemperatureFvPatchScalarField::heValueFraction(), and mixedEnergyCalculatedTemperatureFvPatchScalarField::mixedEnergyCalculatedTemperatureFvPatchScalarField().

Here is the call graph for this function:

Here is the caller graph for this function:

rmap()

void rmap ( const fvPatchScalarField &  ptf, const labelList &  addr  )

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Used to reconstruct fields

Definition at line 118 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.C.

References mixedEnergyCalculatedTemperatureFvPatchScalarField::reset(), and mixedEnergyCalculatedTemperatureFvPatchScalarField::rmap().

Referenced by mixedEnergyCalculatedTemperatureFvPatchScalarField::autoMap(), mixedEnergyCalculatedTemperatureFvPatchScalarField::heValueFraction(), and mixedEnergyCalculatedTemperatureFvPatchScalarField::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

reset()

void reset ( const fvPatchScalarField &  ptf )

virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 135 of file mixedEnergyCalculatedTemperatureFvPatchScalarField.C.

References mixedEnergyCalculatedTemperatureFvPatchScalarField::reset().

Referenced by mixedEnergyCalculatedTemperatureFvPatchScalarField::heValueFraction(), mixedEnergyCalculatedTemperatureFvPatchScalarField::reset(), and mixedEnergyCalculatedTemperatureFvPatchScalarField::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyCalculatedTemperatureFvPatchScalarField.H
• src/thermophysicalModels/basic/derivedFvPatchFields/mixedEnergy/mixedEnergyCalculatedTemperatureFvPatchScalarField.C