src/lagrangian/intermediate/submodels/Thermodynamic/SurfaceFilmModel/ThermoSurfaceFilm/ThermoSurfaceFilm.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::ThermoSurfaceFilm
  26
  27 Description
  28     Thermo parcel surface film model.
  29
  30     Responsible for:
  31     - injecting parcelss from the film model into the cloud, e.g. for dripping
  32     - parcel interaction with the film, e.g absorb, bounce, splash
  33
  34     Splash model references:
  35
  36         Bai and Gosman, `Mathematical modelling of wall films formed by
  37         impinging sprays', SAE 960626, 1996
  38
  39         Bai et al, `Modelling off gasoline spray impingement', Atom. Sprays,
  40         vol 12, pp 1-27, 2002
  41
  42
  43 SourceFiles
  44     ThermoSurfaceFilm.C
  45     ThermoSurfaceFilmI.H
  46
  47 \*---------------------------------------------------------------------------*/
  48
  49 #ifndef ThermoSurfaceFilm_H
  50 #define ThermoSurfaceFilm_H
  51
  52 #include "SurfaceFilmModel.H"
  53
  54 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  55
  56 namespace Foam
  57 {
  58
  59 /*---------------------------------------------------------------------------*\
  60                       Class ThermoSurfaceFilm Declaration
  61 \*---------------------------------------------------------------------------*/
  62
  63 template<class CloudType>
  64 class ThermoSurfaceFilm
  65 :
  66     public SurfaceFilmModel<CloudType>
  67 {
  68 public:
  69
  70     // Public data
  71
  72         //  Interaction type enumerations
  73         enum interactionType
  74         {
  75             itAbsorb,
  76             itBounce,
  77             itSplashBai
  78         };
  79
  80         //- Word descriptions of interaction type names
  81         static wordList interactionTypeNames_;
  82
  83
  84     // Public Member Functions
  85
  86         // Return interaction type enum from word
  87         interactionType interactionTypeEnum(const word& it) const;
  88
  89         // Return word from interaction type enum
  90         word interactionTypeStr(const interactionType& it) const;
  91
  92
  93 protected:
  94
  95     // Protected data
  96
  97         //- Convenience typedef to the cloud's parcel type
  98         typedef typename CloudType::parcelType parcelType;
  99
 100         //- Reference to the cloud random number generator
 101         cachedRandom& rndGen_;
 102
 103         //- Reference to the cloud thermo package
 104         const SLGThermo& thermo_;
 105
 106
 107         // Cached injector fields per film patch
 108
 109             //- Film temperature / patch face
 110             scalarList TFilmPatch_;
 111
 112             //- Film specific heat capacity / patch face
 113             scalarList CpFilmPatch_;
 114
 115
 116         // Interaction model data
 117
 118             //- Interaction type enumeration
 119             interactionType interactionType_;
 120
 121             //- Film thickness beyond which patch is assumed to be wet
 122             scalar deltaWet_;
 123
 124             //- Splash parcel type label - id assigned to identify parcel for
 125             //  post-processing. If not specified, defaults to originating cloud
 126             //  type
 127             label splashParcelType_;
 128
 129             //- Number of new parcels resulting from splash event
 130             label parcelsPerSplash_;
 131
 132
 133             // Surface roughness coefficient typically in the range 1300 - 5200
 134             // and decreases with increasing surface roughness
 135
 136                 //- Dry surface roughness coefficient
 137                 //  = 2630 for dry interaction (ref. Bai)
 138                 scalar Adry_;
 139
 140                 //- Wet surface roughness coefficient
 141                 //  = 1320 for wet interaction (ref. Bai)
 142                 scalar Awet_;
 143
 144
 145             //- Skin friction typically in the range 0.6 < Cf < 0.8
 146             scalar Cf_;
 147
 148             //- Counter for number of new splash parcels
 149             label nParcelsSplashed_;
 150
 151
 152     // Protected Member Functions
 153
 154         //- Return a vector tangential to input vector, v
 155         vector tangentVector(const vector& v) const;
 156
 157         //- Return splashed parcel direction
 158         vector splashDirection
 159         (
 160             const vector& tanVec1,
 161             const vector& tanVec2,
 162             const vector& nf
 163         ) const;
 164
 165
 166         // Interaction models
 167
 168             //- Absorb parcel into film
 169             void absorbInteraction
 170             (
 171                 regionModels::surfaceFilmModels::surfaceFilmModel& filmModel,
 172                 const parcelType& p,
 173                 const polyPatch& pp,
 174                 const label faceI,
 175                 const scalar mass,
 176                 bool& keepParticle
 177             );
 178
 179             //- Bounce parcel (flip parcel normal velocity)
 180             void bounceInteraction
 181             (
 182                 parcelType& p,
 183                 const polyPatch& pp,
 184                 const label faceI,
 185                 bool& keepParticle
 186             ) const;
 187
 188             //- Parcel interaction with dry surface
 189             void drySplashInteraction
 190             (
 191                 regionModels::surfaceFilmModels::surfaceFilmModel& filmModel,
 192                 const parcelType& p,
 193                 const polyPatch& pp,
 194                 const label faceI,
 195                 bool& keepParticle
 196             );
 197
 198             //- Parcel interaction with wetted surface
 199             void wetSplashInteraction
 200             (
 201                 regionModels::surfaceFilmModels::surfaceFilmModel& filmModel,
 202                 parcelType& p,
 203                 const polyPatch& pp,
 204                 const label faceI,
 205                 bool& keepParticle
 206             );
 207
 208             //- Bai parcel splash interaction model
 209             void splashInteraction
 210             (
 211                 regionModels::surfaceFilmModels::surfaceFilmModel& filmModel,
 212                 const parcelType& p,
 213                 const polyPatch& pp,
 214                 const label faceI,
 215                 const scalar mRatio,
 216                 const scalar We,
 217                 const scalar Wec,
 218                 const scalar sigma,
 219                 bool& keepParticle
 220             );
 221
 222
 223         // Injection from sheet (ejection) helper functions
 224
 225             //- Cache the film fields in preparation for injection
 226             virtual void cacheFilmFields
 227             (
 228                 const label filmPatchI,
 229                 const label primaryPatchI,
 230                 const mapDistribute& distMap,
 231                 const regionModels::surfaceFilmModels::surfaceFilmModel&
 232                     filmModel
 233             );
 234
 235             //- Set the individual parcel properties
 236             virtual void setParcelProperties
 237             (
 238                 parcelType& p,
 239                 const label filmFaceI
 240             ) const;
 241
 242
 243 public:
 244
 245     //- Runtime type information
 246     TypeName("thermoSurfaceFilm");
 247
 248
 249     // Constructors
 250
 251         //- Construct from components
 252         ThermoSurfaceFilm
 253         (
 254             const dictionary& dict,
 255             CloudType& owner,
 256             const dimensionedVector& g
 257         );
 258
 259         //- Construct copy
 260         ThermoSurfaceFilm(const ThermoSurfaceFilm<CloudType>& sfm);
 261
 262         //- Construct and return a clone using supplied owner cloud
 263         virtual autoPtr<SurfaceFilmModel<CloudType> > clone()
 264         {
 265             return autoPtr<SurfaceFilmModel<CloudType> >
 266             (
 267                 new ThermoSurfaceFilm<CloudType>(*this)
 268             );
 269         }
 270
 271
 272     //- Destructor
 273     virtual ~ThermoSurfaceFilm();
 274
 275
 276     // Member Functions
 277
 278         // Evaluation
 279
 280             //- Transfer parcel from cloud to surface film
 281             //  Returns true if parcel is to be transferred
 282             virtual bool transferParcel
 283             (
 284                 parcelType& p,
 285                 const polyPatch& pp,
 286                 bool& keepParticle
 287             );
 288
 289
 290         // I-O
 291
 292             //- Write surface film info to stream
 293             virtual void info(Ostream& os) const;
 294 };
 295
 296
 297 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 298
 299 } // End namespace Foam
 300
 301 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 302
 303 #ifdef NoRepository
 304 #   include "ThermoSurfaceFilm.C"
 305 #endif
 306
 307 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 308
 309 #endif
 310
 311 // ************************************************************************* //