cloud.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2016-2019 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
12 This file is part of OpenFOAM.
13
14 OpenFOAM is free software: you can redistribute it and/or modify it
15 under the terms of the GNU General Public License as published by
16 the Free Software Foundation, either version 3 of the License, or
17 (at your option) any later version.
18
19 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 for more details.
23
24 You should have received a copy of the GNU General Public License
25 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26
27\*---------------------------------------------------------------------------*/
28
29#include "cloud.H"
30#include "Time.H"
31
32// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33
34namespace Foam
35{
37}
38
39const Foam::word Foam::cloud::prefix("lagrangian");
41
44({
45 { geometryType::COORDINATES, "coordinates" },
46 { geometryType::POSITIONS, "positions" }
47});
48
49
50// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
51
53:
54 cloud(obr, defaultName)
55{}
56
57
59:
61 (
63 (
65 obr.time().timeName(),
66 prefix,
67 obr,
68 IOobject::NO_READ,
69 IOobject::AUTO_WRITE
70 )
71 )
72{}
73
74
75// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
76
77Foam::label Foam::cloud::nParcels() const
78{
80 return 0;
81}
82
83
85{
87}
88
89
91{
93}
94
95
97{
99}
100
101
102// ************************************************************************* //
Enum is a wrapper around a list of names/values that represent particular enumeration (or int) values...
Definition: Enum.H:61
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:170
A cloud is a registry collection of lagrangian particles.
Definition: cloud.H:60
virtual void readObjects(const objectRegistry &obr)
Read particle fields from objects in the obr registry.
Definition: cloud.C:90
static const word prefix
The prefix to local: lagrangian.
Definition: cloud.H:87
virtual label nParcels() const
Number of parcels for the hosting cloud.
Definition: cloud.C:77
static const Enum< geometryType > geometryTypeNames
Definition: cloud.H:80
virtual void autoMap(const mapPolyMesh &)
Definition: cloud.C:84
static word defaultName
The default cloud name: defaultCloud.
Definition: cloud.H:90
Allows specification of different writing frequency of objects registered to the database.
Definition: writeObjects.H:142
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:162
Registry of regIOobjects.
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define defineTypeNameAndDebug(Type, DebugSwitch)
Define the typeName and debug information.
Definition: className.H:121
#define NotImplemented
Issue a FatalErrorIn for a function not currently implemented.
Definition: error.H:517
word timeName
Definition: getTimeIndex.H:3
Namespace for OpenFOAM.
const word cloudName(propsDict.get< word >("cloud"))