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