specieTransferTemperatureFvPatchScalarField Class Reference

This is a temperature boundary condition for a specie-transferring wall. More...

Inheritance diagram for specieTransferTemperatureFvPatchScalarField:
Collaboration diagram for specieTransferTemperatureFvPatchScalarField:

Public Member Functions

 TypeName ("specieTransferTemperature")
 Runtime type information. More...
 
 specieTransferTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 specieTransferTemperatureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &, const bool readValue=true)
 Construct from patch, internal field and dictionary. More...
 
 specieTransferTemperatureFvPatchScalarField (const specieTransferTemperatureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given fixedValueTypeFvPatchField. More...
 
 specieTransferTemperatureFvPatchScalarField (const specieTransferTemperatureFvPatchScalarField &)
 Copy constructor. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 specieTransferTemperatureFvPatchScalarField (const specieTransferTemperatureFvPatchScalarField &, 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...
 
const tmp< scalarFieldphiHep () const
 Return the flux of energy. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from mixedEnergyCalculatedTemperatureFvPatchScalarField
 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 &)
 Copy constructor. More...
 
 mixedEnergyCalculatedTemperatureFvPatchScalarField (const mixedEnergyCalculatedTemperatureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. More...
 
scalarFieldheRefValue ()
 Access the energy value. More...
 
const scalarFieldheRefValue () const
 Access the energy value. More...
 
scalarFieldheRefGrad ()
 Access the energy gradient. More...
 
const scalarFieldheRefGrad () const
 Access the energy gradient. More...
 
scalarFieldheValueFraction ()
 Access the energy fraction. More...
 
const scalarFieldheValueFraction () 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...
 

Detailed Description

This is a temperature boundary condition for a specie-transferring wall.

This condition must be used in conjunction with mass-fraction boundary conditions derived from specieTransferMassFractionFvPatchScalarField, and a specieTransferVelocity condition for the velocity.

This condition sums the species' energy fluxes generated by the mass-fraction conditions, and uses this total to set the flux of energy into or out of the domain.

Usage
Property Description Req'd? Default
phi Name of the flux field no phi
U Name of the velocity field no U

Example of the boundary condition specification:

    <patchName>
    {
        type            specieTransferTemperature;
        value           $internalField;
    }
See also
Foam::specieTransferMassFractionFvPatchScalarField Foam::specieTransferVelocityFvPatchScalarField
Source files

Definition at line 91 of file specieTransferTemperatureFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ specieTransferTemperatureFvPatchScalarField() [1/5]

Construct from patch and internal field.

Definition at line 39 of file specieTransferTemperatureFvPatchScalarField.C.

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

Here is the caller graph for this function:

◆ specieTransferTemperatureFvPatchScalarField() [2/5]

specieTransferTemperatureFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const dictionary dict,
const bool  readValue = true 
)

Construct from patch, internal field and dictionary.

Definition at line 52 of file specieTransferTemperatureFvPatchScalarField.C.

References Foam::operator==(), scalarField(), fvPatch::size(), and specieTransferTemperatureFvPatchScalarField::specieTransferTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ specieTransferTemperatureFvPatchScalarField() [3/5]

Construct by mapping given fixedValueTypeFvPatchField.

onto a new patch

Definition at line 72 of file specieTransferTemperatureFvPatchScalarField.C.

References specieTransferTemperatureFvPatchScalarField::specieTransferTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ specieTransferTemperatureFvPatchScalarField() [4/5]

◆ specieTransferTemperatureFvPatchScalarField() [5/5]

Copy constructor setting internal field reference.

Definition at line 99 of file specieTransferTemperatureFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "specieTransferTemperature"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from mixedEnergyCalculatedTemperatureFvPatchScalarField.

Definition at line 145 of file specieTransferTemperatureFvPatchScalarField.H.

References specieTransferTemperatureFvPatchScalarField::specieTransferTemperatureFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

◆ phiHep()

◆ updateCoeffs()

◆ write()

void write ( Ostream os) const
virtual

Write.

Definition at line 189 of file specieTransferTemperatureFvPatchScalarField.C.

References Foam::makePatchTypeField(), fvPatchField< Type >::write(), and Foam::writeEntry().

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

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: