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. 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< fvPatchScalarFieldclone (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...
 
scalarFieldheGradient ()
 Access the energy gradient. More...
 
const scalarFieldheGradient () const
 Access the energy gradient. More...
 
virtual void map (const fvPatchScalarField &, const fvPatchFieldMapper &)
 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

Definition at line 49 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ gradientEnergyCalculatedTemperatureFvPatchScalarField() [1/5]

Construct from patch and internal field.

Definition at line 42 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.C.

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

References Foam::evaluate().

Here is the call graph for this function:

◆ gradientEnergyCalculatedTemperatureFvPatchScalarField() [3/5]

◆ gradientEnergyCalculatedTemperatureFvPatchScalarField() [4/5]

Disallow copy without setting internal field reference.

◆ gradientEnergyCalculatedTemperatureFvPatchScalarField() [5/5]

Copy constructor setting internal field reference.

Definition at line 83 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.C.

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.

◆ fixesValue()

virtual bool fixesValue ( ) const
inlinevirtual

Return true if this patch field fixes a value.

Definition at line 130 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.H.

◆ heGradient() [1/2]

scalarField& heGradient ( )
inline

Access the energy gradient.

Definition at line 136 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 142 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.H.

◆ map()

void map ( const fvPatchScalarField ptf,
const fvPatchFieldMapper mapper 
)
virtual

◆ reset()

void reset ( const fvPatchScalarField ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 115 of file gradientEnergyCalculatedTemperatureFvPatchScalarField.C.


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