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) 2015-2018 OpenFOAM Foundation
9  Copyright (C) 2019-2022 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 
29 #include "surfaceTensionModel.H"
30 #include "phasePair.H"
31 
32 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
33 
34 namespace Foam
35 {
36 namespace reactingMultiphaseEuler
37 {
38  defineTypeNameAndDebug(surfaceTensionModel, 0);
39  defineRunTimeSelectionTable(surfaceTensionModel, dictionary);
40 }
41 }
42 
45 
46 
47 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
48 
50 (
51  const dictionary& dict,
52  const phasePair& pair,
53  const bool registerObject
54 )
55 :
57  (
58  IOobject
59  (
60  IOobject::groupName(typeName, pair.name()),
61  pair.phase1().mesh().time().timeName(),
62  pair.phase1().mesh(),
63  IOobject::NO_READ,
64  IOobject::NO_WRITE,
65  registerObject
66  )
67  ),
68  pair_(pair)
69 {}
70 
71 
72 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
73 
76 (
77  const dictionary& dict,
78  const phasePair& pair
79 )
80 {
81  const word modelType(dict.get<word>("type"));
82 
83  Info<< "Selecting surfaceTensionModel for "
84  << pair << ": " << modelType << endl;
85 
86  auto* ctorPtr = dictionaryConstructorTable(modelType);
87 
88  if (!ctorPtr)
89  {
91  (
92  dict,
93  "surfaceTensionModel",
94  modelType,
95  *dictionaryConstructorTablePtr_
96  ) << abort(FatalIOError);
97  }
98 
99  return ctorPtr(dict, pair, true);
100 }
101 
102 
103 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
104 
106 {
107  return os.good();
108 }
109 
110 
111 // ************************************************************************* //
dictionary dict
A list of keyword definitions, which are a keyword followed by a number of values (eg...
Definition: dictionary.H:129
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:531
word timeName
Definition: getTimeIndex.H:3
Dimension set for the base types, which can be used to implement rigorous dimension checking for alge...
Definition: dimensionSet.H:105
defineTypeNameAndDebug(surfaceTensionModel, 0)
dynamicFvMesh & mesh
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for expressions::valueTypeCode::INVALID.
Definition: exprTraits.C:127
A class for handling words, derived from Foam::string.
Definition: word.H:63
errorManip< error > abort(error &err)
Definition: errorManip.H:139
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:56
surfaceTensionModel(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
phaseModel & phase1
OBJstream os(runTime.globalPath()/outputName)
static const dimensionSet dimSigma
Coefficient dimensions.
defineRunTimeSelectionTable(surfaceTensionModel, dictionary)
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:66
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
static autoPtr< surfaceTensionModel > New(const dictionary &dict, const phasePair &pair)
Defines the attributes of an object for which implicit objectRegistry management is supported...
Definition: IOobject.H:172
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:635
bool writeData(Ostream &os) const
Dummy write for regIOobject.
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:49
Namespace for OpenFOAM.
IOerror FatalIOError
Error stream (stdout output on all processes), with additional &#39;FOAM FATAL IO ERROR&#39; header text and ...