ParcelCloud.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2020 OpenFOAM Foundation
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::ParcelCloud
26 
27 Description
28  Outermost template for parcel clouds. Adds the parcelCloud virtualisation
29  layer and forwards the methods required by that layer.
30 
31 \*---------------------------------------------------------------------------*/
32 
33 #ifndef ParcelCloud_H
34 #define ParcelCloud_H
35 
36 #include "parcelCloud.H"
37 
38 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
39 
40 namespace Foam
41 {
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 template<class CloudType>
46 class ParcelCloud
47 :
48  public CloudType,
49  virtual public parcelCloud
50 {
51 public:
52 
53  // Constructors
54 
55  //- Inherit base constructors
57 
58 
59  // Member Functions
60 
61  //- Call this before a topology change. Stores the particles global
62  // positions in the database for use during mapping.
63  virtual void storeGlobalPositions()
64  {
66  }
67 
68 
69  // Evolution
70 
71  //- Evolve the cloud
72  virtual void evolve()
73  {
75  }
76 };
77 
78 
79 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
80 
81 } // End namespace Foam
82 
83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
84 
85 #endif
86 
87 // ************************************************************************* //
Virtual abstract base class for parcel clouds. As parcelCloudBase but with additional virtualisation ...
Definition: parcelCloud.H:54
virtual void evolve()
Evolve the cloud.
Definition: ParcelCloud.H:71
DSMCCloud< dsmcParcel > CloudType
void storeGlobalPositions() const
Call this before a topology change. Stores the particles global.
Definition: Cloud.C:461
Outermost template for parcel clouds. Adds the parcelCloud virtualisation layer and forwards the meth...
Definition: ParcelCloud.H:45
virtual void storeGlobalPositions()
Call this before a topology change. Stores the particles global.
Definition: ParcelCloud.H:62
void evolve()
Evolve the cloud (move, collide)
Definition: DSMCCloud.C:940
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:75
Namespace for OpenFOAM.