interfaceCompositionModel.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2015-2018 OpenFOAM Foundation
9  Copyright (C) 2021 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 \*---------------------------------------------------------------------------*/
28 
30 #include "phaseModel.H"
31 #include "phasePair.H"
32 
33 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
34 
35 namespace Foam
36 {
37  defineTypeNameAndDebug(interfaceCompositionModel, 0);
38  defineRunTimeSelectionTable(interfaceCompositionModel, dictionary);
39 }
40 
41 
42 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
43 
45 (
46  const dictionary& dict,
47  const phasePair& pair
48 )
49 :
50  pair_(pair),
51  speciesNames_(dict.lookup("species"))
52 {}
53 
54 
55 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
56 
59 (
60  const dictionary& dict,
61  const phasePair& pair
62 )
63 {
64  const word modelType
65  (
66  dict.get<word>("type")
67  + "<"
68  + pair.phase1().thermo().type()
69  + ","
70  + pair.phase2().thermo().type()
71  + ">"
72  );
73 
74  Info<< "Selecting interfaceCompositionModel for "
75  << pair << ": " << modelType << endl;
76 
77  auto* ctorPtr = dictionaryConstructorTable(modelType);
78 
79  if (!ctorPtr)
80  {
82  (
83  dict,
84  "interfaceCompositionModel",
85  modelType,
86  *dictionaryConstructorTablePtr_
87  ) << abort(FatalIOError);
88  }
89 
90  return ctorPtr(dict, pair);
91 }
92 
93 
94 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
95 
96 bool Foam::interfaceCompositionModel::transports(word& speciesName) const
97 {
98  return this->speciesNames_.found(speciesName);
99 }
100 
101 
102 // ************************************************************************* //
dictionary dict
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
T get(const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
Find and return a T. FatalIOError if not found, or if the number of tokens is incorrect.
A class for handling words, derived from Foam::string.
Definition: word.H:63
interfaceCompositionModel(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and a phase pair.
errorManip< error > abort(error &err)
Definition: errorManip.H:139
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
static autoPtr< interfaceCompositionModel > New(const dictionary &dict, const phasePair &pair)
messageStream Info
Information stream (stdout output on master, null elsewhere)
Pointer management similar to std::unique_ptr, with some additional methods and type checking...
Definition: HashPtrTable.H:48
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:635
Namespace for OpenFOAM.
IOerror FatalIOError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL IO ERROR&#39; header text and ...