solidParticleCloud.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-2020 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::solidParticleCloud
26 
27 Description
28  A Cloud of solid particles
29 
30 SourceFiles
31  solidParticleCloudI.H
32  solidParticleCloud.C
33  solidParticleCloudIO.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef solidParticleCloud_H
38 #define solidParticleCloud_H
39 
40 #include "Cloud.H"
41 #include "solidParticle.H"
42 #include "IOdictionary.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 // Forward declaration of classes
50 class fvMesh;
51 
52 /*---------------------------------------------------------------------------*\
53  Class solidParticleCloud Declaration
54 \*---------------------------------------------------------------------------*/
55 
57 :
58  public Cloud<solidParticle>
59 {
60  // Private Data
61 
62  const fvMesh& mesh_;
63 
64  IOdictionary particleProperties_;
65 
66  scalar rhop_;
67  scalar e_;
68  scalar mu_;
69 
70 
71 public:
72 
73  //- Runtime type information
74  TypeName("solidParticleCloud");
75 
76 
77  // Constructors
78 
79  //- Construct given mesh
81  (
82  const fvMesh&,
83  const word& cloudName = "defaultCloud",
84  bool readFields = true
85  );
86 
87  //- Disallow default bitwise copy construction
88  solidParticleCloud(const solidParticleCloud&) = delete;
89 
90 
91  // Member Functions
92 
93  // Access
94 
95  inline const fvMesh& mesh() const;
96 
97  inline scalar rhop() const;
98  inline scalar e() const;
99  inline scalar mu() const;
100 
101 
102  // Edit
103 
104  //- Move the particles under the influence of the given
105  // gravitational acceleration
106  void move(const dimensionedVector& g);
107 
108 
109  // Member Operators
110 
111  //- Disallow default bitwise assignment
112  void operator=(const solidParticleCloud&) = delete;
113 };
114 
115 
116 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
117 
118 } // End namespace Foam
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 #include "solidParticleCloudI.H"
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
TypeName("solidParticleCloud")
Runtime type information.
void readFields(const typename GeoFieldType::Mesh &mesh, const IOobjectList &objects, const HashSet< word > &selectedFields, LIFOStack< regIOobject *> &storedObjects)
Read the selected GeometricFields of the specified type.
Definition: ReadFields.C:244
void operator=(const solidParticleCloud &)=delete
Disallow default bitwise assignment.
void move(const dimensionedVector &g)
Move the particles under the influence of the given.
IOdictionary is derived from dictionary and IOobject to give the dictionary automatic IO functionalit...
Definition: IOdictionary.H:53
A class for handling words, derived from string.
Definition: word.H:59
solidParticleCloud(const fvMesh &, const word &cloudName="defaultCloud", bool readFields=true)
Construct given mesh.
A Cloud of solid particles.
Base cloud calls templated on particle type.
Definition: Cloud.H:52
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:95
const fvMesh & mesh() const
const word cloudName(propsDict.lookup("cloudName"))
const dimensionedVector & g
Namespace for OpenFOAM.