FreeFOAM The Cross-Platform CFD Toolkit
CoalParcel.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) 2008-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  CoalParcel
26 
27 Description
28 
29 
30 SourceFiles
31  CoalParcel.C
32  CoalParcelIO.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef CoalParcel_H
37 #define CoalParcel_H
38 
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 // Forward declaration of classes
47 template<class ThermoType>
48 class CoalParcel;
49 
50 /*---------------------------------------------------------------------------*\
51  Class CoalParcel Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class ThermoType>
56 :
57  public ReactingMultiphaseParcel<CoalParcel<ThermoType> >
58 {
59 public:
60 
61  //- The type of thermodynamics this parcel was instantiated for
63 
64  // Run-time type information
65  TypeName("CoalParcel");
66 
67  // Constructors
68 
69  //- Construct from owner, position, and cloud owner
70  // Other properties initialised as null
72  (
74  const vector& position,
75  const label cellI
76  );
77 
78  //- Construct from components
80  (
82  const vector& position,
83  const label cellI,
84  const label typeId,
85  const scalar nParticle0,
86  const scalar d0,
87  const vector& U0,
88  const scalarField& YMixture0,
89  const scalarField& YGas0,
90  const scalarField& YLiquid0,
91  const scalarField& YSolid0,
92  const typename
94  constantProperties& constProps
95  );
96 
97  //- Construct from Istream
99  (
100  const Cloud<CoalParcel>& c,
101  Istream& is,
102  bool readFields = true
103  );
104 
105  //- Construct and return a clone
107  {
108  return autoPtr<CoalParcel>(new CoalParcel(*this));
109  }
110 
111 
112  //- Destructor
113  virtual ~CoalParcel();
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #ifdef NoRepository
124  #include "CoalParcel.C"
125 #endif
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #endif
130 
131 // ************************ vim: set sw=4 sts=4 et: ************************ //