src/lagrangian/dsmc/clouds/Templates/DsmcCloud/DsmcCloudI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2009-2010 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
  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 "constants.H"
  27
  28 using namespace Foam::constant;
  29 using namespace Foam::constant::mathematical;
  30
  31 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  32
  33 template<class ParcelType>
  34 inline const Foam::word& Foam::DsmcCloud<ParcelType>::cloudName() const
  35 {
  36     return cloudName_;
  37 }
  38
  39
  40 template<class ParcelType>
  41 inline const Foam::fvMesh& Foam::DsmcCloud<ParcelType>::mesh() const
  42 {
  43     return mesh_;
  44 }
  45
  46
  47 template<class ParcelType>
  48 inline const Foam::IOdictionary&
  49 Foam::DsmcCloud<ParcelType>::particleProperties() const
  50 {
  51     return particleProperties_;
  52 }
  53
  54
  55 template<class ParcelType>
  56 inline const Foam::List<Foam::word>&
  57 Foam::DsmcCloud<ParcelType>::typeIdList() const
  58 {
  59     return typeIdList_;
  60 }
  61
  62
  63 template<class ParcelType>
  64 inline Foam::scalar Foam::DsmcCloud<ParcelType>::nParticle() const
  65 {
  66     return nParticle_;
  67 }
  68
  69
  70 template<class ParcelType>
  71 inline const Foam::List<Foam::DynamicList<ParcelType*> >&
  72 Foam::DsmcCloud<ParcelType>::cellOccupancy() const
  73 {
  74     return cellOccupancy_;
  75 }
  76
  77
  78 template<class ParcelType>
  79 inline Foam::volScalarField& Foam::DsmcCloud<ParcelType>::sigmaTcRMax()
  80 {
  81     return sigmaTcRMax_;
  82 }
  83
  84
  85 template<class ParcelType>
  86 inline Foam::scalarField&
  87 Foam::DsmcCloud<ParcelType>::collisionSelectionRemainder()
  88 {
  89     return collisionSelectionRemainder_;
  90 }
  91
  92
  93 template<class ParcelType>
  94 inline const Foam::List<typename ParcelType::constantProperties>&
  95 Foam::DsmcCloud<ParcelType>::constProps() const
  96 {
  97     return constProps_;
  98 }
  99
 100
 101 template<class ParcelType>
 102 inline const typename ParcelType::constantProperties&
 103 Foam::DsmcCloud<ParcelType>::constProps
 104 (
 105     label typeId
 106 ) const
 107 {
 108     if (typeId < 0 || typeId >= constProps_.size())
 109     {
 110         FatalErrorIn("Foam::DsmcCloud<ParcelType>::constProps(label typeId)")
 111             << "constantProperties for requested typeId index "
 112             << typeId << " do not exist" << nl
 113             << abort(FatalError);
 114     }
 115
 116     return constProps_[typeId];
 117 }
 118
 119
 120 template<class ParcelType>
 121 inline Foam::Random& Foam::DsmcCloud<ParcelType>::rndGen()
 122 {
 123     return rndGen_;
 124 }
 125
 126
 127 template<class ParcelType>
 128 inline Foam::volScalarField::GeometricBoundaryField&
 129 Foam::DsmcCloud<ParcelType>::qBF()
 130 {
 131     return q_.boundaryField();
 132 }
 133
 134
 135 template<class ParcelType>
 136 inline Foam::volVectorField::GeometricBoundaryField&
 137 Foam::DsmcCloud<ParcelType>::fDBF()
 138 {
 139     return fD_.boundaryField();
 140 }
 141
 142
 143 template<class ParcelType>
 144 inline Foam::volScalarField::GeometricBoundaryField&
 145 Foam::DsmcCloud<ParcelType>::rhoNBF()
 146 {
 147     return rhoN_.boundaryField();
 148 }
 149
 150
 151 template<class ParcelType>
 152 inline Foam::volScalarField::GeometricBoundaryField&
 153 Foam::DsmcCloud<ParcelType>::rhoMBF()
 154 {
 155     return rhoM_.boundaryField();
 156 }
 157
 158
 159 template<class ParcelType>
 160 inline Foam::volScalarField::GeometricBoundaryField&
 161 Foam::DsmcCloud<ParcelType>::linearKEBF()
 162 {
 163     return linearKE_.boundaryField();
 164 }
 165
 166
 167 template<class ParcelType>
 168 inline Foam::volScalarField::GeometricBoundaryField&
 169 Foam::DsmcCloud<ParcelType>::internalEBF()
 170 {
 171     return internalE_.boundaryField();
 172 }
 173
 174
 175 template<class ParcelType>
 176 inline Foam::volScalarField::GeometricBoundaryField&
 177 Foam::DsmcCloud<ParcelType>::iDofBF()
 178 {
 179     return iDof_.boundaryField();
 180 }
 181
 182
 183 template<class ParcelType>
 184 inline Foam::volVectorField::GeometricBoundaryField&
 185 Foam::DsmcCloud<ParcelType>::momentumBF()
 186 {
 187     return momentum_.boundaryField();
 188 }
 189
 190
 191 template<class ParcelType>
 192 inline const Foam::volScalarField&
 193 Foam::DsmcCloud<ParcelType>::boundaryT() const
 194 {
 195     return boundaryT_;
 196 }
 197
 198
 199 template<class ParcelType>
 200 inline const Foam::volVectorField&
 201 Foam::DsmcCloud<ParcelType>::boundaryU() const
 202 {
 203     return boundaryU_;
 204 }
 205
 206
 207 template<class ParcelType>
 208 inline const Foam::BinaryCollisionModel<Foam::DsmcCloud<ParcelType> >&
 209 Foam::DsmcCloud<ParcelType>::binaryCollision() const
 210 {
 211     return binaryCollisionModel_;
 212 }
 213
 214
 215 template<class ParcelType>
 216 inline Foam::BinaryCollisionModel<Foam::DsmcCloud<ParcelType> >&
 217 Foam::DsmcCloud<ParcelType>::binaryCollision()
 218 {
 219     return binaryCollisionModel_();
 220 }
 221
 222
 223 template<class ParcelType>
 224 inline const Foam::WallInteractionModel<Foam::DsmcCloud<ParcelType> >&
 225 Foam::DsmcCloud<ParcelType>::wallInteraction() const
 226 {
 227     return wallInteractionModel_;
 228 }
 229
 230
 231 template<class ParcelType>
 232 inline Foam::WallInteractionModel<Foam::DsmcCloud<ParcelType> >&
 233 Foam::DsmcCloud<ParcelType>::wallInteraction()
 234 {
 235     return wallInteractionModel_();
 236 }
 237
 238
 239 template<class ParcelType>
 240 inline const Foam::InflowBoundaryModel<Foam::DsmcCloud<ParcelType> >&
 241 Foam::DsmcCloud<ParcelType>::inflowBoundary() const
 242 {
 243     return inflowBoundaryModel_;
 244 }
 245
 246
 247 template<class ParcelType>
 248 inline Foam::InflowBoundaryModel<Foam::DsmcCloud<ParcelType> >&
 249 Foam::DsmcCloud<ParcelType>::inflowBoundary()
 250 {
 251     return inflowBoundaryModel_();
 252 }
 253
 254
 255 template<class ParcelType>
 256 inline Foam::scalar Foam::DsmcCloud<ParcelType>::massInSystem() const
 257 {
 258     scalar sysMass = 0.0;
 259
 260     forAllConstIter(typename DsmcCloud<ParcelType>, *this, iter)
 261     {
 262         const ParcelType& p = iter();
 263
 264         const typename ParcelType::constantProperties& cP = constProps
 265         (
 266             p.typeId()
 267         );
 268
 269         sysMass += cP.mass();
 270     }
 271
 272     return nParticle_*sysMass;
 273 }
 274
 275
 276 template<class ParcelType>
 277 inline Foam::vector Foam::DsmcCloud<ParcelType>::linearMomentumOfSystem() const
 278 {
 279     vector linearMomentum(vector::zero);
 280
 281     forAllConstIter(typename DsmcCloud<ParcelType>, *this, iter)
 282     {
 283         const ParcelType& p = iter();
 284
 285         const typename ParcelType::constantProperties& cP = constProps
 286         (
 287             p.typeId()
 288         );
 289
 290         linearMomentum += cP.mass()*p.U();
 291     }
 292
 293     return nParticle_*linearMomentum;
 294 }
 295
 296
 297 template<class ParcelType>
 298 inline Foam::scalar
 299 Foam::DsmcCloud<ParcelType>::linearKineticEnergyOfSystem() const
 300 {
 301     scalar linearKineticEnergy = 0.0;
 302
 303     forAllConstIter(typename DsmcCloud<ParcelType>, *this, iter)
 304     {
 305         const ParcelType& p = iter();
 306
 307         const typename ParcelType::constantProperties& cP = constProps
 308         (
 309             p.typeId()
 310         );
 311
 312         linearKineticEnergy += 0.5*cP.mass()*(p.U() & p.U());
 313     }
 314
 315     return nParticle_*linearKineticEnergy;
 316 }
 317
 318
 319 template<class ParcelType>
 320 inline Foam::scalar
 321 Foam::DsmcCloud<ParcelType>::internalEnergyOfSystem() const
 322 {
 323     scalar internalEnergy = 0.0;
 324
 325     forAllConstIter(typename DsmcCloud<ParcelType>, *this, iter)
 326     {
 327         const ParcelType& p = iter();
 328
 329         internalEnergy += p.Ei();
 330     }
 331
 332     return nParticle_*internalEnergy;
 333 }
 334
 335
 336 template<class ParcelType>
 337 inline Foam::scalar Foam::DsmcCloud<ParcelType>::maxwellianAverageSpeed
 338 (
 339     scalar temperature,
 340     scalar mass
 341 ) const
 342 {
 343     return
 344         2.0*sqrt(2.0*physicoChemical::k.value()*temperature/(pi*mass));
 345 }
 346
 347
 348 template<class ParcelType>
 349 inline Foam::scalarField Foam::DsmcCloud<ParcelType>::maxwellianAverageSpeed
 350 (
 351     scalarField temperature,
 352     scalar mass
 353 ) const
 354 {
 355     tmp<scalarField> tfld =
 356         2.0*sqrt(2.0*physicoChemical::k.value()*temperature/(pi*mass));
 357     return tfld();
 358 }
 359
 360
 361 template<class ParcelType>
 362 inline Foam::scalar Foam::DsmcCloud<ParcelType>::maxwellianRMSSpeed
 363 (
 364     scalar temperature,
 365     scalar mass
 366 ) const
 367 {
 368     return sqrt(3.0*physicoChemical::k.value()*temperature/mass);
 369 }
 370
 371
 372 template<class ParcelType>
 373 inline Foam::scalarField Foam::DsmcCloud<ParcelType>::maxwellianRMSSpeed
 374 (
 375     scalarField temperature,
 376     scalar mass
 377 ) const
 378 {
 379     tmp<scalarField> tfld =
 380         sqrt(3.0*physicoChemical::k.value()*temperature/mass);
 381     return tfld();
 382 }
 383
 384
 385 template<class ParcelType>
 386 inline Foam::scalar
 387 Foam::DsmcCloud<ParcelType>::maxwellianMostProbableSpeed
 388 (
 389     scalar temperature,
 390     scalar mass
 391 ) const
 392 {
 393     return sqrt(2.0*physicoChemical::k.value()*temperature/mass);
 394 }
 395
 396
 397 template<class ParcelType>
 398 inline Foam::scalarField
 399 Foam::DsmcCloud<ParcelType>::maxwellianMostProbableSpeed
 400 (
 401     scalarField temperature,
 402     scalar mass
 403 ) const
 404 {
 405     tmp<scalarField> tfld =
 406         sqrt(2.0*physicoChemical::k.value()*temperature/mass);
 407     return tfld();
 408 }
 409
 410
 411 template<class ParcelType>
 412 inline const Foam::volScalarField& Foam::DsmcCloud<ParcelType>::q() const
 413 {
 414     return q_;
 415 }
 416
 417
 418 template<class ParcelType>
 419 inline const Foam::volVectorField& Foam::DsmcCloud<ParcelType>::fD() const
 420 {
 421     return fD_;
 422 }
 423
 424
 425 template<class ParcelType>
 426 inline const Foam::volScalarField&
 427 Foam::DsmcCloud<ParcelType>::rhoN() const
 428 {
 429     return rhoN_;
 430 }
 431
 432
 433 template<class ParcelType>
 434 inline const Foam::volScalarField& Foam::DsmcCloud<ParcelType>::rhoM() const
 435 {
 436     return rhoM_;
 437 }
 438
 439
 440 template<class ParcelType>
 441 inline const Foam::volScalarField&
 442 Foam::DsmcCloud<ParcelType>::dsmcRhoN() const
 443 {
 444     return dsmcRhoN_;
 445 }
 446
 447
 448 template<class ParcelType>
 449 inline const Foam::volScalarField&
 450 Foam::DsmcCloud<ParcelType>::linearKE() const
 451 {
 452     return linearKE_;
 453 }
 454
 455
 456 template<class ParcelType>
 457 inline const Foam::volScalarField&
 458 Foam::DsmcCloud<ParcelType>::internalE() const
 459 {
 460     return internalE_;
 461 }
 462
 463
 464 template<class ParcelType>
 465 inline const Foam::volScalarField&
 466 Foam::DsmcCloud<ParcelType>::iDof() const
 467 {
 468     return iDof_;
 469 }
 470
 471
 472 template<class ParcelType>
 473 inline const Foam::volVectorField& Foam::DsmcCloud<ParcelType>::momentum() const
 474 {
 475     return momentum_;
 476 }
 477
 478
 479 template<class ParcelType>
 480 inline void Foam::DsmcCloud<ParcelType>::clear()
 481 {
 482     return IDLList<ParcelType>::clear();
 483 }
 484
 485
 486 // ************************************************************************* //