GravityForce.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 | Copyright (C) 2011-2016 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::GravityForce
26 
27 Description
28  Calculates particle gravity force
29 
30 SourceFiles
31  GravityForceI.H
32  GravityForce.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef GravityForce_H
37 #define GravityForce_H
38 
39 #include "ParticleForce.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class fvMesh;
47 
48 /*---------------------------------------------------------------------------*\
49  Class GravityForce Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class CloudType>
53 class GravityForce
54 :
55  public ParticleForce<CloudType>
56 {
57  // Private data
58 
59  //- Reference to the acceleration due to gravity
60  const vector& g_;
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("gravity");
67 
68 
69  // Constructors
70 
71  //- Construct from mesh
73  (
75  const fvMesh& mesh,
76  const dictionary& dict
77  );
78 
79  //- Construct copy
80  GravityForce(const GravityForce& gf);
81 
82  //- Construct and return a clone
84  {
86  (
87  new GravityForce<CloudType>(*this)
88  );
89  }
90 
91 
92  //- Destructor
93  virtual ~GravityForce();
94 
95 
96  // Member Functions
97 
98  // Access
99 
100  //- Return the acceleration due to gravity
101  inline const vector& g() const;
102 
103 
104  // Evaluation
105 
106  //- Calculate the non-coupled force
107  virtual forceSuSp calcNonCoupled
108  (
109  const typename CloudType::parcelType& p,
110  const scalar dt,
111  const scalar mass,
112  const scalar Re,
113  const scalar muc
114  ) const;
115 };
116 
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 } // End namespace Foam
121 
122 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
123 
124 #include "GravityForceI.H"
125 
126 #ifdef NoRepository
127  #include "GravityForce.C"
128 #endif
129 
130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
131 
132 #endif
133 
134 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const vector & g() const
Return the acceleration due to gravity.
Definition: GravityForceI.H:29
const fvMesh & mesh() const
Return the mesh database.
Abstract base class for particle forces.
Definition: ParticleForce.H:53
GravityForce(CloudType &owner, const fvMesh &mesh, const dictionary &dict)
Construct from mesh.
Definition: GravityForce.C:32
const CloudType & owner() const
Return const access to the cloud owner.
virtual ~GravityForce()
Destructor.
Definition: GravityForce.C:54
virtual forceSuSp calcNonCoupled(const typename CloudType::parcelType &p, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
Calculate the non-coupled force.
Definition: GravityForce.C:62
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:61
TypeName("gravity")
Runtime type information.
Calculates particle gravity force.
Definition: GravityForce.H:52
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:218
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual autoPtr< ParticleForce< CloudType > > clone() const
Construct and return a clone.
Definition: GravityForce.H:82
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
volScalarField & p
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
scalarField Re(const UList< complex > &cf)
Definition: complexFields.C:97
Namespace for OpenFOAM.