src/lagrangian/intermediate/submodels/Kinematic/InjectionModel/KinematicLookupTableInjection/kinematicParcelInjectionData.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::kinematicParcelInjectionData
  27
  28 Description
  29     Container class to provide injection data for kinematic parcels
  30
  31 SourceFiles
  32     kinematicParcelInjectionData.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef kinematicParcelInjectionData_H
  37 #define kinematicParcelInjectionData_H
  38
  39 #include "dictionary.H"
  40 #include "vector.H"
  41 #include "point.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of classes
  49 class kinematicParcelInjectionData;
  50
  51 // Forward declaration of friend functions
  52
  53 Ostream& operator<<
  54 (
  55     Ostream&,
  56     const kinematicParcelInjectionData&
  57 );
  58
  59 Istream& operator>>
  60 (
  61     Istream&,
  62     kinematicParcelInjectionData&
  63 );
  64
  65 /*---------------------------------------------------------------------------*\
  66                Class kinematicParcelInjectionData Declaration
  67 \*---------------------------------------------------------------------------*/
  68
  69 class kinematicParcelInjectionData
  70 {
  71 protected:
  72
  73     // Parcel properties
  74
  75         //- Position [m]
  76         point x_;
  77
  78         //- Velocity [m/s]
  79         vector U_;
  80
  81         //- Diameter [m]
  82         scalar d_;
  83
  84         //- Density [kg/m3]
  85         scalar rho_;
  86
  87         //- Mass flow rate [kg/s]
  88         scalar mDot_;
  89
  90
  91 public:
  92
  93     //- Runtime type information
  94     TypeName("kinematicParcelInjectionData");
  95
  96     // Constructors
  97
  98         //- Null constructor
  99         kinematicParcelInjectionData();
 100
 101         //- Construct from dictionary
 102         kinematicParcelInjectionData(const dictionary& dict);
 103
 104         //- Construct from Istream
 105         kinematicParcelInjectionData(Istream& is);
 106
 107
 108     //-Destructor
 109     virtual ~kinematicParcelInjectionData();
 110
 111
 112     // Access
 113
 114         //- Return const access to the position
 115         inline const point& x() const;
 116
 117         //- Return const access to the velocity
 118         inline const vector& U() const;
 119
 120         //- Return const access to the diameter
 121         inline scalar d() const;
 122
 123         //- Return const access to the density
 124         inline scalar rho() const;
 125
 126         //- Return const access to the mass flow rate
 127         inline scalar mDot() const;
 128
 129
 130     // Edit
 131
 132         //- Return access to the position
 133         inline point& x();
 134
 135         //- Return access to the velocity
 136         inline vector& U();
 137
 138         //- Return access to the diameter
 139         inline scalar& d();
 140
 141         //- Return access to the density
 142         inline scalar& rho();
 143
 144         //- Return access to the mass flow rate
 145         inline scalar& mDot();
 146
 147
 148     // I-O
 149
 150         // Friend Operators
 151
 152             friend bool operator==
 153             (
 154                 const kinematicParcelInjectionData& a,
 155                 const kinematicParcelInjectionData& b
 156             )
 157             {
 158                 notImplemented
 159                 (
 160                     "operator=="
 161                     "("
 162                         "const kinematicParcelInjectionData&, "
 163                         "const kinematicParcelInjectionData&"
 164                     ")"
 165                 );
 166
 167                 return false;
 168             }
 169
 170             friend bool operator!=
 171             (
 172                 const kinematicParcelInjectionData& a,
 173                 const kinematicParcelInjectionData& b
 174             )
 175             {
 176                 notImplemented
 177                 (
 178                     "operator=="
 179                     "("
 180                         "const kinematicParcelInjectionData&, "
 181                         "const kinematicParcelInjectionData&"
 182                     ")"
 183                 );
 184
 185                 return false;
 186             }
 187
 188             //- Ostream operator
 189             friend Ostream& operator<<
 190             (
 191                 Ostream& os,
 192                 const kinematicParcelInjectionData& data
 193             );
 194
 195             //- Istream operator
 196             friend Istream& operator>>
 197             (
 198                 Istream& is,
 199                 kinematicParcelInjectionData& data
 200             );
 201 };
 202
 203
 204 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 205
 206 } // End namespace Foam
 207
 208 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 209
 210 #include "kinematicParcelInjectionDataI.H"
 211
 212 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 213
 214 #endif
 215
 216 // ************************************************************************* //