src/lagrangian/intermediate/clouds/Templates/ReactingCloud/ReactingCloud.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::ReactingCloud
  27
  28 Description
  29     Templated base class for reacting cloud
  30
  31     - Adds to thermodynamic cloud
  32       - Variable composition (single phase)
  33       - Phase change
  34
  35 SourceFiles
  36     ReactingCloudI.H
  37     ReactingCloud.C
  38
  39 \*---------------------------------------------------------------------------*/
  40
  41 #ifndef ReactingCloud_H
  42 #define ReactingCloud_H
  43
  44 #include "ThermoCloud.H"
  45 #include "reactingCloud.H"
  46 #include "multiComponentMixture.H"
  47
  48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  49
  50 namespace Foam
  51 {
  52
  53 // Forward declaration of classes
  54
  55 template<class CloudType>
  56 class CompositionModel;
  57
  58 template<class CloudType>
  59 class PhaseChangeModel;
  60
  61 /*---------------------------------------------------------------------------*\
  62                       Class ReactingCloud Declaration
  63 \*---------------------------------------------------------------------------*/
  64
  65 template<class ParcelType>
  66 class ReactingCloud
  67 :
  68     public ThermoCloud<ParcelType>,
  69     public reactingCloud
  70 {
  71 public:
  72
  73     //- Type of thermodynamics the cloud was instantiated for
  74     typedef typename ParcelType::thermoType thermoType;
  75
  76
  77 private:
  78
  79     // Private Member Functions
  80
  81         //- Disallow default bitwise copy construct
  82         ReactingCloud(const ReactingCloud&);
  83
  84         //- Disallow default bitwise assignment
  85         void operator=(const ReactingCloud&);
  86
  87
  88 protected:
  89
  90     // Protected data
  91
  92         //- Parcel constant properties
  93         typename ParcelType::constantProperties constProps_;
  94
  95         //- Multi-component carrier phase thermo
  96         multiComponentMixture<thermoType>& mcCarrierThermo_;
  97
  98
  99         // References to the cloud sub-models
 100
 101             //- Reacting composition model
 102             autoPtr<CompositionModel<ReactingCloud<ParcelType> > >
 103                 compositionModel_;
 104
 105             //- Reacting phase change model
 106             autoPtr<PhaseChangeModel<ReactingCloud<ParcelType> > >
 107                 phaseChangeModel_;
 108
 109
 110         // Sources
 111
 112             //- Mass transfer fields - one per carrier phase specie
 113             PtrList<DimensionedField<scalar, volMesh> > rhoTrans_;
 114
 115
 116         // Check
 117
 118             //- Total mass transferred to continuous phase via phase change
 119             scalar dMassPhaseChange_;
 120
 121
 122     // Protected Member Functions
 123
 124         // New parcel helper functions
 125
 126             //- Check that size of a composition field is valid
 127             void checkSuppliedComposition
 128             (
 129                 const scalarField& YSupplied,
 130                 const scalarField& Y,
 131                 const word& YName
 132             );
 133
 134
 135         // Cloud evolution functions
 136
 137             //- Pre-evolve
 138             void preEvolve();
 139
 140             //- Evolve the cloud
 141             void evolveCloud();
 142
 143             //- Post-evolve
 144             void postEvolve();
 145
 146
 147 public:
 148
 149     // Constructors
 150
 151         //- Construct given carrier gas fields
 152         ReactingCloud
 153         (
 154             const word& cloudName,
 155             const volScalarField& rho,
 156             const volVectorField& U,
 157             const dimensionedVector& g,
 158             basicThermo& thermo,
 159             bool readFields = true
 160         );
 161
 162
 163     //- Destructor
 164     virtual ~ReactingCloud();
 165
 166
 167     //- Type of parcel the cloud was instantiated for
 168     typedef ParcelType parcelType;
 169
 170
 171     // Member Functions
 172
 173         // Access
 174
 175             //- Return the constant properties
 176             inline const typename ParcelType::constantProperties&
 177                 constProps() const;
 178
 179             //- Return const access to multi-component carrier phase thermo
 180             inline const multiComponentMixture<thermoType>&
 181                 mcCarrierThermo() const;
 182
 183             //- Return access to multi-component carrier phase thermo
 184             inline multiComponentMixture<thermoType>& mcCarrierThermo();
 185
 186
 187             // Sub-models
 188
 189                 //- Return reference to reacting composition model
 190                 inline const CompositionModel<ReactingCloud<ParcelType> >&
 191                     composition() const;
 192
 193                 //- Return reference to reacting phase change model
 194                 inline const PhaseChangeModel<ReactingCloud<ParcelType> >&
 195                     phaseChange() const;
 196
 197
 198             // Sources
 199
 200                 //- Mass
 201
 202                     //- Return reference to mass source for field i
 203                     inline DimensionedField<scalar, volMesh>&
 204                         rhoTrans(const label i);
 205
 206                     //- Return reference to mass source fields
 207                     inline PtrList<DimensionedField<scalar, volMesh> >&
 208                         rhoTrans();
 209
 210                     //- Return tmp mass source for field i - fully explicit
 211                     inline tmp<DimensionedField<scalar, volMesh> >
 212                         Srho(const label i) const;
 213
 214                     //- Return tmp total mass source for carrier phase
 215                     //  - fully explicit
 216                     inline tmp<DimensionedField<scalar, volMesh> > Srho() const;
 217
 218
 219         // Check
 220
 221             //- Print cloud information
 222             void info() const;
 223
 224             //- Add to cumulative phase change mass transfer
 225             void addToMassPhaseChange(const scalar dMass);
 226
 227
 228         // Cloud evolution functions
 229
 230             //- Check parcel properties
 231             void checkParcelProperties
 232             (
 233                 ParcelType& parcel,
 234                 const scalar lagrangianDt,
 235                 const bool fullyDescribed
 236             );
 237
 238             //- Reset the spray source terms
 239             void resetSourceTerms();
 240
 241             //- Evolve the spray (inject, move)
 242             void evolve();
 243 };
 244
 245
 246 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 247
 248 } // End namespace Foam
 249
 250 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 251
 252 #include "ReactingCloudI.H"
 253
 254 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 255
 256 #ifdef NoRepository
 257 #   include "ReactingCloud.C"
 258 #endif
 259
 260 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 261
 262 #endif
 263
 264 // ************************************************************************* //