All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
displacedPhaseInterface.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) 2021-2023 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 
28 
29 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
30 
31 namespace Foam
32 {
34  (
36  separatorsToTypeName
37  ({
39  separator()
40  }).c_str(),
41  0
42  );
44 }
45 
46 
47 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
48 
50 (
51  const phaseModel& phase1,
52  const phaseModel& phase2,
53  const phaseModel& displacing
54 )
55 :
56  phaseInterface(phase1, phase2),
57  displacing_(displacing)
58 {}
59 
60 
62 (
63  const phaseSystem& fluid,
64  const word& name
65 )
66 :
67  phaseInterface(fluid, name),
68  displacing_(identifyPhases(fluid, name, {separator()}).second())
69 {
70  if (contains(displacing_))
71  {
73  << "Interface " << name << " is not valid. An interface cannot "
74  << "be displaced by one of its own phases." << exit(FatalError);
75  }
76 }
77 
78 
79 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
80 
82 {}
83 
84 
85 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
86 
88 {
89  return
91  + '_'
92  + separator()
93  + '_'
94  + displacing().name();
95 }
96 
97 
99 {
100  return displacing_;
101 }
102 
103 
104 // ************************************************************************* //
Macros for easy insertion into run-time selection tables.
Class to represent an interface between phases which has been displaced to some extent by a third pha...
displacedPhaseInterface(const phaseModel &phase1, const phaseModel &phase2, const phaseModel &displacing)
Construct from phases.
virtual ~displacedPhaseInterface()
Destructor.
static word separator()
Return the separator that delimits this interface's name.
virtual word name() const
Name.
const phaseModel & displacing() const
Displacing phase.
Class to represent an interface between phases. Derivations can further specify the configuration of ...
static word separator()
Return the separator that delimits this interface's name.
virtual word name() const
Name.
Class to represent a system of phases and model interfacial transfers between them.
Definition: phaseSystem.H:73
A class for handling words, derived from string.
Definition: word.H:62
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:334
Namespace for OpenFOAM.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
addToRunTimeSelectionTable(polyPatch, mergedCyclicPolyPatch, word)
word name(const bool)
Return a word representation of a bool.
Definition: boolIO.C:39
defineTypeNameAndDebugWithName(dispersedDisplacedPhaseInterface, separatorsToTypeName({ dispersedPhaseInterface::separator(), displacedPhaseInterface::separator() }).c_str(), 0)
labelList second(const UList< labelPair > &p)
Definition: patchToPatch.C:49
error FatalError