src/lagrangian/intermediate/submodels/Reacting/InjectionModel/ReactingLookupTableInjection/reactingParcelInjectionData.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::reactingParcelInjectionData
  27
  28 Description
  29     Container class to provide injection data for reacting parcels
  30
  31 SourceFiles
  32     reactingParcelInjectionData.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef reactingParcelInjectionData_H
  37 #define reactingParcelInjectionData_H
  38
  39 #include "thermoParcelInjectionData.H"
  40 #include "scalarList.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of classes
  48 class reactingParcelInjectionData;
  49
  50 // Forward declaration of friend functions
  51
  52 Ostream& operator<<
  53 (
  54     Ostream&,
  55     const reactingParcelInjectionData&
  56 );
  57
  58 Istream& operator>>
  59 (
  60     Istream&,
  61     reactingParcelInjectionData&
  62 );
  63
  64 /*---------------------------------------------------------------------------*\
  65                Class reactingParcelInjectionData Declaration
  66 \*---------------------------------------------------------------------------*/
  67
  68 class reactingParcelInjectionData
  69 :
  70     public thermoParcelInjectionData
  71 {
  72 protected:
  73
  74     // Parcel properties
  75
  76         //- List of mass fractions
  77         scalarList Y_;
  78
  79
  80 public:
  81
  82     //- Runtime type information
  83     TypeName("reactingParcelInjectionData");
  84
  85     // Constructors
  86
  87         //- Null constructor
  88         reactingParcelInjectionData();
  89
  90         //- Construct from dictionary
  91         reactingParcelInjectionData(const dictionary& dict);
  92
  93         //- Construct from Istream
  94         reactingParcelInjectionData(Istream& is);
  95
  96
  97     //-Destructor
  98     virtual ~reactingParcelInjectionData();
  99
 100
 101     // Access
 102
 103         //- Return const access to the list of mass fractions
 104         inline const scalarList& Y() const;
 105
 106
 107     // Edit
 108
 109         //- Return access to the mass fractions
 110         inline scalarList& Y();
 111
 112
 113     // I-O
 114
 115         // Friend Operators
 116
 117             friend bool operator==
 118             (
 119                 const reactingParcelInjectionData& a,
 120                 const reactingParcelInjectionData& b
 121             )
 122             {
 123                 notImplemented
 124                 (
 125                     "operator=="
 126                     "("
 127                         "const reactingParcelInjectionData&, "
 128                         "const reactingParcelInjectionData&"
 129                     ")"
 130                 );
 131
 132                 return false;
 133             }
 134
 135             friend bool operator!=
 136             (
 137                 const reactingParcelInjectionData& a,
 138                 const reactingParcelInjectionData& b
 139             )
 140             {
 141                 notImplemented
 142                 (
 143                     "operator=="
 144                     "("
 145                         "const reactingParcelInjectionData&, "
 146                         "const reactingParcelInjectionData&"
 147                     ")"
 148                 );
 149
 150                 return false;
 151             }
 152
 153             //- Ostream operator
 154             friend Ostream& operator<<
 155             (
 156                 Ostream& os,
 157                 const reactingParcelInjectionData& data
 158             );
 159
 160             //- Istream operator
 161             friend Istream& operator>>
 162             (
 163                 Istream& is,
 164                 reactingParcelInjectionData& data
 165             );
 166 };
 167
 168
 169 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 170
 171 } // End namespace Foam
 172
 173 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 174
 175 #include "reactingParcelInjectionDataI.H"
 176
 177 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 178
 179 #endif
 180
 181 // ************************************************************************* //