ScaledForce.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) 2018-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::ScaledForce
26 
27 Description
28  Particle force model scaled by a constant value
29 
30 \*---------------------------------------------------------------------------*/
31 
32 #ifndef ScaledForce_H
33 #define ScaledForce_H
34 
35 #include "ParticleForce.H"
36 
37 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
38 
39 namespace Foam
40 {
41 /*---------------------------------------------------------------------------*\
42  Class ScaledForce Declaration
43 \*---------------------------------------------------------------------------*/
44 
45 template<class CloudType>
46 class ScaledForce
47 :
48  public ParticleForce<CloudType>
49 {
50  // Private Data
51 
52  //- Model to scale
54 
55  //- Scale factor
56  const scalar factor_;
57 
58 
59  // Private Member Functions
60 
61  //- Create the dictionary for the sub-model
62  dictionary modelDict(const dictionary& dict) const;
63 
64 
65 public:
66 
67  //- Runtime type information
68  TypeName("scaled");
69 
70 
71  // Constructors
72 
73  //- Construct from mesh
75  (
77  const fvMesh& mesh,
78  const dictionary& dict
79  );
80 
81  //- Construct copy
83 
84  //- Construct and return a clone
86  {
88  (
89  new ScaledForce<CloudType>(*this)
90  );
91  }
92 
93 
94  //- Destructor
95  virtual ~ScaledForce();
96 
97 
98  // Member Functions
99 
100  // Evaluation
101 
102  //- Calculate the coupled force
103  virtual forceSuSp calcCoupled
104  (
105  const typename CloudType::parcelType& p,
106  const typename CloudType::parcelType::trackingData& td,
107  const scalar dt,
108  const scalar mass,
109  const scalar Re,
110  const scalar muc
111  ) const;
112 
113  //- Calculate the non-coupled force
114  virtual forceSuSp calcNonCoupled
115  (
116  const typename CloudType::parcelType& p,
117  const typename CloudType::parcelType::trackingData& td,
118  const scalar dt,
119  const scalar mass,
120  const scalar Re,
121  const scalar muc
122  ) const;
123 
124  //- Return the added mass
125  virtual scalar massAdd
126  (
127  const typename CloudType::parcelType& p,
128  const typename CloudType::parcelType::trackingData& td,
129  const scalar mass
130  ) const;
131 };
132 
133 
134 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
135 
136 } // End namespace Foam
137 
138 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
139 
140 #ifdef NoRepository
141  #include "ScaledForce.C"
142 #endif
143 
144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
145 
146 #endif
147 
148 // ************************************************************************* //
dictionary dict
virtual ~ScaledForce()
Destructor.
Definition: ScaledForce.C:83
virtual autoPtr< ParticleForce< CloudType > > clone() const
Construct and return a clone.
Definition: ScaledForce.H:84
Particle force model scaled by a constant value.
Definition: ScaledForce.H:45
virtual scalar massAdd(const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const
Return the added mass.
Definition: ScaledForce.C:121
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
TypeName("scaled")
Runtime type information.
const fvMesh & mesh() const
Return the mesh database.
Abstract base class for particle forces.
Definition: ParticleForce.H:53
ScaledForce(CloudType &owner, const fvMesh &mesh, const dictionary &dict)
Construct from mesh.
Definition: ScaledForce.C:47
const CloudType & owner() const
Return const access to the cloud owner.
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:61
virtual forceSuSp calcCoupled(const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
Calculate the coupled force.
Definition: ScaledForce.C:91
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:221
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
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
virtual forceSuSp calcNonCoupled(const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
Calculate the non-coupled force.
Definition: ScaledForce.C:106
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:75
scalarField Re(const UList< complex > &cf)
Definition: complexFields.C:97
Namespace for OpenFOAM.