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:
Inheritance graph
[legend]
Collaboration diagram for alphatPhaseChangeWallFunctionFvPatchScalarField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("compressible::alphatPhaseChangeWallFunction")
 
 alphatPhaseChangeWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 
 alphatPhaseChangeWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 
 alphatPhaseChangeWallFunctionFvPatchScalarField (const alphatPhaseChangeWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 alphatPhaseChangeWallFunctionFvPatchScalarField (const alphatPhaseChangeWallFunctionFvPatchScalarField &)
 
 alphatPhaseChangeWallFunctionFvPatchScalarField (const alphatPhaseChangeWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 
virtual const scalarFielddmdt () const
 
virtual const scalarFieldmDotL () const
 
virtual bool activePhasePair (const phasePairKey &) const
 
virtual const scalarFielddmdt (const phasePairKey &) const
 
virtual const scalarFieldmDotL (const phasePairKey &) const
 
virtual scalarField dmdt (const word &) const
 
virtual scalarField mDotL (const word &) const
 
virtual void updateCoeffs ()=0
 
virtual void write (Ostream &) const
 

Protected Attributes

scalarField dmdt_
 
scalarField mDotL_
 

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 96 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [1/5]

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [2/5]

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

Definition at line 54 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

References dict, and p.

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [3/5]

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [4/5]

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

TypeName ( "compressible::alphatPhaseChangeWallFunction"  )

◆ dmdt() [1/3]

virtual const scalarField& dmdt ( ) const
inlinevirtual

◆ mDotL() [1/3]

virtual const scalarField& mDotL ( ) const
inlinevirtual

◆ activePhasePair()

virtual bool activePhasePair ( const phasePairKey ) const
inlinevirtual

◆ dmdt() [2/3]

virtual const scalarField& dmdt ( const phasePairKey ) const
inlinevirtual

◆ mDotL() [2/3]

virtual const scalarField& mDotL ( const phasePairKey ) const
inlinevirtual

◆ dmdt() [3/3]

virtual scalarField dmdt ( const word ) const
inlinevirtual

◆ mDotL() [3/3]

virtual scalarField mDotL ( const word ) const
inlinevirtual

◆ updateCoeffs()

virtual void updateCoeffs ( )
pure virtual

◆ write()

void write ( Ostream os) const
virtual

Member Data Documentation

◆ dmdt_

scalarField dmdt_
protected

◆ mDotL_

scalarField mDotL_
protected

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