All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
basicSpecieMixture.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) 2014-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 
26 #include "basicSpecieMixture.H"
27 
28 // * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  defineTypeNameAndDebug(basicSpecieMixture, 0);
33 }
34 
35 
36 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
37 
39 (
40  const dictionary& thermoDict,
41  const wordList& specieNames,
42  const fvMesh& mesh,
43  const word& phaseName
44 )
45 :
46  basicMixture(thermoDict, mesh, phaseName),
47  species_(specieNames),
48  active_(species_.size(), true),
49  Y_(species_.size())
50 {
51  tmp<volScalarField> tYdefault;
52 
53  forAll(species_, i)
54  {
55  IOobject header
56  (
57  IOobject::groupName(species_[i], phaseName),
58  mesh.time().timeName(),
59  mesh,
61  );
62 
63  // check if field exists and can be read
64  if (header.typeHeaderOk<volScalarField>(true))
65  {
66  Y_.set
67  (
68  i,
69  new volScalarField
70  (
71  IOobject
72  (
73  IOobject::groupName(species_[i], phaseName),
74  mesh.time().timeName(),
75  mesh,
78  ),
79  mesh
80  )
81  );
82  }
83  else
84  {
85  // Read Ydefault if not already read
86  if (!tYdefault.valid())
87  {
88  word YdefaultName(IOobject::groupName("Ydefault", phaseName));
89 
90  IOobject timeIO
91  (
92  YdefaultName,
93  mesh.time().timeName(),
94  mesh,
97  );
98 
99  IOobject constantIO
100  (
101  YdefaultName,
102  mesh.time().constant(),
103  mesh,
106  );
107 
108  IOobject time0IO
109  (
110  YdefaultName,
111  Time::timeName(0),
112  mesh,
113  IOobject::MUST_READ,
115  );
116 
117  if (timeIO.typeHeaderOk<volScalarField>(true))
118  {
119  tYdefault = new volScalarField(timeIO, mesh);
120  }
121  else if (constantIO.typeHeaderOk<volScalarField>(true))
122  {
123  tYdefault = new volScalarField(constantIO, mesh);
124  }
125  else
126  {
127  tYdefault = new volScalarField(time0IO, mesh);
128  }
129  }
130 
131  Y_.set
132  (
133  i,
134  new volScalarField
135  (
136  IOobject
137  (
138  IOobject::groupName(species_[i], phaseName),
139  mesh.time().timeName(),
140  mesh,
143  ),
144  tYdefault()
145  )
146  );
147  }
148  }
149 
150  // Do not enforce constraint of sum of mass fractions to equal 1 here
151  // - not applicable to all models
152 }
153 
154 
155 // ************************************************************************* //
#define forAll(list, i)
Loop across all elements in list.
Definition: UList.H:434
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:158
static word timeName(const scalar, const int precision=precision_)
Return time name of given scalar time.
Definition: Time.C:622
const Time & time() const
Return the top-level database.
Definition: fvMesh.H:239
virtual word timeName() const
Return current time name.
Definition: Time.C:632
GeometricField< scalar, fvPatchField, volMesh > volScalarField
Definition: volFieldsFwd.H:57
dynamicFvMesh & mesh
bool valid() const
Is this temporary object valid,.
Definition: tmpI.H:160
A class for handling words, derived from string.
Definition: word.H:59
static word groupName(Name name, const word &group)
const word & constant() const
Return constant name.
Definition: TimePaths.H:124
Foam::basicMixture.
Definition: basicMixture.H:50
defineTypeNameAndDebug(combustionModel, 0)
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A class for managing temporary objects.
Definition: PtrList.H:53
IOobject defines the attributes of an object for which implicit objectRegistry management is supporte...
Definition: IOobject.H:92
basicSpecieMixture(const dictionary &, const wordList &specieNames, const fvMesh &, const word &)
Construct from dictionary, species names, mesh and phase name.
Namespace for OpenFOAM.