cloud.C
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) 2011-2024 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 \*---------------------------------------------------------------------------*/
25 
26 #include "cloud.H"
27 #include "Time.H"
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
33 namespace lagrangian
34 {
36 
37  const word cloud::prefix("lagrangian");
38  const word cloud::defaultName("defaultCloud");
39 }
40 }
41 
42 
43 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
44 
46 :
48  (
49  IOobject
50  (
51  cloudName,
52  obr.time().name(),
53  prefix,
54  obr,
55  IOobject::NO_READ,
56  IOobject::AUTO_WRITE
57  )
58  )
59 {}
60 
61 
62 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
63 
65 {}
66 
67 
68 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
69 
71 {
73 }
74 
75 
77 {
79 }
80 
81 
83 {
85 }
86 
87 
88 // ************************************************************************* //
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:99
virtual void topoChange(const polyTopoChangeMap &)
Update topology using the given map.
Definition: cloud.C:70
cloud(const objectRegistry &, const word &cloudName=defaultName)
Construct for the given objectRegistry and named cloud instance.
Definition: cloud.C:45
virtual void distribute(const polyDistributionMap &)
Redistribute or update using the given distribution map.
Definition: cloud.C:82
virtual void mapMesh(const polyMeshMap &)
Update from another mesh using the given map.
Definition: cloud.C:76
static const word defaultName
The default cloud name: defaultCloud.
Definition: cloud.H:72
virtual ~cloud()
Destructor.
Definition: cloud.C:64
static const word prefix
The prefix to local: lagrangian.
Definition: cloud.H:69
Registry of regIOobjects.
Class containing mesh-to-mesh mapping information after a mesh distribution where we send parts of me...
Class containing mesh-to-mesh mapping information.
Definition: polyMeshMap.H:51
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
A class for handling words, derived from string.
Definition: word.H:62
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:381
defineTypeNameAndDebug(cloud, 0)
Namespace for OpenFOAM.
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.
const word cloudName(propsDict.lookup("cloudName"))