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

basicKinematicParcel.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::basicKinematicParcel
00026 
00027 Description
00028 
00029 
00030 SourceFiles
00031     basicKinematicParcel.C
00032 
00033 \*---------------------------------------------------------------------------*/
00034 
00035 #ifndef basicKinematicParcel_H
00036 #define basicKinematicParcel_H
00037 
00038 #include <lagrangianIntermediate/KinematicParcel.H>
00039 
00040 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00041 
00042 namespace Foam
00043 {
00044 
00045 /*---------------------------------------------------------------------------*\
00046                    Class basicKinematicParcel Declaration
00047 \*---------------------------------------------------------------------------*/
00048 
00049 class basicKinematicParcel
00050 :
00051     public KinematicParcel<basicKinematicParcel>
00052 {
00053 
00054 public:
00055 
00056     //- Run-time type information
00057     TypeName("basicKinematicParcel");
00058 
00059 
00060     // Constructors
00061 
00062         //- Construct from owner, position, and cloud owner
00063         //  Other properties initialised as null
00064         basicKinematicParcel
00065         (
00066             KinematicCloud<basicKinematicParcel>& owner,
00067             const vector& position,
00068             const label cellI
00069         );
00070 
00071         //- Construct from components
00072         basicKinematicParcel
00073         (
00074             KinematicCloud<basicKinematicParcel>& owner,
00075             const vector& position,
00076             const label cellI,
00077             const label typeId,
00078             const scalar nParticle0,
00079             const scalar d0,
00080             const vector& U0,
00081             const constantProperties& constProps
00082         );
00083 
00084         //- Construct from Istream
00085         basicKinematicParcel
00086         (
00087             const Cloud<basicKinematicParcel>& c,
00088             Istream& is,
00089             bool readFields = true
00090         );
00091 
00092         //- Construct as a copy
00093         basicKinematicParcel(const basicKinematicParcel& p);
00094 
00095         //- Construct and return a clone
00096         autoPtr<basicKinematicParcel> clone() const
00097         {
00098             return
00099                 autoPtr<basicKinematicParcel>
00100                 (
00101                     new basicKinematicParcel(*this)
00102                 );
00103         }
00104 
00105 
00106     //- Destructor
00107     virtual ~basicKinematicParcel();
00108 };
00109 
00110 
00111 template<>
00112 inline bool contiguous<basicKinematicParcel>()
00113 {
00114     return true;
00115 }
00116 
00117 
00118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00119 
00120 } // End namespace Foam
00121 
00122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00123 
00124 #endif
00125 
00126 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines