OpenFOAM
13
The OpenFOAM Foundation
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
{
35
defineTypeNameAndDebug
(
cloud
, 0);
36
37
const
word
cloud::prefix
(
"lagrangian"
);
38
const
word
cloud::defaultName
(
"defaultCloud"
);
39
}
40
}
41
42
43
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
44
45
Foam::lagrangian::cloud::cloud
(
const
objectRegistry
& obr,
const
word
&
cloudName
)
46
:
47
objectRegistry
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
64
Foam::lagrangian::cloud::~cloud
()
65
{}
66
67
68
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
69
70
void
Foam::lagrangian::cloud::topoChange
(
const
polyTopoChangeMap
&)
71
{
72
NotImplemented
;
73
}
74
75
76
void
Foam::lagrangian::cloud::mapMesh
(
const
polyMeshMap
&)
77
{
78
NotImplemented
;
79
}
80
81
82
void
Foam::lagrangian::cloud::distribute
(
const
polyDistributionMap
&)
83
{
84
NotImplemented
;
85
}
86
87
88
// ************************************************************************* //
Time.H
Foam::IOobject
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition:
IOobject.H:99
Foam::lagrangian::cloud
Definition:
cloud.H:58
Foam::lagrangian::cloud::topoChange
virtual void topoChange(const polyTopoChangeMap &)
Update topology using the given map.
Definition:
cloud.C:70
Foam::lagrangian::cloud::cloud
cloud(const objectRegistry &, const word &cloudName=defaultName)
Construct for the given objectRegistry and named cloud instance.
Definition:
cloud.C:45
Foam::lagrangian::cloud::distribute
virtual void distribute(const polyDistributionMap &)
Redistribute or update using the given distribution map.
Definition:
cloud.C:82
Foam::lagrangian::cloud::mapMesh
virtual void mapMesh(const polyMeshMap &)
Update from another mesh using the given map.
Definition:
cloud.C:76
Foam::lagrangian::cloud::defaultName
static const word defaultName
The default cloud name: defaultCloud.
Definition:
cloud.H:72
Foam::lagrangian::cloud::~cloud
virtual ~cloud()
Destructor.
Definition:
cloud.C:64
Foam::lagrangian::cloud::prefix
static const word prefix
The prefix to local: lagrangian.
Definition:
cloud.H:69
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
NotImplemented
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition:
error.H:381
cloud.H
Foam::lagrangian::defineTypeNameAndDebug
defineTypeNameAndDebug(cloud, 0)
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.H:214
Foam::name
word name(const LagrangianState state)
Return a string representation of a Lagrangian state enumeration.
Definition:
LagrangianState.C:30
cloudName
const word cloudName(propsDict.lookup("cloudName"))
src
lagrangian
basic
cloud
cloud.C
Generated by
1.9.1