atmTurbulentHeatFluxTemperatureFvPatchScalarField Class Reference

This boundary condition provides a fixed heat constraint on temperature (i.e. T) to specify temperature gradient through an input heat source which can either be specified as absolute power [W], or as flux [W/m2]. More...

Inheritance diagram for atmTurbulentHeatFluxTemperatureFvPatchScalarField:
[legend]
Collaboration diagram for atmTurbulentHeatFluxTemperatureFvPatchScalarField:
[legend]

Public Member Functions

 TypeName ("atmTurbulentHeatFluxTemperature")
 Runtime type information. More...
 
 atmTurbulentHeatFluxTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 atmTurbulentHeatFluxTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 atmTurbulentHeatFluxTemperatureFvPatchScalarField (const atmTurbulentHeatFluxTemperatureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 atmTurbulentHeatFluxTemperatureFvPatchScalarField (const atmTurbulentHeatFluxTemperatureFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 atmTurbulentHeatFluxTemperatureFvPatchScalarField (const atmTurbulentHeatFluxTemperatureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy 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 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 updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Detailed Description

This boundary condition provides a fixed heat constraint on temperature (i.e. T) to specify temperature gradient through an input heat source which can either be specified as absolute power [W], or as flux [W/m2].

Required fields:

  nut    | Turbulent viscosity                   [m2/s]
  k      | Turbulent kinetic energy              [m2/s2]
Usage
Example of the boundary condition specification:
<patchName>
{
    // Mandatory entries (unmodifiable)
    type            atmTurbulentHeatFluxTemperature;
    heatSource      flux;
    alphaEff        alphaEff;

    // Mandatory entries (runtime modifiable)
    Cp0             0.001;
    q               uniform 10;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Reqd Dflt
heatSource Heat source type word yes -
alphaEff

Name of turbulent thermal diff. field [kg/m/s]

word yes -
Cp0

Specific heat capacity [m2/s2/K]

Function1<scalar> yes -
q

Heat source value [W (power) or W/m2 (flux)]

PatchFunction1<scalar> yes -

The inherited entries are elaborated in:

Options for the heatSource entry:

      power  | Absolute power heat source [W]
      flux   | Flux heat source           [W/m2]
Source files

Definition at line 143 of file atmTurbulentHeatFluxTemperatureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmTurbulentHeatFluxTemperatureFvPatchScalarField() [1/5]

Construct from patch and internal field.

Definition at line 55 of file atmTurbulentHeatFluxTemperatureFvPatchScalarField.C.

◆ atmTurbulentHeatFluxTemperatureFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 87 of file atmTurbulentHeatFluxTemperatureFvPatchScalarField.C.

References dict, dictionary::found(), fvPatchField< Type >::operator=(), p, and UList< T >::size().

Here is the call graph for this function:

◆ atmTurbulentHeatFluxTemperatureFvPatchScalarField() [3/5]

◆ atmTurbulentHeatFluxTemperatureFvPatchScalarField() [4/5]

◆ atmTurbulentHeatFluxTemperatureFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

Definition at line 139 of file atmTurbulentHeatFluxTemperatureFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "atmTurbulentHeatFluxTemperature"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 216 of file atmTurbulentHeatFluxTemperatureFvPatchScalarField.H.

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Definition at line 232 of file atmTurbulentHeatFluxTemperatureFvPatchScalarField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

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

Definition at line 156 of file atmTurbulentHeatFluxTemperatureFvPatchScalarField.C.

References Field< scalar >::autoMap().

Here is the call graph for this function:

◆ rmap()

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

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 166 of file atmTurbulentHeatFluxTemperatureFvPatchScalarField.C.

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 181 of file atmTurbulentHeatFluxTemperatureFvPatchScalarField.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::gSum(), Foam::nl, IOobject::time(), and TimeState::timeOutputValue().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 231 of file atmTurbulentHeatFluxTemperatureFvPatchScalarField.C.

References os(), and Ostream::writeEntry().

Here is the call graph for this function:

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