ParticleForce.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "ParticleForce.H"
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class CloudType>
32 (
33  CloudType& owner,
34  const fvMesh& mesh,
35  const dictionary& dict,
36  const word& forceType,
37  const bool readCoeffs
38 )
39 :
40  owner_(owner),
41  mesh_(mesh),
42  coeffs_(readCoeffs ? dict : dictionary::null)
43 {
44  if (readCoeffs && (coeffs_.dictName() != forceType))
45  {
47  (
48  dict
49  ) << "Force " << forceType << " must be specified as a dictionary"
50  << exit(FatalIOError);
51  }
52 }
53 
54 
55 template<class CloudType>
57 :
58  owner_(pf.owner_),
59  mesh_(pf.mesh_),
60  coeffs_(pf.coeffs_)
61 {}
62 
63 
64 // * * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * //
65 
66 template<class CloudType>
68 {}
69 
70 
71 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
72 
73 template<class CloudType>
75 {}
76 
77 
78 template<class CloudType>
80 (
81  const typename CloudType::parcelType&,
82  const scalar dt,
83  const scalar mass,
84  const scalar Re,
85  const scalar muc
86 ) const
87 {
88  forceSuSp value;
89  value.Su() = Zero;
90  value.Sp() = 0.0;
91 
92  return value;
93 }
94 
95 
96 template<class CloudType>
98 (
99  const typename CloudType::parcelType&,
100  const scalar dt,
101  const scalar mass,
102  const scalar Re,
103  const scalar muc
104 ) const
105 {
106  forceSuSp value;
107  value.Su() = Zero;
108  value.Sp() = 0.0;
109 
110  return value;
111 }
112 
113 
114 template<class CloudType>
116 (
117  const typename CloudType::parcelType& p,
118  const scalar mass
119 ) const
120 {
121  return 0.0;
122 }
123 
124 
125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
126 
127 #include "ParticleForceNew.C"
128 
129 // ************************************************************************* //
virtual scalar massAdd(const typename CloudType::parcelType &p, const scalar mass) const
Return the added mass.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
virtual forceSuSp calcCoupled(const typename CloudType::parcelType &p, const scalar dt, const scalar mass, const scalar Re, const scalar muc) const
Calculate the coupled force.
Definition: ParticleForce.C:80
Abstract base class for particle forces.
Definition: ParticleForce.H:53
const vector & Su() const
Return const access to the explicit contribution [kg.m/s2].
Definition: forceSuSpI.H:56
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:61
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: ParticleForce.C:98
A class for handling words, derived from string.
Definition: word.H:59
virtual void cacheFields(const bool store)
Cache fields.
Definition: ParticleForce.C:74
static const zero Zero
Definition: zero.H:91
ParticleForce(CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType, const bool readCoeffs)
Construct from mesh.
Definition: ParticleForce.C:32
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:217
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:331
virtual ~ParticleForce()
Destructor.
Definition: ParticleForce.C:67
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:68
scalar Sp() const
Return const access to the implicit coefficient [kg/s].
Definition: forceSuSpI.H:62
IOerror FatalIOError