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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011-2017 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "ParticleForce.H"
29 
30 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
31 
32 template<class CloudType>
34 (
35  CloudType& owner,
36  const fvMesh& mesh,
37  const dictionary& dict,
38  const word& forceType,
39  const bool readCoeffs
40 )
41 :
42  owner_(owner),
43  mesh_(mesh),
44  coeffs_(readCoeffs ? dict : dictionary::null)
45 {
46  if (readCoeffs && (coeffs_.dictName() != forceType))
47  {
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 typename CloudType::parcelType::trackingData& td,
83  const scalar dt,
84  const scalar mass,
85  const scalar Re,
86  const scalar muc
87 ) const
88 {
89  forceSuSp value;
90  value.Su() = Zero;
91  value.Sp() = 0.0;
92 
93  return value;
94 }
95 
96 
97 template<class CloudType>
99 (
100  const typename CloudType::parcelType&,
101  const typename CloudType::parcelType::trackingData& td,
102  const scalar dt,
103  const scalar mass,
104  const scalar Re,
105  const scalar muc
106 ) const
107 {
108  forceSuSp value;
109  value.Su() = Zero;
110  value.Sp() = 0.0;
111 
112  return value;
113 }
114 
115 
116 template<class CloudType>
118 (
119  const typename CloudType::parcelType& p,
120  const typename CloudType::parcelType::trackingData& td,
121  const scalar mass
122 ) const
123 {
124  return 0.0;
125 }
126 
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #include "ParticleForceNew.C"
131 
132 // ************************************************************************* //
p
volScalarField & p
Definition: createFieldRefs.H:8
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::Zero
static constexpr const zero Zero
Global zero (0)
Definition: zero.H:131
Foam::ParticleForce::ParticleForce
ParticleForce(CloudType &owner, const fvMesh &mesh, const dictionary &dict, const word &forceType, const bool readCoeffs)
Construct from mesh.
Definition: ParticleForce.C:34
Foam::FatalIOError
IOerror FatalIOError
Foam::forceSuSp::Su
const vector & Su() const
Return const access to the explicit contribution [kg.m/s2].
Definition: forceSuSpI.H:61
Foam::ParticleForce::calcCoupled
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:80
Foam::ParticleForce::calcNonCoupled
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: ParticleForce.C:99
Foam::forceSuSp
Helper container for force Su and Sp terms.
Definition: forceSuSp.H:64
Foam::ParticleForce::cacheFields
virtual void cacheFields(const bool store)
Cache fields.
Definition: ParticleForce.C:74
Foam::ParticleForce
Abstract base class for particle forces.
Definition: ParticleForce.H:59
ParticleForce.H
Foam::ParticleForce::massAdd
virtual scalar massAdd(const typename CloudType::parcelType &p, const typename CloudType::parcelType::trackingData &td, const scalar mass) const
Return the added mass.
Definition: ParticleForce.C:118
Foam::DSMCCloud
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:71
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:123
ParticleForceNew.C
mesh
dynamicFvMesh & mesh
Definition: createDynamicFvMesh.H:6
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:85
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
Foam::Re
scalarField Re(const UList< complex > &cf)
Extract real component.
Definition: complexField.C:159
Foam::forceSuSp::Sp
scalar Sp() const
Return const access to the implicit coefficient [kg/s].
Definition: forceSuSpI.H:67
Foam::DSMCCloud::parcelType
ParcelType parcelType
Type of parcel the cloud was instantiated for.
Definition: DSMCCloud.H:220
FatalIOErrorInFunction
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:473
Foam::ParticleForce::~ParticleForce
virtual ~ParticleForce()
Destructor.
Definition: ParticleForce.C:67