gradientEnergyCalculatedTemperatureFvPatchScalarField Class Reference

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

Inheritance diagram for gradientEnergyCalculatedTemperatureFvPatchScalarField:

Collaboration diagram for gradientEnergyCalculatedTemperatureFvPatchScalarField:

Public Member Functions
	TypeName ("gradientEnergyCalculatedTemperature")
	Run-time type information. More...
	gradientEnergyCalculatedTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field. More...
	gradientEnergyCalculatedTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...
	gradientEnergyCalculatedTemperatureFvPatchScalarField (const gradientEnergyCalculatedTemperatureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given fixedValueTypeFvPatchField. More...
	gradientEnergyCalculatedTemperatureFvPatchScalarField (const gradientEnergyCalculatedTemperatureFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. More...
	gradientEnergyCalculatedTemperatureFvPatchScalarField (const gradientEnergyCalculatedTemperatureFvPatchScalarField &, 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 &	heGradient ()
	Access the energy gradient. More...
const scalarField &	heGradient () const
	Access the energy gradient. 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 gradient energy condition can be set directly.

Source files

• gradientEnergyCalculatedTemperatureFvPatchScalarField.H
• gradientEnergyCalculatedTemperatureFvPatchScalarField.C

Definition at line 49 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.H.

Constructor & Destructor Documentation

gradientEnergyCalculatedTemperatureFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 44 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.C.

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

Here is the caller graph for this function:

gradientEnergyCalculatedTemperatureFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 56 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.C.

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

Here is the call graph for this function:

gradientEnergyCalculatedTemperatureFvPatchScalarField() [3/5]

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

Construct by mapping given fixedValueTypeFvPatchField.

onto a new patch

Definition at line 71 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.C.

References gradientEnergyCalculatedTemperatureFvPatchScalarField::gradientEnergyCalculatedTemperatureFvPatchScalarField().

Here is the call graph for this function:

gradientEnergyCalculatedTemperatureFvPatchScalarField() [4/5]

gradientEnergyCalculatedTemperatureFvPatchScalarField ( const gradientEnergyCalculatedTemperatureFvPatchScalarField &  )

delete

Disallow copy without setting internal field reference.

gradientEnergyCalculatedTemperatureFvPatchScalarField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 85 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.C.

References gradientEnergyCalculatedTemperatureFvPatchScalarField::autoMap().

Here is the call graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"gradientEnergyCalculatedTemperature"

)

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.

Definition at line 109 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.H.

References gradientEnergyCalculatedTemperatureFvPatchScalarField::gradientEnergyCalculatedTemperatureFvPatchScalarField().

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 129 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.H.

heGradient() [1/2]

scalarField& heGradient ( )

inline

Access the energy gradient.

Definition at line 135 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.H.

Referenced by gradientEnergyFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

heGradient() [2/2]

const scalarField& heGradient ( ) const

inline

Access the energy gradient.

Definition at line 141 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.H.

References gradientEnergyCalculatedTemperatureFvPatchScalarField::autoMap(), gradientEnergyCalculatedTemperatureFvPatchScalarField::reset(), and gradientEnergyCalculatedTemperatureFvPatchScalarField::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 98 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.C.

References gradientEnergyCalculatedTemperatureFvPatchScalarField::rmap().

Referenced by gradientEnergyCalculatedTemperatureFvPatchScalarField::gradientEnergyCalculatedTemperatureFvPatchScalarField(), and gradientEnergyCalculatedTemperatureFvPatchScalarField::heGradient().

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 108 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.C.

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

Referenced by gradientEnergyCalculatedTemperatureFvPatchScalarField::autoMap(), gradientEnergyCalculatedTemperatureFvPatchScalarField::heGradient(), and gradientEnergyCalculatedTemperatureFvPatchScalarField::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 126 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.C.

References gradientEnergyCalculatedTemperatureFvPatchScalarField::reset().

Referenced by gradientEnergyCalculatedTemperatureFvPatchScalarField::heGradient(), gradientEnergyCalculatedTemperatureFvPatchScalarField::reset(), and gradientEnergyCalculatedTemperatureFvPatchScalarField::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/gradientEnergy/gradientEnergyCalculatedTemperatureFvPatchScalarField.H
• src/thermophysicalModels/basic/derivedFvPatchFields/gradientEnergy/gradientEnergyCalculatedTemperatureFvPatchScalarField.C