Loading...
Searching...
No Matches
alphatPhaseChangeWallFunctionFvPatchScalarField Class Referenceabstract

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

#include <alphatPhaseChangeWallFunctionFvPatchScalarField.H>

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

Public Member Functions

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

Protected Attributes

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

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 ( const fvPatch & p,
const DimensionedField< scalar, volMesh > & iF )

Construct from patch and internal field.

Definition at line 39 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

References dmdt_, mDotL_, p, and Foam::Zero.

Referenced by alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField(), alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField::alphatPhaseChangeJayatillekeWallFunctionFvPatchScalarField(), alphatPhaseChangeWallFunctionFvPatchScalarField(), alphatPhaseChangeWallFunctionFvPatchScalarField(), alphatPhaseChangeWallFunctionFvPatchScalarField(), and TypeName().

Here is the caller graph for this function:

◆ 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 52 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

References dict, dmdt_, mDotL_, and p.

◆ 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 66 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

References alphatPhaseChangeWallFunctionFvPatchScalarField(), dmdt_, mDotL_, and p.

Here is the call graph for this function:

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [4/5]

alphatPhaseChangeWallFunctionFvPatchScalarField ( const alphatPhaseChangeWallFunctionFvPatchScalarField & awfpsf)

Construct as copy.

Definition at line 81 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

References alphatPhaseChangeWallFunctionFvPatchScalarField(), dmdt_, and mDotL_.

Here is the call graph for this function:

◆ alphatPhaseChangeWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 93 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

References alphatPhaseChangeWallFunctionFvPatchScalarField(), dmdt_, and mDotL_.

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "compressible::alphatPhaseChangeWallFunction" )

Runtime type information.

References alphatPhaseChangeWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ dmdt() [1/3]

virtual const scalarField & dmdt ( ) const
inlinevirtual

Return the rate of phase-change.

Reimplemented in alphatWallBoilingWallFunctionFvPatchScalarField.

Definition at line 182 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

References dmdt_.

◆ mDotL() [1/3]

virtual const scalarField & mDotL ( ) const
inlinevirtual

Return the enthalpy source due to phase-change.

Definition at line 190 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

References 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 198 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, and alphatWallBoilingWallFunctionFvPatchScalarField.

Definition at line 206 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

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

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

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

References 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 108 of file alphatPhaseChangeWallFunctionFvPatchScalarField.C.

References dmdt_, mDotL_, os(), fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

Member Data Documentation

◆ dmdt_

scalarField dmdt_
protected

Rate of phase-change.

Definition at line 107 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

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

◆ mDotL_

scalarField mDotL_
protected

Latent heat of the phase-change.

Definition at line 112 of file alphatPhaseChangeWallFunctionFvPatchScalarField.H.

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

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