ParticleForce.C
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-2018 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_
43  (
44  readCoeffs
45  ? dict.optionalSubDict(forceType + "Coeffs")
46  : dictionary::null
47  )
48 {
49  if (readCoeffs && coeffs_.isNull())
50  {
52  (
53  dict
54  ) << "Force " << forceType << " must be specified as a dictionary"
55  << exit(FatalIOError);
56  }
57 }
58 
59 
60 template<class CloudType>
62 :
63  owner_(pf.owner_),
64  mesh_(pf.mesh_),
65  coeffs_(pf.coeffs_)
66 {}
67 
68 
69 // * * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * //
70 
71 template<class CloudType>
73 {}
74 
75 
76 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
77 
78 template<class CloudType>
80 {}
81 
82 
83 template<class CloudType>
85 (
86  const typename CloudType::parcelType&,
87  const typename CloudType::parcelType::trackingData& td,
88  const scalar dt,
89  const scalar mass,
90  const scalar Re,
91  const scalar muc
92 ) const
93 {
94  forceSuSp value;
95  value.Su() = Zero;
96  value.Sp() = 0.0;
97 
98  return value;
99 }
100 
101 
102 template<class CloudType>
104 (
105  const typename CloudType::parcelType&,
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  forceSuSp value;
114  value.Su() = Zero;
115  value.Sp() = 0.0;
116 
117  return value;
118 }
119 
120 
121 template<class CloudType>
123 (
124  const typename CloudType::parcelType& p,
125  const typename CloudType::parcelType::trackingData& td,
126  const scalar mass
127 ) const
128 {
129  return 0.0;
130 }
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #include "ParticleForceNew.C"
136 
137 // ************************************************************************* //
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.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
const vector & Su() const
Return const access to the explicit contribution [kg m/s^2].
Definition: forceSuSpI.H:56
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
virtual scalar massAdd(const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const
Return the added mass.
Abstract base class for particle forces.
Definition: ParticleForce.H:53
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:61
const dictionary & optionalSubDict(const word &) const
Find and return a sub-dictionary if found.
Definition: dictionary.C:1001
A class for handling words, derived from string.
Definition: word.H:59
virtual void cacheFields(const bool store)
Cache fields.
Definition: ParticleForce.C:79
static const zero Zero
Definition: zero.H:97
scalar Sp() const
Return const access to the implicit coefficient [kg/s].
Definition: forceSuSpI.H:62
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:215
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: ParticleForce.C:85
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:331
virtual ~ParticleForce()
Destructor.
Definition: ParticleForce.C:72
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:69
IOerror FatalIOError