Public Member Functions | Protected Attributes | List of all members
alphatPhaseChangeWallFunctionFvPatchScalarField Class Referenceabstract

Abstract base-class for all alphatWallFunctions supporting phase-change. More...

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

Public Member Functions

 TypeName ("compressible::alphatPhaseChangeWallFunction")
 Runtime type information. More...
 
 alphatPhaseChangeWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 alphatPhaseChangeWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 alphatPhaseChangeWallFunctionFvPatchScalarField (const alphatPhaseChangeWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 alphatPhaseChangeWallFunctionFvPatchScalarField (const alphatPhaseChangeWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
 alphatPhaseChangeWallFunctionFvPatchScalarField (const alphatPhaseChangeWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual const scalarField & dmdt () const
 Return the rate of phase-change. More...
 
virtual const scalarField & mDotL () const
 Return the enthalpy source due to phase-change. More...
 
virtual bool activePhasePair (const phasePairKey &) const
 Is there phase change mass transfer for this phasePair. More...
 
virtual const scalarField & dmdt (const phasePairKey &) const
 Return the rate of phase-change for specific phase pair. More...
 
virtual const scalarField & mDotL (const phasePairKey &) const
 Return the rate of phase-change for specific phase pair. More...
 
virtual scalarField dmdt (const word &) const
 Return the rate of phase-change for specific phase. More...
 
virtual scalarField mDotL (const word &) const
 Return the enthalpy source due to phase-change for specific phase. More...
 
virtual void updateCoeffs ()=0
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Protected Attributes

scalarField dmdt_
 Rate of phase-change. More...
 
scalarField mDotL_
 Latent heat of the phase-change. More...
 

Detailed Description

Abstract base-class for all alphatWallFunctions supporting phase-change.

Usage
Example of the boundary condition specification: 
<patchName>
{
    // Optional entries
    dmdt        <scalarField>;
    mDotL       <scalarField>;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
dmdt Rate of phase-change scalarField no 0.0
mDotL Latent heat of the phase-change scalarField no 0.0

The inherited entries are elaborated in:

See also
  • Foam::fixedValueFvPatchScalarField
  • Foam::alphatWallFunctionFvPatchScalarField
Source files

Definition at line 100 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 46 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 59 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

References dict, alphatPhaseChangeWallFunctionFvPatchScalarField::dmdt_, dictionary::found(), p, and UList< T >::size().

Here is the call graph for this function:

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given alphatPhaseChangeWallFunctionFvPatchScalarField onto a new patch

Definition at line 83 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [4/5]

alphatPhaseChangeWallFunctionFvPatchScalarField ( const alphatPhaseChangeWallFunctionFvPatchScalarField &  awfpsf)

Construct as copy.

Definition at line 98 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [5/5]

alphatPhaseChangeWallFunctionFvPatchScalarField ( const alphatPhaseChangeWallFunctionFvPatchScalarField &  awfpsf,
const DimensionedField< scalar, volMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 110 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "compressible::alphatPhaseChangeWallFunction"  )

Runtime type information.

◆ dmdt() [1/3]

virtual const scalarField & dmdt ( ) const
inlinevirtual

Return the rate of phase-change.

Reimplemented in alphatWallBoilingWallFunctionFvPatchScalarField.

Definition at line 168 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

References alphatPhaseChangeWallFunctionFvPatchScalarField::dmdt_.

◆ mDotL() [1/3]

virtual const scalarField & mDotL ( ) const
inlinevirtual

Return the enthalpy source due to phase-change.

Definition at line 174 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

References alphatPhaseChangeWallFunctionFvPatchScalarField::mDotL_.

◆ activePhasePair()

virtual bool activePhasePair ( const phasePairKey &  ) const
inlinevirtual

Is there phase change mass transfer for this phasePair.

Reimplemented in alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField, and alphatWallBoilingWallFunctionFvPatchScalarField.

Definition at line 180 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

◆ dmdt() [2/3]

virtual const scalarField & dmdt ( const phasePairKey &  ) const
inlinevirtual

Return the rate of phase-change for specific phase pair.

Reimplemented in alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField, alphatWallBoilingWallFunctionFvPatchScalarField, and alphatWallBoilingWallFunctionFvPatchScalarField.

Definition at line 186 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

References alphatPhaseChangeWallFunctionFvPatchScalarField::dmdt_.

◆ mDotL() [2/3]

virtual const scalarField & mDotL ( const phasePairKey &  ) const
inlinevirtual

Return the rate of phase-change for specific phase pair.

Reimplemented in alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField, and alphatWallBoilingWallFunctionFvPatchScalarField.

Definition at line 192 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

References alphatPhaseChangeWallFunctionFvPatchScalarField::mDotL_.

◆ dmdt() [3/3]

virtual scalarField dmdt ( const word &  ) const
inlinevirtual

Return the rate of phase-change for specific phase.

Reimplemented in alphatWallBoilingWallFunctionFvPatchScalarField.

Definition at line 198 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

References alphatPhaseChangeWallFunctionFvPatchScalarField::dmdt_.

◆ mDotL() [3/3]

virtual scalarField mDotL ( const word &  ) const
inlinevirtual

Return the enthalpy source due to phase-change for specific phase.

Definition at line 204 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

References alphatPhaseChangeWallFunctionFvPatchScalarField::mDotL_.

◆ updateCoeffs()

virtual void updateCoeffs ( )
pure virtual

Update the coefficients associated with the patch field.

Implemented in alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField, alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField, and alphatWallBoilingWallFunctionFvPatchScalarField.

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Reimplemented in alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField, alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField, and alphatWallBoilingWallFunctionFvPatchScalarField.

Definition at line 125 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

References alphatPhaseChangeWallFunctionFvPatchScalarField::dmdt_, alphatPhaseChangeWallFunctionFvPatchScalarField::mDotL_, os(), ObukhovLength::write(), and Field< Type >::writeEntry().

Here is the call graph for this function:

Member Data Documentation

◆ dmdt_

scalarField dmdt_
protected

Rate of phase-change.

Definition at line 109 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

Referenced by alphatPhaseChangeWallFunctionFvPatchScalarField::alphatPhaseChangeWallFunctionFvPatchScalarField(), alphatWallBoilingWallFunctionFvPatchScalarField::alphatWallBoilingWallFunctionFvPatchScalarField(), alphatPhaseChangeWallFunctionFvPatchScalarField::dmdt(), alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField::dmdt(), alphatWallBoilingWallFunctionFvPatchScalarField::dmdt(), alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField::write(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::write(), alphatPhaseChangeWallFunctionFvPatchScalarField::write(), and alphatWallBoilingWallFunctionFvPatchScalarField::write().

◆ mDotL_

scalarField mDotL_
protected

Latent heat of the phase-change.

Definition at line 112 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

Referenced by alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField::dmdt(), alphatPhaseChangeWallFunctionFvPatchScalarField::mDotL(), alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField::mDotL(), alphatWallBoilingWallFunctionFvPatchScalarField::mDotL(), alphatWallBoilingWallFunctionFvPatchScalarField::qe(), alphatFixedDmdtWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), alphatWallBoilingWallFunctionFvPatchScalarField::updateCoeffs(), and alphatPhaseChangeWallFunctionFvPatchScalarField::write().

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