FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

BasicReactingParcel.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2010 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software: you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::BasicReactingParcel
00026 
00027 Description
00028 
00029 
00030 SourceFiles
00031     BasicReactingParcel.C
00032     BasicReactingParcelIO.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef BasicReactingParcel_H
00037 #define BasicReactingParcel_H
00038 
00039 #include <lagrangianIntermediate/ReactingParcel_.H>
00040 
00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00042 
00043 namespace Foam
00044 {
00045 
00046 // Forward declaration of classes
00047 template<class ThermoType>
00048 class BasicReactingParcel;
00049 
00050 /*---------------------------------------------------------------------------*\
00051                     Class BasicReactingParcel Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 template<class ThermoType>
00055 class BasicReactingParcel
00056 :
00057     public ReactingParcel<BasicReactingParcel<ThermoType> >
00058 {
00059 
00060 public:
00061 
00062     //- The type of thermodynamics this parcel was instantiated for
00063     typedef ThermoType thermoType;
00064 
00065     //- Run-time type information
00066     TypeName("BasicReactingParcel");
00067 
00068     // Constructors
00069 
00070         //- Construct from owner, position, and cloud owner
00071         //  Other properties initialised as null
00072         BasicReactingParcel
00073         (
00074             ReactingCloud<BasicReactingParcel>& owner,
00075             const vector& position,
00076             const label cellI
00077         );
00078 
00079         //- Construct from components
00080         BasicReactingParcel
00081         (
00082             ReactingCloud<BasicReactingParcel>& owner,
00083             const vector& position,
00084             const label cellI,
00085             const label typeId,
00086             const scalar nParticle0,
00087             const scalar d0,
00088             const vector& U0,
00089             const scalarField& Y0,
00090             const typename ReactingParcel<BasicReactingParcel>::
00091                 constantProperties& constProps
00092         );
00093 
00094         //- Construct from Istream
00095         BasicReactingParcel
00096         (
00097             const Cloud<BasicReactingParcel>& c,
00098             Istream& is,
00099             bool readFields = true
00100         );
00101 
00102         //- Construct as a copy
00103         BasicReactingParcel(const BasicReactingParcel& p);
00104 
00105         //- Construct and return a clone
00106         autoPtr<BasicReactingParcel> clone() const
00107         {
00108             return
00109                 autoPtr<BasicReactingParcel>
00110                 (
00111                     new BasicReactingParcel(*this)
00112                 );
00113         }
00114 
00115 
00116     //- Destructor
00117     virtual ~BasicReactingParcel();
00118 };
00119 
00120 
00121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00122 
00123 } // End namespace Foam
00124 
00125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00126 
00127 #ifdef NoRepository
00128     #include "BasicReactingParcel.C"
00129 #endif
00130 
00131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00132 
00133 #endif
00134 
00135 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines