surfaceTensionModel.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) 2017-2020 OpenCFD Ltd.
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 \*---------------------------------------------------------------------------*/
27 
28 #include "surfaceTensionModel.H"
29 #include "phasePair.H"
30 
31 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32 
33 namespace Foam
34 {
35  defineTypeNameAndDebug(surfaceTensionModel, 0);
36  defineRunTimeSelectionTable(surfaceTensionModel, dictionary);
37 }
38 
39 
40 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
41 
43 (
44  const dictionary& dict,
45  const phasePair& pair,
46  const bool registerObject
47 )
48 :
50  (
51  IOobject
52  (
53  IOobject::groupName(typeName, pair.name()),
54  pair.phase1().mesh().time().timeName(),
55  pair.phase1().mesh(),
56  IOobject::NO_READ,
57  IOobject::NO_WRITE,
58  registerObject
59  )
60  ),
61  pair_(pair)
62 {}
63 
64 
65 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
66 
69 (
70  const dictionary& dict,
71  const phasePair& pair
72 )
73 {
74  const word modelType(dict.get<word>("type"));
75 
76  Info<< "Selecting surfaceTensionModel for "
77  << pair << ": " << modelType << endl;
78 
79  const auto cstrIter = dictionaryConstructorTablePtr_->cfind(modelType);
80 
81  if (!cstrIter.found())
82  {
84  (
85  dict,
86  "surfaceTensionModel",
87  modelType,
88  *dictionaryConstructorTablePtr_
89  ) << exit(FatalIOError);
90  }
91 
92  return cstrIter()(dict, pair, true);
93 }
94 
95 
96 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
97 
99 {
100  return os.good();
101 }
102 
103 
104 // ************************************************************************* //
Foam::surfaceTensionModel::surfaceTensionModel
surfaceTensionModel(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
Definition: surfaceTensionModel.C:43
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:104
Foam::phasePair
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:53
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:62
surfaceTensionModel.H
Foam::defineRunTimeSelectionTable
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:350
Foam::surfaceTensionModel::writeData
bool writeData(Ostream &os) const
Dummy write for regIOobject.
Definition: surfaceTensionModel.C:98
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:406
Foam::surfaceTensionModel::New
static autoPtr< surfaceTensionModel > New(const dictionary &dict, const phasePair &pair)
Definition: surfaceTensionModel.C:69
Foam::Info
messageStream Info
Information stream (uses stdout - output is on the master only)
dict
dictionary dict
Definition: searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
Foam::autoPtr< Foam::surfaceTensionModel >
Foam::regIOobject
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:71
Foam::phasePair::name
virtual word name() const
Pair name.
Definition: phasePair.C:69
Foam::Ostream
An Ostream is an abstract base class for all output systems (streams, files, token lists,...
Definition: Ostream.H:56
Foam::IOstream::good
bool good() const
Return true if next operation might succeed.
Definition: IOstream.H:224
Foam::phasePair::phase1
const phaseModel & phase1() const
Definition: phasePairI.H:30
Foam::defineTypeNameAndDebug
defineTypeNameAndDebug(combustionModel, 0)