src/lagrangian/intermediate/clouds/Templates/KinematicCloud/KinematicCloudI.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 #include "fvmSup.H"
  28
  29 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  30
  31 template<class ParcelType>
  32 inline Foam::label Foam::KinematicCloud<ParcelType>::parcelTypeId() const
  33 {
  34     return parcelTypeId_;
  35 }
  36
  37
  38 template<class ParcelType>
  39 inline const Foam::fvMesh& Foam::KinematicCloud<ParcelType>::mesh() const
  40 {
  41     return mesh_;
  42 }
  43
  44
  45 template<class ParcelType>
  46 inline const Foam::IOdictionary&
  47 Foam::KinematicCloud<ParcelType>::particleProperties() const
  48 {
  49     return particleProperties_;
  50 }
  51
  52
  53 template<class ParcelType>
  54 inline const typename ParcelType::constantProperties&
  55 Foam::KinematicCloud<ParcelType>::constProps() const
  56 {
  57     return constProps_;
  58 }
  59
  60
  61 template<class ParcelType>
  62 inline const Foam::Switch Foam::KinematicCloud<ParcelType>::coupled() const
  63 {
  64     return coupled_;
  65 }
  66
  67
  68 template <class ParcelType>
  69 inline const Foam::Switch
  70 Foam::KinematicCloud<ParcelType>::cellValueSourceCorrection() const
  71 {
  72     return cellValueSourceCorrection_;
  73 }
  74
  75
  76 template<class ParcelType>
  77 inline const Foam::volScalarField&
  78 Foam::KinematicCloud<ParcelType>::rho() const
  79 {
  80     return rho_;
  81 }
  82
  83
  84 template<class ParcelType>
  85 inline const Foam::volVectorField& Foam::KinematicCloud<ParcelType>::U() const
  86 {
  87     return U_;
  88 }
  89
  90
  91 template<class ParcelType>
  92 inline const Foam::volScalarField& Foam::KinematicCloud<ParcelType>::mu() const
  93 {
  94     return mu_;
  95 }
  96
  97
  98 template<class ParcelType>
  99 inline const Foam::dimensionedVector&
 100 Foam::KinematicCloud<ParcelType>::g() const
 101 {
 102     return g_;
 103 }
 104
 105
 106 template<class ParcelType>
 107 inline const Foam::particleForces&
 108 Foam::KinematicCloud<ParcelType>::forces() const
 109 {
 110     return forces_;
 111 }
 112
 113
 114 template<class ParcelType>
 115 inline const Foam::dictionary&
 116 Foam::KinematicCloud<ParcelType>::interpolationSchemes() const
 117 {
 118     return interpolationSchemes_;
 119 }
 120
 121
 122 template<class ParcelType>
 123 inline const Foam::DispersionModel<Foam::KinematicCloud<ParcelType> >&
 124 Foam::KinematicCloud<ParcelType>::dispersion() const
 125 {
 126     return dispersionModel_;
 127 }
 128
 129
 130 template<class ParcelType>
 131 inline Foam::DispersionModel<Foam::KinematicCloud<ParcelType> >&
 132 Foam::KinematicCloud<ParcelType>::dispersion()
 133 {
 134     return dispersionModel_();
 135 }
 136
 137
 138 template<class ParcelType>
 139 inline const Foam::DragModel<Foam::KinematicCloud<ParcelType> >&
 140 Foam::KinematicCloud<ParcelType>::drag() const
 141 {
 142     return dragModel_;
 143 }
 144
 145
 146 template<class ParcelType>
 147 inline const Foam::InjectionModel<Foam::KinematicCloud<ParcelType> >&
 148 Foam::KinematicCloud<ParcelType>::injection() const
 149 {
 150     return injectionModel_;
 151 }
 152
 153
 154 template<class ParcelType>
 155 inline const Foam::PatchInteractionModel<Foam::KinematicCloud<ParcelType> >&
 156 Foam::KinematicCloud<ParcelType>::patchInteraction() const
 157 {
 158     return patchInteractionModel_;
 159 }
 160
 161
 162 template<class ParcelType>
 163 inline Foam::InjectionModel<Foam::KinematicCloud<ParcelType> >&
 164 Foam::KinematicCloud<ParcelType>::injection()
 165 {
 166     return injectionModel_();
 167 }
 168
 169
 170 template<class ParcelType>
 171 inline Foam::PostProcessingModel<Foam::KinematicCloud<ParcelType> >&
 172 Foam::KinematicCloud<ParcelType>::postProcessing()
 173 {
 174     return postProcessingModel_();
 175 }
 176
 177
 178 template<class ParcelType>
 179 inline const Foam::vectorIntegrationScheme&
 180 Foam::KinematicCloud<ParcelType>::UIntegrator() const
 181 {
 182     return UIntegrator_;
 183 }
 184
 185
 186 template<class ParcelType>
 187 inline Foam::scalar Foam::KinematicCloud<ParcelType>::massInSystem() const
 188 {
 189     scalar sysMass = 0.0;
 190     forAllConstIter(typename KinematicCloud<ParcelType>, *this, iter)
 191     {
 192          const ParcelType& p = iter();
 193          sysMass += p.mass()*p.nParticle();
 194     }
 195
 196     return sysMass;
 197 }
 198
 199
 200 template<class ParcelType>
 201 inline Foam::Random& Foam::KinematicCloud<ParcelType>::rndGen()
 202 {
 203     return rndGen_;
 204 }
 205
 206
 207 template<class ParcelType>
 208 inline Foam::DimensionedField<Foam::vector, Foam::volMesh>&
 209 Foam::KinematicCloud<ParcelType>::UTrans()
 210 {
 211     return UTrans_;
 212 }
 213
 214
 215 template<class ParcelType>
 216 inline Foam::tmp<Foam::DimensionedField<Foam::vector, Foam::volMesh> >
 217 Foam::KinematicCloud<ParcelType>::SU() const
 218 {
 219     tmp<DimensionedField<vector, volMesh> > tSU
 220     (
 221         new DimensionedField<vector, volMesh>
 222         (
 223             IOobject
 224             (
 225                 this->name() + "SU",
 226                 this->db().time().timeName(),
 227                 this->mesh(),
 228                 IOobject::NO_READ,
 229                 IOobject::AUTO_WRITE
 230             ),
 231             this->mesh(),
 232             dimensionedVector
 233             (
 234                  "zero",
 235                  dimDensity*dimVelocity/dimTime,
 236                  vector::zero
 237             )
 238         )
 239     );
 240
 241     vectorField& SU = tSU().field();
 242     SU = UTrans_/(mesh_.V()*this->db().time().deltaT());
 243
 244     return tSU;
 245 }
 246
 247
 248 template<class ParcelType>
 249 inline const Foam::tmp<Foam::volScalarField>
 250 Foam::KinematicCloud<ParcelType>::theta() const
 251 {
 252     tmp<volScalarField> ttheta
 253     (
 254         new volScalarField
 255         (
 256             IOobject
 257             (
 258                 this->name() + "Theta",
 259                 this->db().time().timeName(),
 260                 this->db(),
 261                 IOobject::NO_READ,
 262                 IOobject::NO_WRITE,
 263                 false
 264             ),
 265             mesh_,
 266             dimensionedScalar("zero", dimless, 0.0)
 267         )
 268     );
 269
 270     scalarField& theta = ttheta().internalField();
 271     forAllConstIter(typename KinematicCloud<ParcelType>, *this, iter)
 272     {
 273         const ParcelType& p = iter();
 274         const label cellI = p.cell();
 275
 276         theta[cellI] += p.nParticle()*p.volume();
 277     }
 278
 279     theta /= mesh().V();
 280
 281     return ttheta;
 282 }
 283
 284
 285 template<class ParcelType>
 286 inline const Foam::tmp<Foam::volScalarField>
 287 Foam::KinematicCloud<ParcelType>::alpha() const
 288 {
 289     tmp<volScalarField> talpha
 290     (
 291         new volScalarField
 292         (
 293             IOobject
 294             (
 295                 this->name() + "Alpha",
 296                 this->db().time().timeName(),
 297                 this->db(),
 298                 IOobject::NO_READ,
 299                 IOobject::NO_WRITE,
 300                 false
 301             ),
 302             mesh_,
 303             dimensionedScalar("zero", dimless, 0.0)
 304         )
 305     );
 306
 307     scalarField& alpha = talpha().internalField();
 308     forAllConstIter(typename KinematicCloud<ParcelType>, *this, iter)
 309     {
 310         const ParcelType& p = iter();
 311         const label cellI = p.cell();
 312
 313         alpha[cellI] += p.nParticle()*p.mass();
 314     }
 315
 316     alpha /= (mesh().V()*rho_);
 317
 318     return talpha;
 319 }
 320
 321
 322 template<class ParcelType>
 323 inline const Foam::tmp<Foam::volScalarField>
 324 Foam::KinematicCloud<ParcelType>::rhoEff() const
 325 {
 326     tmp<volScalarField> trhoEff
 327     (
 328         new volScalarField
 329         (
 330             IOobject
 331             (
 332                 this->name() + "RhoEff",
 333                 this->db().time().timeName(),
 334                 this->db(),
 335                 IOobject::NO_READ,
 336                 IOobject::NO_WRITE,
 337                 false
 338             ),
 339             mesh_,
 340             dimensionedScalar("zero", dimDensity, 0.0)
 341         )
 342     );
 343
 344     scalarField& rhoEff = trhoEff().internalField();
 345     forAllConstIter(typename KinematicCloud<ParcelType>, *this, iter)
 346     {
 347         const ParcelType& p = iter();
 348         const label cellI = p.cell();
 349
 350         rhoEff[cellI] += p.nParticle()*p.mass();
 351     }
 352
 353     rhoEff /= mesh().V();
 354
 355     return trhoEff;
 356 }
 357
 358
 359 // ************************************************************************* //