unmappedPassivePositionParticleCloud.H
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) 2015 OpenFOAM Foundation
9 Copyright (C) 2019-2020 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
27Class
28 Foam::unmappedPassivePositionParticleCloud
29
30Description
31 passivePositionParticleCloud but with autoMap and writing disabled.
32 Only used for its objectRegistry to store lagrangian fields
33
34SourceFiles
35 unmappedPassivePositionParticleCloud.C
36
37\*---------------------------------------------------------------------------*/
38
39#ifndef unmappedPassivePositionParticleCloud_H
40#define unmappedPassivePositionParticleCloud_H
41
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
48
49/*---------------------------------------------------------------------------*\
50 Class unmappedPassiveParticleCloud Declaration
51\*---------------------------------------------------------------------------*/
54:
56{
57
58public:
59
60 // Constructors
61
62 //- Construct given mesh
64 (
65 const polyMesh& mesh,
67 bool readFields = true
68 )
69 :
71 {}
72
73 //- Construct from mesh, cloud name, and a list of particles
75 (
76 const polyMesh& mesh,
77 const word& cloudName,
79 )
80 :
82 {}
83
84
85 //- Destructor
86 virtual ~unmappedPassivePositionParticleCloud() = default;
87
88
89 // Member Functions
90
91 //- Switch off remapping of cells of particles when
92 // mesh topology changes
93 virtual void autoMap(const mapPolyMesh&)
94 {}
95
96 //- Disable writing objects
97 virtual bool writeObject(IOstreamOption, const bool valid) const
98 {
99 return true;
100 }
101};
102
103
104// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105
106} // End namespace Foam
107
108// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109
110#endif
111
112// ************************************************************************* //
Template class for intrusive linked lists.
Definition: ILList.H:69
The IOstreamOption is a simple container for options an IOstream can normally have.
static word defaultName
The default cloud name: defaultCloud.
Definition: cloud.H:90
Class containing mesh-to-mesh mapping information after a change in polyMesh topology.
Definition: mapPolyMesh.H:162
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:81
passivePositionParticleCloud but with autoMap and writing disabled. Only used for its objectRegistry ...
virtual void autoMap(const mapPolyMesh &)
Switch off remapping of cells of particles when.
virtual ~unmappedPassivePositionParticleCloud()=default
Destructor.
unmappedPassivePositionParticleCloud(const polyMesh &mesh, const word &cloudName, const IDLList< passivePositionParticle > &particles)
Construct from mesh, cloud name, and a list of particles.
virtual bool writeObject(IOstreamOption, const bool valid) const
Disable writing objects.
unmappedPassivePositionParticleCloud(const polyMesh &mesh, const word &cloudName=cloud::defaultName, bool readFields=true)
Construct given mesh.
A class for handling words, derived from Foam::string.
Definition: word.H:68
dynamicFvMesh & mesh
Namespace for OpenFOAM.
void readFields(const typename GeoFieldType::Mesh &mesh, const IOobjectList &objects, const wordHashSet &selectedFields, LIFOStack< regIOobject * > &storedObjects)
Read the selected GeometricFields of the templated type.
const word cloudName(propsDict.get< word >("cloud"))