ConstantRateDevolatilisation.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 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 
27 
28 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
29 
30 template<class CloudType>
32 (
33  const dictionary& dict,
34  CloudType& owner
35 )
36 :
37  DevolatilisationModel<CloudType>(dict, owner, typeName),
38  volatileData_(this->coeffDict().lookup("volatileData")),
39  YVolatile0_(volatileData_.size()),
40  volatileToGasMap_(volatileData_.size()),
41  residualCoeff_(this->coeffDict().template lookup<scalar>("residualCoeff"))
42 {
43  if (volatileData_.empty())
44  {
46  << "Devolatilisation model selected, but no volatiles defined"
47  << nl << endl;
48  }
49  else
50  {
51  Info<< "Participating volatile species:" << endl;
52 
53  // Determine mapping between active volatiles and cloud gas components
54  const label idGas = owner.composition().idGas();
55  const scalar YGasTot = owner.composition().YMixture0()[idGas];
56  const scalarField& YGas = owner.composition().Y0(idGas);
57  forAll(volatileData_, i)
58  {
59  const word& specieName = volatileData_[i].first();
60  const label id = owner.composition().localId(idGas, specieName);
61  volatileToGasMap_[i] = id;
62  YVolatile0_[i] = YGasTot*YGas[id];
63 
64  Info<< " " << specieName << ": particle mass fraction = "
65  << YVolatile0_[i] << endl;
66  }
67  }
68 }
69 
70 
71 template<class CloudType>
73 (
75 )
76 :
78  volatileData_(dm.volatileData_),
79  YVolatile0_(dm.YVolatile0_),
80  volatileToGasMap_(dm.volatileToGasMap_),
81  residualCoeff_(dm.residualCoeff_)
82 {}
83 
84 
85 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
86 
87 template<class CloudType>
89 {}
90 
91 
92 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
93 
94 template<class CloudType>
96 (
97  const scalar dt,
98  const scalar age,
99  const scalar mass0,
100  const scalar mass,
101  const scalar T,
102  const scalarField& YGasEff,
103  const scalarField& YLiquidEff,
104  const scalarField& YSolidEff,
105  label& canCombust,
106  scalarField& dMassDV
107 ) const
108 {
109  bool done = true;
110  forAll(volatileData_, i)
111  {
112  const label id = volatileToGasMap_[i];
113  const scalar massVolatile0 = mass0*YVolatile0_[i];
114  const scalar massVolatile = mass*YGasEff[id];
115 
116  // Combustion allowed once all volatile components evolved
117  done = done && (massVolatile <= residualCoeff_*massVolatile0);
118 
119  // Model coefficients
120  const scalar A0 = volatileData_[i].second();
121 
122  // Mass transferred from particle to carrier gas phase
123  dMassDV[id] = min(dt*A0*massVolatile0, massVolatile);
124  }
125 
126  if (done && canCombust != -1)
127  {
128  canCombust = 1;
129  }
130 }
131 
132 
133 // ************************************************************************* //
virtual void calculate(const scalar dt, const scalar age, const scalar mass0, const scalar mass, const scalar T, const scalarField &YGasEff, const scalarField &YLiquidEff, const scalarField &YSolidEff, label &canCombust, scalarField &dMassDV) const
Update model.
dictionary dict
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
ConstantRateDevolatilisation(const dictionary &dict, CloudType &owner)
Construct from dictionary.
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
Constant rate devolatisation model.
A class for handling words, derived from string.
Definition: word.H:59
static const char nl
Definition: Ostream.H:260
dimensioned< Type > min(const dimensioned< Type > &, const dimensioned< Type > &)
#define WarningInFunction
Report a warning using Foam::Warning.
messageStream Info
Templated devolatilisation model class.
Templated base class for dsmc cloud.
Definition: DSMCCloud.H:75