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-2021 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 namespace multiphaseInter
36 {
37  defineTypeNameAndDebug(surfaceTensionModel, 0);
38  defineRunTimeSelectionTable(surfaceTensionModel, dictionary);
39 }
40 }
41 
42 
43 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
44 
46 (
47  const dictionary& dict,
48  const phasePair& pair,
49  const bool registerObject
50 )
51 :
53  (
54  IOobject
55  (
56  IOobject::groupName(typeName, pair.name()),
57  pair.phase1().mesh().time().timeName(),
58  pair.phase1().mesh(),
59  IOobject::NO_READ,
60  IOobject::NO_WRITE,
61  registerObject
62  )
63  ),
64  pair_(pair)
65 {}
66 
67 
68 // * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
69 
72 (
73  const dictionary& dict,
74  const phasePair& pair
75 )
76 {
77  const word modelType(dict.get<word>("type"));
78 
79  Info<< "Selecting surfaceTensionModel for "
80  << pair << ": " << modelType << endl;
81 
82  auto* ctorPtr = dictionaryConstructorTable(modelType);
83 
84  if (!ctorPtr)
85  {
87  (
88  dict,
89  "surfaceTensionModel",
90  modelType,
91  *dictionaryConstructorTablePtr_
92  ) << exit(FatalIOError);
93  }
94 
95  return ctorPtr(dict, pair, true);
96 }
97 
98 
99 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
100 
102 {
103  return os.good();
104 }
105 
106 
107 // ************************************************************************* //
Foam::IOobject
Defines the attributes of an object for which implicit objectRegistry management is supported,...
Definition: IOobject.H:169
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:65
surfaceTensionModel.H
Foam::FatalIOError
IOerror FatalIOError
Foam::endl
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:369
Foam::multiphaseInter::surfaceTensionModel::New
static autoPtr< surfaceTensionModel > New(const dictionary &dict, const phasePair &pair)
Definition: surfaceTensionModel.C:72
FatalIOErrorInLookup
#define FatalIOErrorInLookup(ios, lookupTag, lookupName, lookupTable)
Report an error message using Foam::FatalIOError.
Definition: error.H:478
Foam::Info
messageStream Info
Information stream (stdout output on master, null elsewhere)
Foam::multiphaseInter::surfaceTensionModel::surfaceTensionModel
surfaceTensionModel(const dictionary &dict, const phasePair &pair, const bool registerObject)
Construct from a dictionary and a phase pair.
Definition: surfaceTensionModel.C:46
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:123
os
OBJstream os(runTime.globalPath()/outputName)
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
Pointer management similar to std::unique_ptr, with some additional methods and type checking.
Definition: HashPtrTable.H:53
Foam::regIOobject
regIOobject is an abstract class derived from IOobject to handle automatic object registration with t...
Definition: regIOobject.H:73
Foam::multiphaseInter::defineTypeNameAndDebug
defineTypeNameAndDebug(surfaceTensionModel, 0)
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::phasePair::phase1
const phaseModel & phase1() const
Definition: phasePairI.H:30
Foam::multiphaseInter::surfaceTensionModel::writeData
bool writeData(Ostream &os) const
Dummy write for regIOobject.
Definition: surfaceTensionModel.C:101
Foam::multiphaseInter::defineRunTimeSelectionTable
defineRunTimeSelectionTable(surfaceTensionModel, dictionary)