alphatPhaseChangeWallFunctionFvPatchScalarField.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2015-2018 OpenFOAM Foundation
    Copyright (C) 2021 OpenCFD Ltd.
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::compressible::alphatPhaseChangeWallFunctionFvPatchScalarField
 
Description
    Abstract base-class for all alphatWallFunctions supporting phase-change.
 
Usage
    Example of the boundary condition specification:
    \verbatim
    <patchName>
    {
        // Optional entries
        dmdt        <scalarField>;
        mDotL       <scalarField>;
 
        // Inherited entries
        ...
    }
    \endverbatim
 
    where the entries mean:
    \table
      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
    \endtable
 
    The inherited entries are elaborated in:
      - \link fixedValueFvPatchFields.H \endlink
 
See also
  - Foam::fixedValueFvPatchScalarField
  - Foam::alphatWallFunctionFvPatchScalarField
 
SourceFiles
    alphatPhaseChangeWallFunctionFvPatchScalarField.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef alphatPhaseChangeWallFunctionFvPatchScalarField_H
#define alphatPhaseChangeWallFunctionFvPatchScalarField_H
 
#include "fixedValueFvPatchFields.H"
#include "phasePairKey.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace compressible
{
 
/*---------------------------------------------------------------------------*\
       Class alphatPhaseChangeWallFunctionFvPatchScalarField Declaration
\*---------------------------------------------------------------------------*/
 
class alphatPhaseChangeWallFunctionFvPatchScalarField
:
    public fixedValueFvPatchScalarField
{
protected:
 
    // Protected Data
 
        //- Rate of phase-change
        scalarField dmdt_;
 
        //- Latent heat of the phase-change
        scalarField mDotL_;
 
 
public:
 
    //- Runtime type information
    TypeName("compressible::alphatPhaseChangeWallFunction");
 
 
    // Constructors
 
        //- Construct from patch and internal field
        alphatPhaseChangeWallFunctionFvPatchScalarField
        (
            const fvPatch&,
            const DimensionedField<scalar, volMesh>&
        );
 
        //- Construct from patch, internal field and dictionary
        alphatPhaseChangeWallFunctionFvPatchScalarField
        (
            const fvPatch&,
            const DimensionedField<scalar, volMesh>&,
            const dictionary&
        );
 
        //- Construct by mapping given
        //- alphatPhaseChangeWallFunctionFvPatchScalarField
        //- onto a new patch
        alphatPhaseChangeWallFunctionFvPatchScalarField
        (
            const alphatPhaseChangeWallFunctionFvPatchScalarField&,
            const fvPatch&,
            const DimensionedField<scalar, volMesh>&,
            const fvPatchFieldMapper&
        );
 
        //- Construct as copy
        alphatPhaseChangeWallFunctionFvPatchScalarField
        (
            const alphatPhaseChangeWallFunctionFvPatchScalarField&
        );
 
        //- Construct as copy setting internal field reference
        alphatPhaseChangeWallFunctionFvPatchScalarField
        (
            const alphatPhaseChangeWallFunctionFvPatchScalarField&,
            const DimensionedField<scalar, volMesh>&
        );
 
        // No clone methods - abstract class
 
 
    // Member Functions
 
        //- Return the rate of phase-change
        virtual const scalarField& dmdt() const
        {
            return dmdt_;
        }
 
        //- Return the enthalpy source due to phase-change
        virtual const scalarField& mDotL() const
        {
            return mDotL_;
        }
 
        //- Is there phase change mass transfer for this phasePair
        virtual bool activePhasePair(const phasePairKey&) const
        {
            return false;
        }
 
        //- Return the rate of phase-change for specific phase pair
        virtual const scalarField& dmdt(const phasePairKey&) const
        {
            return dmdt_;
        }
 
        //- Return the rate of phase-change for specific phase pair
        virtual const scalarField& mDotL(const phasePairKey&) const
        {
            return mDotL_;
        }
 
        //- Return the rate of phase-change for specific phase
        virtual scalarField dmdt(const word&) const
        {
            return dmdt_;
        }
 
        //- Return the enthalpy source due to phase-change for specific phase
        virtual scalarField mDotL(const word&) const
        {
            return mDotL_;
        }
 
 
        // Evaluation
 
            //- Update the coefficients associated with the patch field
            virtual void updateCoeffs() = 0;
 
 
        // I-O
 
            //- Write
            virtual void write(Ostream&) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace compressible
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //