OpenFOAM
8
The OpenFOAM Foundation
•
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Pages
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-2019 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
// Forward declaration of classes
46
class
mapPolyMesh;
47
48
/*---------------------------------------------------------------------------*\
49
Class cloud Declaration
50
\*---------------------------------------------------------------------------*/
51
52
class
cloud
53
:
54
public
objectRegistry
55
{
56
57
public
:
58
59
//- Runtime type information
60
TypeName
(
"cloud"
);
61
62
//- The prefix to local: %lagrangian
63
static
const
word
prefix
;
64
65
//- The default cloud name: %defaultCloud
66
static
word
defaultName
;
67
68
69
// Constructors
70
71
//- Construct for the given objectRegistry and named cloud instance
72
cloud
(
const
objectRegistry
&,
const
word
&
cloudName
= defaultName);
73
74
//- Disallow default bitwise copy construction
75
cloud
(
const
cloud
&) =
delete
;
76
77
78
//- Destructor
79
virtual
~cloud
();
80
81
82
// Member Functions
83
84
// Edit
85
86
//- Remap the cells of particles corresponding to the
87
// mesh topology change
88
virtual
void
autoMap
(
const
mapPolyMesh
&);
89
90
91
// Member Operators
92
93
//- Disallow default bitwise assignment
94
void
operator=
(
const
cloud
&) =
delete
;
95
};
96
97
98
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99
100
}
// End namespace Foam
101
102
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103
104
#endif
105
106
// ************************************************************************* //
Foam::mapPolyMesh
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition:
mapPolyMesh.H:158
Foam::cloud::autoMap
virtual void autoMap(const mapPolyMesh &)
Remap the cells of particles corresponding to the.
Definition:
cloud.C:67
Foam::cloud::TypeName
TypeName("cloud")
Runtime type information.
Foam::cloud::operator=
void operator=(const cloud &)=delete
Disallow default bitwise assignment.
Foam::word
A class for handling words, derived from string.
Definition:
word.H:59
Foam::cloud
A cloud is a collection of lagrangian particles.
Definition:
cloud.H:51
objectRegistry.H
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::defaultName
static word defaultName
The default cloud name: defaultCloud.
Definition:
cloud.H:65
Foam::cloud::prefix
static const word prefix
The prefix to local: lagrangian.
Definition:
cloud.H:62
Foam::cloud::~cloud
virtual ~cloud()
Destructor.
Definition:
cloud.C:61
cloudName
const word cloudName(propsDict.lookup("cloudName"))
Foam::objectRegistry
Registry of regIOobjects.
Definition:
objectRegistry.H:52
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.H:213
src
OpenFOAM
fields
cloud
cloud.H
Generated by
1.8.13