src/regionModels/surfaceFilmModels/submodels/thermo/phaseChangeModel/phaseChangeModel/phaseChangeModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-2011 OpenCFD Ltd.
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::phaseChangeModel
  26
  27 Description
  28     Base class for surface film phase change models
  29
  30 SourceFiles
  31     phaseChangeModel.C
  32     phaseChangeModelNew.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef phaseChangeModel_H
  37 #define phaseChangeModel_H
  38
  39 #include "subModelBase.H"
  40 #include "runTimeSelectionTables.H"
  41 #include "scalarField.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47 namespace regionModels
  48 {
  49 namespace surfaceFilmModels
  50 {
  51
  52 /*---------------------------------------------------------------------------*\
  53                       Class phaseChangeModel Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class phaseChangeModel
  57 :
  58     public subModelBase
  59 {
  60 private:
  61
  62     // Private Member Functions
  63
  64         //- Disallow default bitwise copy construct
  65         phaseChangeModel(const phaseChangeModel&);
  66
  67         //- Disallow default bitwise assignment
  68         void operator=(const phaseChangeModel&);
  69
  70
  71 protected:
  72
  73     // Protected Member Functions
  74
  75         //- Latest mass transfer due to phase change
  76         scalar latestMassPC_;
  77
  78         //- Total mass transfer due to phase change
  79         scalar totalMassPC_;
  80
  81
  82 public:
  83
  84     //- Runtime type information
  85     TypeName("phaseChangeModel");
  86
  87
  88     // Declare runtime constructor selection table
  89
  90          declareRunTimeSelectionTable
  91          (
  92              autoPtr,
  93              phaseChangeModel,
  94              dictionary,
  95              (
  96                 const surfaceFilmModel& owner,
  97                 const dictionary& dict
  98              ),
  99              (owner, dict)
 100          );
 101
 102     // Constructors
 103
 104         //- Construct null
 105         phaseChangeModel(const surfaceFilmModel& owner);
 106
 107         //- Construct from type name, dictionary and surface film model
 108         phaseChangeModel
 109         (
 110             const word& type,
 111             const surfaceFilmModel& owner,
 112             const dictionary& dict
 113         );
 114
 115
 116     // Selectors
 117
 118         //- Return a reference to the selected phase change model
 119         static autoPtr<phaseChangeModel> New
 120         (
 121             const surfaceFilmModel& owner,
 122             const dictionary& dict
 123         );
 124
 125
 126     //- Destructor
 127     virtual ~phaseChangeModel();
 128
 129
 130     // Member Functions
 131
 132         // Evolution
 133
 134             //- Correct
 135             virtual void correct
 136             (
 137                 const scalar dt,
 138                 scalarField& availableMass,
 139                 volScalarField& dMass,
 140                 volScalarField& dEnergy
 141             );
 142
 143             //- Correct
 144             virtual void correctModel
 145             (
 146                 const scalar dt,
 147                 scalarField& availableMass,
 148                 scalarField& dMass,
 149                 scalarField& dEnergy
 150             ) = 0;
 151
 152
 153         // I-O
 154
 155             //- Provide some feedback
 156             virtual void info(Ostream& os) const;
 157 };
 158
 159
 160 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 161
 162 } // End namespace surfaceFilmModels
 163 } // End namespace regionModels
 164 } // End namespace Foam
 165
 166 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 167
 168 #endif
 169
 170 // ************************************************************************* //