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