FreeFOAM The Cross-Platform CFD Toolkit
BasicReactingParcel.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
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::BasicReactingParcel
26 
27 Description
28 
29 
30 SourceFiles
31  BasicReactingParcel.C
32  BasicReactingParcelIO.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef BasicReactingParcel_H
37 #define BasicReactingParcel_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // Forward declaration of classes
47 template<class ThermoType>
48 class BasicReactingParcel;
49 
50 /*---------------------------------------------------------------------------*\
51  Class BasicReactingParcel Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class ThermoType>
56 :
57  public ReactingParcel<BasicReactingParcel<ThermoType> >
58 {
59 
60 public:
61 
62  //- The type of thermodynamics this parcel was instantiated for
64 
65  //- Run-time type information
66  TypeName("BasicReactingParcel");
67 
68  // Constructors
69 
70  //- Construct from owner, position, and cloud owner
71  // Other properties initialised as null
73  (
75  const vector& position,
76  const label cellI
77  );
78 
79  //- Construct from components
81  (
83  const vector& position,
84  const label cellI,
85  const label typeId,
86  const scalar nParticle0,
87  const scalar d0,
88  const vector& U0,
89  const scalarField& Y0,
91  constantProperties& constProps
92  );
93 
94  //- Construct from Istream
96  (
98  Istream& is,
99  bool readFields = true
100  );
101 
102  //- Construct as a copy
104 
105  //- Construct and return a clone
107  {
108  return
110  (
111  new BasicReactingParcel(*this)
112  );
113  }
114 
115 
116  //- Destructor
117  virtual ~BasicReactingParcel();
118 };
119 
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 } // End namespace Foam
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #ifdef NoRepository
128  #include "BasicReactingParcel.C"
129 #endif
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************ vim: set sw=4 sts=4 et: ************************ //