src/lagrangian/intermediate/parcels/Templates/ReactingMultiphaseParcel/ReactingMultiphaseParcelI.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   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 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  27
  28 template<class ParcelType>
  29 inline Foam::ReactingMultiphaseParcel<ParcelType>::constantProperties::
  30 constantProperties()
  31 :
  32     ParcelType::constantProperties(),
  33     LDevol_(0.0),
  34     hRetentionCoeff_(0.0)
  35 {}
  36
  37
  38 template<class ParcelType>
  39 inline Foam::ReactingMultiphaseParcel<ParcelType>::constantProperties::
  40 constantProperties
  41 (
  42     const constantProperties& cp
  43 )
  44 :
  45     ParcelType::constantProperties(cp),
  46     LDevol_(cp.LDevol_),
  47     hRetentionCoeff_(cp.hRetentionCoeff_)
  48 {}
  49
  50
  51 template<class ParcelType>
  52 inline Foam::ReactingMultiphaseParcel<ParcelType>::constantProperties::
  53 constantProperties
  54 (
  55     const dictionary& parentDict,
  56     const bool readFields
  57 )
  58 :
  59     ParcelType::constantProperties(parentDict, readFields),
  60     LDevol_(0.0),
  61     hRetentionCoeff_(0.0)
  62 {
  63     if (readFields)
  64     {
  65         this->dict().lookup("LDevol") >> LDevol_;
  66         this->dict().lookup("hRetentionCoeff") >> hRetentionCoeff_;
  67
  68         if ((hRetentionCoeff_ < 0) || (hRetentionCoeff_ > 1))
  69         {
  70             FatalErrorIn
  71             (
  72                 "ReactingMultiphaseParcel<ParcelType>::constantProperties::"
  73                 "constantProperties"
  74             )   << "hRetentionCoeff must be in the range 0 to 1" << nl
  75                 << exit(FatalError) << endl;
  76         }
  77
  78         hRetentionCoeff_ = max(1e-06, hRetentionCoeff_);
  79     }
  80 }
  81
  82
  83 template<class ParcelType>
  84 inline Foam::ReactingMultiphaseParcel<ParcelType>::ReactingMultiphaseParcel
  85 (
  86     const polyMesh& mesh,
  87     const vector& position,
  88     const label cellI,
  89     const label tetFaceI,
  90     const label tetPtI
  91 )
  92 :
  93     ParcelType(mesh, position, cellI, tetFaceI, tetPtI),
  94     YGas_(0),
  95     YLiquid_(0),
  96     YSolid_(0),
  97     canCombust_(false)
  98 {}
  99
 100
 101 template<class ParcelType>
 102 inline Foam::ReactingMultiphaseParcel<ParcelType>::ReactingMultiphaseParcel
 103 (
 104     const polyMesh& mesh,
 105     const vector& position,
 106     const label cellI,
 107     const label tetFaceI,
 108     const label tetPtI,
 109     const label typeId,
 110     const scalar nParticle0,
 111     const scalar d0,
 112     const scalar dTarget0,
 113     const vector& U0,
 114     const vector& f0,
 115     const vector& angularMomentum0,
 116     const vector& torque0,
 117     const scalarField& Y0,
 118     const scalarField& YGas0,
 119     const scalarField& YLiquid0,
 120     const scalarField& YSolid0,
 121     const constantProperties& constProps
 122 )
 123 :
 124     ParcelType
 125     (
 126         mesh,
 127         position,
 128         cellI,
 129         tetFaceI,
 130         tetPtI,
 131         typeId,
 132         nParticle0,
 133         d0,
 134         dTarget0,
 135         U0,
 136         f0,
 137         angularMomentum0,
 138         torque0,
 139         Y0,
 140         constProps
 141     ),
 142     YGas_(YGas0),
 143     YLiquid_(YLiquid0),
 144     YSolid_(YSolid0),
 145     canCombust_(false)
 146 {}
 147
 148
 149 // * * * * * * * * * constantProperties Member Functions * * * * * * * * * * //
 150
 151 template<class ParcelType>
 152 inline Foam::scalar
 153 Foam::ReactingMultiphaseParcel<ParcelType>::constantProperties::LDevol() const
 154 {
 155     return LDevol_;
 156 }
 157
 158
 159 template<class ParcelType>
 160 inline Foam::scalar
 161 Foam::ReactingMultiphaseParcel<ParcelType>::constantProperties::
 162 hRetentionCoeff() const
 163 {
 164     return hRetentionCoeff_;
 165 }
 166
 167
 168 // * * * * * * * * * * ThermoParcel Member Functions * * * * * * * * * * * * //
 169
 170 template<class ParcelType>
 171 inline const Foam::scalarField& Foam::ReactingMultiphaseParcel<ParcelType>::
 172 YGas() const
 173 {
 174     return YGas_;
 175 }
 176
 177
 178 template<class ParcelType>
 179 inline const Foam::scalarField& Foam::ReactingMultiphaseParcel<ParcelType>::
 180 YLiquid() const
 181 {
 182     return YLiquid_;
 183 }
 184
 185
 186 template<class ParcelType>
 187 inline const Foam::scalarField& Foam::ReactingMultiphaseParcel<ParcelType>::
 188 YSolid() const
 189 {
 190     return YSolid_;
 191 }
 192
 193
 194 template<class ParcelType>
 195 inline bool Foam::ReactingMultiphaseParcel<ParcelType>::canCombust() const
 196 {
 197     return canCombust_;
 198 }
 199
 200
 201 template<class ParcelType>
 202 inline Foam::scalarField& Foam::ReactingMultiphaseParcel<ParcelType>::YGas()
 203 {
 204     return YGas_;
 205 }
 206
 207
 208 template<class ParcelType>
 209 inline Foam::scalarField& Foam::ReactingMultiphaseParcel<ParcelType>::YLiquid()
 210 {
 211     return YLiquid_;
 212 }
 213
 214
 215 template<class ParcelType>
 216 inline Foam::scalarField& Foam::ReactingMultiphaseParcel<ParcelType>::YSolid()
 217 {
 218     return YSolid_;
 219 }
 220
 221
 222 template<class ParcelType>
 223 inline bool& Foam::ReactingMultiphaseParcel<ParcelType>::canCombust()
 224 {
 225     return canCombust_;
 226 }
 227
 228
 229 // ************************************************************************* //