sidedPhaseInterface.H
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-2022 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 Class
25  Foam::sidedPhaseInterface
26 
27 Description
28  Class to represent a certain side of an interface between phases.
29 
30 SourceFiles
31  sidedPhaseInterface.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef sidedPhaseInterface_H
36 #define sidedPhaseInterface_H
37 
38 #include "phaseInterface.H"
39 
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
41 
42 namespace Foam
43 {
44 
45 /*---------------------------------------------------------------------------*\
46  Class sidedPhaseInterface Declaration
47 \*---------------------------------------------------------------------------*/
48 
50 :
51  virtual public phaseInterface
52 {
53 private:
54 
55  // Private Data
56 
57  //- Phase
58  const phaseModel& phase_;
59 
60 
61 public:
62 
63  //- Runtime type information
64  TypeName("sidedPhaseInterface");
65 
66 
67  // Constructors
68 
69  //- Construct from phases
71  (
72  const phaseModel& phase,
73  const phaseModel& otherPhase
74  );
75 
76  //- Construct from fluid and name
78  (
79  const phaseSystem& fluid,
80  const word& name
81  );
82 
83 
84  //- Destructor
85  virtual ~sidedPhaseInterface();
86 
87 
88  // Static Member Functions
89 
90  //- Return the separator that delimits this interface's name
91  static word separator()
92  {
93  return "inThe";
94  }
95 
96 
97  // Member Functions
98 
99  //- Name
100  virtual word name() const;
101 
102 
103  // Access
104 
105  //- Phase on the this side of the interface
106  const phaseModel& phase() const;
107 
108  //- Phase on the other side of the interface
109  const phaseModel& otherPhase() const;
110 };
111 
112 
113 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
114 
115 } // End namespace Foam
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 #endif
120 
121 // ************************************************************************* //
virtual word name() const
Name.
Class to represent an interface between phases. Derivations can further specify the configuration of ...
static word separator()
Return the separator that delimits this interface&#39;s name.
Class to represent a system of phases and model interfacial transfers between them.
Definition: phaseSystem.H:68
A class for handling words, derived from string.
Definition: word.H:59
Class to represent a certain side of an interface between phases.
sidedPhaseInterface(const phaseModel &phase, const phaseModel &otherPhase)
Construct from phases.
const phaseSystem & fluid() const
Return the phase system.
virtual ~sidedPhaseInterface()
Destructor.
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phase.H:52
const phaseModel & otherPhase() const
Phase on the other side of the interface.
const phaseModel & phase() const
Phase on the this side of the interface.
TypeName("sidedPhaseInterface")
Runtime type information.
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
Namespace for OpenFOAM.