FreeFOAM The Cross-Platform CFD Toolkit
basicKinematicParcel.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::basicKinematicParcel
26 
27 Description
28 
29 
30 SourceFiles
31  basicKinematicParcel.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef basicKinematicParcel_H
36 #define basicKinematicParcel_H
37 
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class basicKinematicParcel Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  public KinematicParcel<basicKinematicParcel>
52 {
53 
54 public:
55 
56  //- Run-time type information
57  TypeName("basicKinematicParcel");
58 
59 
60  // Constructors
61 
62  //- Construct from owner, position, and cloud owner
63  // Other properties initialised as null
65  (
67  const vector& position,
68  const label cellI
69  );
70 
71  //- Construct from components
73  (
75  const vector& position,
76  const label cellI,
77  const label typeId,
78  const scalar nParticle0,
79  const scalar d0,
80  const vector& U0,
81  const constantProperties& constProps
82  );
83 
84  //- Construct from Istream
86  (
88  Istream& is,
89  bool readFields = true
90  );
91 
92  //- Construct as a copy
94 
95  //- Construct and return a clone
97  {
98  return
100  (
101  new basicKinematicParcel(*this)
102  );
103  }
104 
105 
106  //- Destructor
107  virtual ~basicKinematicParcel();
108 };
109 
110 
111 template<>
113 {
114  return true;
115 }
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #endif
125 
126 // ************************ vim: set sw=4 sts=4 et: ************************ //