src/lagrangian/intermediate/clouds/derived/BasicReactingCloud/BasicReactingCloud.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 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 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::BasicReactingCloud
  27
  28 Description
  29     Reacting cloud templated on the type of carrier phase thermodynamics
  30
  31 SourceFiles
  32     BasicReactingCloud.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef BasicReactingCloud_H
  37 #define BasicReactingCloud_H
  38
  39 #include "ReactingCloud.H"
  40 #include "BasicReactingParcel.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48 template<class ThermoType>
  49 class BasicReactingCloud;
  50
  51 /*---------------------------------------------------------------------------*\
  52                         Class BasicReactingCloud Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class ThermoType>
  56 class BasicReactingCloud
  57 :
  58     public ReactingCloud<BasicReactingParcel<ThermoType> >
  59 {
  60     // Private Member Functions
  61
  62         //- Disallow default bitwise copy construct
  63         BasicReactingCloud(const BasicReactingCloud&);
  64
  65         //- Disallow default bitwise assignment
  66         void operator=(const BasicReactingCloud&);
  67
  68
  69 public:
  70
  71     //- Runtime type information
  72     TypeName("BasicReactingCloud");
  73
  74
  75     // Constructors
  76
  77         //- Construct given carrier gas fields
  78         BasicReactingCloud
  79         (
  80             const word& cloudName,
  81             const volScalarField& rho,
  82             const volVectorField& U,
  83             const dimensionedVector& g,
  84             basicThermo& thermo
  85         );
  86
  87
  88     //- Destructor
  89     ~BasicReactingCloud();
  90
  91
  92     // Member Functions
  93
  94         //- Write fields
  95         virtual void writeFields() const;
  96 };
  97
  98
  99 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 100
 101 } // End namespace Foam
 102
 103 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 104
 105 #ifdef NoRepository
 106     #include "BasicReactingCloud.C"
 107 #endif
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //