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-2012 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  "Foam::ParticleForce<CloudType>::ParticleForce"
49  "("
50  "CloudType&, "
51  "const fvMesh&, "
52  "const dictionary&, "
53  "const word&, "
54  "const bool"
55  ")",
56  dict
57  ) << "Force " << forceType << " must be specified as a dictionary"
58  << exit(FatalIOError);
59  }
60 }
61 
62 
63 template<class CloudType>
65 :
66  owner_(pf.owner_),
67  mesh_(pf.mesh_),
68  coeffs_(pf.coeffs_)
69 {}
70 
71 
72 // * * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * //
73 
74 template<class CloudType>
76 {}
77 
78 
79 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
80 
81 template<class CloudType>
83 {}
84 
85 
86 template<class CloudType>
88 (
89  const typename CloudType::parcelType&,
90  const scalar dt,
91  const scalar mass,
92  const scalar Re,
93  const scalar muc
94 ) const
95 {
96  forceSuSp value;
97  value.Su() = vector::zero;
98  value.Sp() = 0.0;
99 
100  return value;
101 }
102 
103 
104 template<class CloudType>
106 (
107  const typename CloudType::parcelType&,
108  const scalar dt,
109  const scalar mass,
110  const scalar Re,
111  const scalar muc
112 ) const
113 {
114  forceSuSp value;
115  value.Su() = vector::zero;
116  value.Sp() = 0.0;
117 
118  return value;
119 }
120 
121 
122 template<class CloudType>
124 (
125  const typename CloudType::parcelType& p,
126  const scalar mass
127 ) const
128 {
129  return 0.0;
130 }
131 
132 
133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
134 
135 #include "ParticleForceNew.C"
136 
137 // ************************************************************************* //
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
ParticleForce(CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType, const bool readCoeffs)
Construct from mesh.
Definition: ParticleForce.C:32
virtual scalar massAdd(const typename CloudType::parcelType &p, const scalar mass) const
Return the added mass.
virtual void cacheFields(const bool store)
Cache fields.
Definition: ParticleForce.C:82
A class for handling words, derived from string.
Definition: word.H:59
scalar Sp() const
Return const access to the implicit coefficient [kg/s].
Definition: forceSuSpI.H:62
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
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:217
const vector & Su() const
Return const access to the explicit contribution [kg.m/s2].
Definition: forceSuSpI.H:56
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:88
IOerror FatalIOError
virtual ~ParticleForce()
Destructor.
Definition: ParticleForce.C:75
static const Vector zero
Definition: Vector.H:80
Abstract base class for particle forces.
Definition: ParticleForce.H:53
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:68
#define FatalIOErrorIn(functionName, ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:325
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:58
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.