src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcelI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 \*---------------------------------------------------------------------------*/
  26
  27 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  28
  29 template <class ParcelType>
  30 inline Foam::KinematicParcel<ParcelType>::constantProperties::constantProperties
  31 (
  32     const dictionary& parentDict
  33 )
  34 :
  35     dict_(parentDict.subDict("constantProperties")),
  36     rhoMin_(dimensionedScalar(dict_.lookup("rhoMin")).value()),
  37     rho0_(dimensionedScalar(dict_.lookup("rho0")).value()),
  38     minParticleMass_
  39     (
  40         dimensionedScalar(dict_.lookup("minParticleMass")).value()
  41     )
  42 {}
  43
  44
  45 template <class ParcelType>
  46 inline Foam::KinematicParcel<ParcelType>::trackData::trackData
  47 (
  48     KinematicCloud<ParcelType>& cloud,
  49     const constantProperties& constProps,
  50     const interpolation<scalar>& rhoInterp,
  51     const interpolation<vector>& UInterp,
  52     const interpolation<scalar>& muInterp,
  53     const vector& g
  54 )
  55 :
  56     Particle<ParcelType>::trackData(cloud),
  57     cloud_(cloud),
  58     constProps_(constProps),
  59     rhoInterp_(rhoInterp),
  60     UInterp_(UInterp),
  61     muInterp_(muInterp),
  62     g_(g)
  63 {}
  64
  65
  66 template <class ParcelType>
  67 inline Foam::KinematicParcel<ParcelType>::KinematicParcel
  68 (
  69     KinematicCloud<ParcelType>& owner,
  70     const vector& position,
  71     const label cellI
  72 )
  73 :
  74     Particle<ParcelType>(owner, position, cellI),
  75     typeId_(owner.parcelTypeId()),
  76     nParticle_(0),
  77     d_(0.0),
  78     U_(vector::zero),
  79     rho_(0.0),
  80     tTurb_(0.0),
  81     UTurb_(vector::zero),
  82     rhoc_(0.0),
  83     Uc_(vector::zero),
  84     muc_(0.0)
  85 {}
  86
  87
  88 template <class ParcelType>
  89 inline Foam::KinematicParcel<ParcelType>::KinematicParcel
  90 (
  91     KinematicCloud<ParcelType>& owner,
  92     const vector& position,
  93     const label cellI,
  94     const label typeId,
  95     const scalar nParticle0,
  96     const scalar d0,
  97     const vector& U0,
  98     const constantProperties& constProps
  99 )
 100 :
 101     Particle<ParcelType>(owner, position, cellI),
 102     typeId_(typeId),
 103     nParticle_(nParticle0),
 104     d_(d0),
 105     U_(U0),
 106     rho_(constProps.rho0()),
 107     tTurb_(0.0),
 108     UTurb_(vector::zero),
 109     rhoc_(0.0),
 110     Uc_(vector::zero),
 111     muc_(0.0)
 112 {}
 113
 114
 115 // * * * * * * * * * constantProperties Member Functions * * * * * * * * * * //
 116
 117 template <class ParcelType>
 118 inline const Foam::dictionary&
 119 Foam::KinematicParcel<ParcelType>::constantProperties::dict() const
 120 {
 121     return dict_;
 122 }
 123
 124
 125 template <class ParcelType>
 126 inline Foam::scalar
 127 Foam::KinematicParcel<ParcelType>::constantProperties::rhoMin() const
 128 {
 129     return rhoMin_;
 130 }
 131
 132
 133 template <class ParcelType>
 134 inline Foam::scalar
 135 Foam::KinematicParcel<ParcelType>::constantProperties::rho0() const
 136 {
 137     return rho0_;
 138 }
 139
 140
 141 template <class ParcelType>
 142 inline Foam::scalar
 143 Foam::KinematicParcel<ParcelType>::constantProperties::minParticleMass() const
 144 {
 145     return minParticleMass_;
 146 }
 147
 148
 149 // * * * * * * * * * * * trackData Member Functions  * * * * * * * * * * * * //
 150
 151 template <class ParcelType>
 152 inline Foam::KinematicCloud<ParcelType>&
 153 Foam::KinematicParcel<ParcelType>::trackData::cloud()
 154 {
 155     return cloud_;
 156 }
 157
 158
 159 template <class ParcelType>
 160 inline const typename Foam::KinematicParcel<ParcelType>::constantProperties&
 161 Foam::KinematicParcel<ParcelType>::trackData::constProps() const
 162 {
 163     return constProps_;
 164 }
 165
 166
 167 template<class ParcelType>
 168 inline const Foam::interpolation<Foam::scalar>&
 169 Foam::KinematicParcel<ParcelType>::trackData::rhoInterp() const
 170 {
 171     return rhoInterp_;
 172 }
 173
 174
 175 template <class ParcelType>
 176 inline const Foam::interpolation<Foam::vector>&
 177 Foam::KinematicParcel<ParcelType>::trackData::UInterp() const
 178 {
 179     return UInterp_;
 180 }
 181
 182
 183 template<class ParcelType>
 184 inline const Foam::interpolation<Foam::scalar>&
 185 Foam::KinematicParcel<ParcelType>::trackData::muInterp() const
 186 {
 187     return muInterp_;
 188 }
 189
 190
 191 template<class ParcelType>
 192 inline const Foam::vector&
 193 Foam::KinematicParcel<ParcelType>::trackData::g() const
 194 {
 195     return g_;
 196 }
 197
 198
 199 // * * * * * * * * * * KinematicParcel Member Functions  * * * * * * * * * * //
 200
 201 template <class ParcelType>
 202 inline Foam::label Foam::KinematicParcel<ParcelType>::typeId() const
 203 {
 204     return typeId_;
 205 }
 206
 207
 208 template <class ParcelType>
 209 inline Foam::scalar Foam::KinematicParcel<ParcelType>::nParticle() const
 210 {
 211     return nParticle_;
 212 }
 213
 214
 215 template <class ParcelType>
 216 inline Foam::scalar Foam::KinematicParcel<ParcelType>::d() const
 217 {
 218     return d_;
 219 }
 220
 221
 222 template <class ParcelType>
 223 inline const Foam::vector& Foam::KinematicParcel<ParcelType>::U() const
 224 {
 225     return U_;
 226 }
 227
 228
 229 template <class ParcelType>
 230 inline Foam::scalar Foam::KinematicParcel<ParcelType>::rho() const
 231 {
 232     return rho_;
 233 }
 234
 235
 236 template <class ParcelType>
 237 inline Foam::scalar Foam::KinematicParcel<ParcelType>::tTurb() const
 238 {
 239     return tTurb_;
 240 }
 241
 242
 243 template <class ParcelType>
 244 inline const Foam::vector& Foam::KinematicParcel<ParcelType>::UTurb() const
 245 {
 246     return UTurb_;
 247 }
 248
 249
 250 template <class ParcelType>
 251 inline Foam::label Foam::KinematicParcel<ParcelType>::typeId()
 252 {
 253     return typeId_;
 254 }
 255
 256
 257 template <class ParcelType>
 258 inline Foam::scalar& Foam::KinematicParcel<ParcelType>::nParticle()
 259 {
 260     return nParticle_;
 261 }
 262
 263
 264 template <class ParcelType>
 265 inline Foam::scalar& Foam::KinematicParcel<ParcelType>::d()
 266 {
 267     return d_;
 268 }
 269
 270
 271 template <class ParcelType>
 272 inline Foam::vector& Foam::KinematicParcel<ParcelType>::U()
 273 {
 274     return U_;
 275 }
 276
 277
 278 template <class ParcelType>
 279 inline Foam::scalar& Foam::KinematicParcel<ParcelType>::rho()
 280 {
 281     return rho_;
 282 }
 283
 284
 285 template <class ParcelType>
 286 inline Foam::scalar& Foam::KinematicParcel<ParcelType>::tTurb()
 287 {
 288     return tTurb_;
 289 }
 290
 291
 292 template <class ParcelType>
 293 inline Foam::vector& Foam::KinematicParcel<ParcelType>::UTurb()
 294 {
 295     return UTurb_;
 296 }
 297
 298
 299 template <class ParcelType>
 300 inline Foam::scalar Foam::KinematicParcel<ParcelType>::wallImpactDistance
 301 (
 302     const vector&
 303 ) const
 304 {
 305     return 0.5*d_;
 306 }
 307
 308
 309 template <class ParcelType>
 310 inline Foam::label Foam::KinematicParcel<ParcelType>::faceInterpolation() const
 311 {
 312     // Use volume-based interpolation if dealing with external faces
 313     if (this->cloud().internalFace(this->face()))
 314     {
 315         return this->face();
 316     }
 317     else
 318     {
 319         return -1;
 320     }
 321 }
 322
 323
 324 template <class ParcelType>
 325 inline Foam::scalar Foam::KinematicParcel<ParcelType>::massCell
 326 (
 327     const label cellI
 328 ) const
 329 {
 330     return rhoc_*this->cloud().pMesh().cellVolumes()[cellI];
 331 }
 332
 333
 334 template <class ParcelType>
 335 inline Foam::scalar Foam::KinematicParcel<ParcelType>::mass() const
 336 {
 337     return rho_*volume();
 338 }
 339
 340
 341 template <class ParcelType>
 342 inline Foam::scalar Foam::KinematicParcel<ParcelType>::volume() const
 343 {
 344     return volume(d_);
 345 }
 346
 347
 348 template <class ParcelType>
 349 inline Foam::scalar
 350 Foam::KinematicParcel<ParcelType>::volume(const scalar d) const
 351 {
 352     return mathematicalConstant::pi/6.0*pow3(d);
 353 }
 354
 355
 356 template <class ParcelType>
 357 inline Foam::scalar Foam::KinematicParcel<ParcelType>::areaP() const
 358 {
 359     return areaP(d_);
 360 }
 361
 362
 363 template <class ParcelType>
 364 inline Foam::scalar
 365 Foam::KinematicParcel<ParcelType>::areaP(const scalar d) const
 366 {
 367     return 0.25*areaS(d);
 368 }
 369
 370
 371 template <class ParcelType>
 372 inline Foam::scalar Foam::KinematicParcel<ParcelType>::areaS() const
 373 {
 374     return areaS(d_);
 375 }
 376
 377
 378 template <class ParcelType>
 379 inline Foam::scalar
 380 Foam::KinematicParcel<ParcelType>::areaS(const scalar d) const
 381 {
 382     return mathematicalConstant::pi*d*d;
 383 }
 384
 385
 386 // ************************************************************************* //