src/regionModels/surfaceFilmModels/noFilm/noFilm.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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::noFilm
  26
  27 Description
  28     Dummy surface film model for 'none'
  29
  30 SourceFiles
  31     noFilm.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef noFilm_H
  36 #define noFilm_H
  37
  38 #include "surfaceFilmModel.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44 namespace regionModels
  45 {
  46 namespace surfaceFilmModels
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                           Class noFilm Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class noFilm
  54 :
  55     public surfaceFilmModel
  56 {
  57 private:
  58
  59     // Private member functions
  60
  61         //- Disallow default bitwise copy construct
  62         noFilm(const noFilm&);
  63
  64         //- Disallow default bitwise assignment
  65         void operator=(const noFilm&);
  66
  67
  68 protected:
  69
  70     // Protected member functions
  71
  72         //- Read control parameters from dictionary
  73         virtual bool read();
  74
  75
  76 public:
  77
  78     //- Runtime type information
  79     TypeName("none");
  80
  81
  82     // Constructors
  83
  84         //- Construct from components
  85         noFilm
  86         (
  87             const word& modelType,
  88             const fvMesh& mesh,
  89             const dimensionedVector& g
  90         );
  91
  92
  93     //- Destructor
  94     virtual ~noFilm();
  95
  96
  97     // Member Functions
  98
  99         // Access
 100
 101             //- External hook to add sources to the film
 102             virtual void addSources
 103             (
 104                 const label patchI,
 105                 const label faceI,
 106                 const scalar massSource,
 107                 const vector& momentumSource,
 108                 const scalar pressureSource,
 109                 const scalar energySource
 110             );
 111
 112
 113         // Fields
 114
 115             //- Return the film thickness [m]
 116             virtual const volScalarField& delta() const;
 117
 118             //- Return const access to the surface tension / [m/s2]
 119             inline const volScalarField& sigma() const;
 120
 121             //- Return the film velocity [m/s]
 122             virtual const volVectorField& U() const;
 123
 124             //- Return the film density [kg/m3]
 125             virtual const volScalarField& rho() const;
 126
 127             //- Return the film surface velocity [m/s]
 128             virtual const volVectorField& Us() const;
 129
 130             //- Return the film wall velocity [m/s]
 131             virtual const volVectorField& Uw() const;
 132
 133             //- Return the film mean temperature [K]
 134             virtual const volScalarField& T() const;
 135
 136             //- Return the film surface temperature [K]
 137             virtual const volScalarField& Ts() const;
 138
 139             //- Return the film wall temperature [K]
 140             virtual const volScalarField& Tw() const;
 141
 142             //- Return the film specific heat capacity [J/kg/K]
 143             virtual const volScalarField& Cp() const;
 144
 145             //- Return the film thermal conductivity [W/m/K]
 146             virtual const volScalarField& kappa() const;
 147
 148
 149             // Transfer fields - to the primary region
 150
 151                 //- Return mass transfer source - Eulerian phase only
 152                 virtual tmp<volScalarField> primaryMassTrans() const;
 153
 154                 //- Return the film mass available for transfer
 155                 virtual const volScalarField& cloudMassTrans() const;
 156
 157                 //- Return the parcel diameters originating from film
 158                 virtual const volScalarField& cloudDiameterTrans() const;
 159
 160
 161         // Source fields
 162
 163             // Mapped into primary region
 164
 165                 //- Return total mass source - Eulerian phase only
 166                 virtual tmp<DimensionedField<scalar, volMesh> > Srho() const;
 167
 168                 //- Return mass source for specie i - Eulerian phase only
 169                 virtual tmp<DimensionedField<scalar, volMesh> > Srho
 170                 (
 171                     const label i
 172                 ) const;
 173
 174                 //- Return enthalpy source - Eulerian phase only
 175                 virtual tmp<DimensionedField<scalar, volMesh> > Sh() const;
 176 };
 177
 178
 179 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 180
 181 } // End namespace surfaceFilmModels
 182 } // regionModels
 183 } // End namespace Foam
 184
 185 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 186
 187 #endif
 188
 189 // ************************************************************************* //