OpenFOAM
dev
The OpenFOAM Foundation
cloud.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) 2011-2022 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::cloud
26
27
Description
28
A cloud is a collection of lagrangian particles
29
30
SourceFiles
31
cloud.C
32
33
\*---------------------------------------------------------------------------*/
34
35
#ifndef cloud_H
36
#define cloud_H
37
38
#include "
objectRegistry.H
"
39
40
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41
42
namespace
Foam
43
{
44
45
class
polyTopoChangeMap;
46
class
polyMeshMap;
47
class
polyDistributionMap;
48
49
/*---------------------------------------------------------------------------*\
50
Class cloud Declaration
51
\*---------------------------------------------------------------------------*/
52
53
class
cloud
54
:
55
public
objectRegistry
56
{
57
58
public
:
59
60
//- Runtime type information
61
TypeName
(
"cloud"
);
62
63
//- The prefix to local: %lagrangian
64
static
const
word
prefix
;
65
66
//- The default cloud name: %defaultCloud
67
static
word
defaultName
;
68
69
70
// Constructors
71
72
//- Construct for the given objectRegistry and named cloud instance
73
cloud
(
const
objectRegistry
&,
const
word
&
cloudName
=
defaultName
);
74
75
//- Disallow default bitwise copy construction
76
cloud
(
const
cloud
&) =
delete
;
77
78
79
//- Destructor
80
virtual
~cloud
();
81
82
83
// Member Functions
84
85
//- Update topology using the given map
86
virtual
void
topoChange
(
const
polyTopoChangeMap
&);
87
88
//- Update from another mesh using the given map
89
virtual
void
mapMesh
(
const
polyMeshMap
&);
90
91
//- Redistribute or update using the given distribution map
92
virtual
void
distribute
(
const
polyDistributionMap
&);
93
94
95
// Member Operators
96
97
//- Disallow default bitwise assignment
98
void
operator=
(
const
cloud
&) =
delete
;
99
};
100
101
102
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103
104
}
// End namespace Foam
105
106
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
107
108
#endif
109
110
// ************************************************************************* //
Foam::cloud
A cloud is a collection of lagrangian particles.
Definition:
cloud.H:55
Foam::cloud::topoChange
virtual void topoChange(const polyTopoChangeMap &)
Update topology using the given map.
Definition:
cloud.C:67
Foam::cloud::defaultName
static word defaultName
The default cloud name: defaultCloud.
Definition:
cloud.H:66
Foam::cloud::cloud
cloud(const objectRegistry &, const word &cloudName=defaultName)
Construct for the given objectRegistry and named cloud instance.
Definition:
cloud.C:42
Foam::cloud::distribute
virtual void distribute(const polyDistributionMap &)
Redistribute or update using the given distribution map.
Definition:
cloud.C:79
Foam::cloud::TypeName
TypeName("cloud")
Runtime type information.
Foam::cloud::mapMesh
virtual void mapMesh(const polyMeshMap &)
Update from another mesh using the given map.
Definition:
cloud.C:73
Foam::cloud::operator=
void operator=(const cloud &)=delete
Disallow default bitwise assignment.
Foam::cloud::~cloud
virtual ~cloud()
Destructor.
Definition:
cloud.C:61
Foam::cloud::prefix
static const word prefix
The prefix to local: lagrangian.
Definition:
cloud.H:63
Foam::objectRegistry
Registry of regIOobjects.
Definition:
objectRegistry.H:56
Foam::polyDistributionMap
Class containing mesh-to-mesh mapping information after a mesh distribution where we send parts of me...
Definition:
polyDistributionMap.H:65
Foam::polyMeshMap
Class containing mesh-to-mesh mapping information.
Definition:
polyMeshMap.H:51
Foam::polyTopoChangeMap
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition:
polyTopoChangeMap.H:126
Foam::word
A class for handling words, derived from string.
Definition:
word.H:62
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.H:214
objectRegistry.H
cloudName
const word cloudName(propsDict.lookup("cloudName"))
src
lagrangian
basic
cloud
cloud.H
Generated by
1.9.1