Loading...
Searching...
No Matches
wallBoundedStreamLineParticleCloud.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) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2019-2023 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::wallBoundedStreamLineParticleCloud
29
30Description
31 A Cloud of wall-bounded streamLine particles
32
33SourceFiles
34 streamLineCloud.C
35
36\*---------------------------------------------------------------------------*/
37
38#ifndef Foam_wallBoundedStreamLineParticleCloud_H
39#define Foam_wallBoundedStreamLineParticleCloud_H
40
41#include "Cloud.H"
43
44// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45
46namespace Foam
47{
49/*---------------------------------------------------------------------------*\
50 Class streamLineCloud Declaration
51\*---------------------------------------------------------------------------*/
52
54:
55 public Cloud<wallBoundedStreamLineParticle>
56{
57public:
58
59 //- Type of parcel within the cloud
61
62 // Generated Methods
63
64 //- No copy construct
66 (
68 ) = delete;
69
70 //- No copy assignment
73
74 // Constructors
75
76 //- Read construct
78 (
79 const polyMesh& mesh,
81 bool readFields = true
82 );
83
84 //- Construct without particles
86 (
87 const polyMesh& mesh,
88 const Foam::zero,
90 )
91 :
93 {}
94};
95
96
97// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
98
99} // End namespace Foam
100
101// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
102
103#endif
104
105// ************************************************************************* //
const word cloudName(propsDict.get< word >("cloud"))
Cloud(const polyMesh &mesh, const Foam::zero, const word &cloudName)
Definition Cloud.C:57
static word defaultName
The default cloud name: defaultCloud.
Definition cloud.H:84
Mesh consisting of general polyhedral cells.
Definition polyMesh.H:79
wallBoundedStreamLineParticleCloud(const wallBoundedStreamLineParticleCloud &)=delete
No copy construct.
wallBoundedStreamLineParticleCloud(const polyMesh &mesh, const Foam::zero, const word &cloudName=cloud::defaultName)
Construct without particles.
wallBoundedStreamLineParticle parcelType
Type of parcel within the cloud.
void operator=(const wallBoundedStreamLineParticleCloud &)=delete
No copy assignment.
Particle class that samples fields as it passes through. Used in streamline calculation.
A class for handling words, derived from Foam::string.
Definition word.H:66
A class representing the concept of 0 (zero) that can be used to avoid manipulating objects known to ...
Definition zero.H:58
dynamicFvMesh & mesh
Namespace for OpenFOAM.
void readFields(const typename GeoFieldType::Mesh &mesh, const IOobjectList &objects, const NameMatchPredicate &selectedFields, DynamicList< regIOobject * > &storedObjects)
Read the selected GeometricFields of the templated type and store on the objectRegistry.