All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
segregatedDisplacedSidedPhaseInterface.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-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 Class
25  Foam::segregatedDisplacedSidedPhaseInterface
26 
27 Description
28  Class to represent a certain side of an interface between phases, where one
29  phase is considered segregated within the other, and the pair has been
30  displaced to some extent by a third phase.
31 
32 SourceFiles
33  segregatedDisplacedSidedPhaseInterface.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef segregatedDisplacedSidedPhaseInterface_H
38 #define segregatedDisplacedSidedPhaseInterface_H
39 
42 #include "sidedPhaseInterface.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class segregatedDisplacedSidedPhaseInterface Declaration
51 \*---------------------------------------------------------------------------*/
52 
54 :
57  public sidedPhaseInterface
58 {
59 public:
60 
61  //- Runtime type information
62  TypeName("segregatedDisplacedSidedPhaseInterface");
63 
64 
65  // Constructors
66 
67  //- Construct from phases
69  (
70  const phaseModel& phase,
71  const phaseModel& otherPhase,
72  const phaseModel& displacing
73  );
74 
75  //- Construct from fluid and name
77  (
78  const phaseSystem& fluid,
79  const word& name
80  );
81 
82 
83  //- Destructor
85 
86 
87  // Member Functions
88 
89  //- Name
90  virtual word name() const;
91 };
92 
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 } // End namespace Foam
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 #endif
101 
102 // ************************************************************************* //
Class to represent an interface between phases which has been displaced to some extent by a third pha...
const phaseModel & displacing() const
Displacing phase.
const phaseSystem & fluid() const
Return the phase system.
Class to represent a system of phases and model interfacial transfers between them.
Definition: phaseSystem.H:73
Class to represent a certain side of an interface between phases, where one phase is considered segre...
segregatedDisplacedSidedPhaseInterface(const phaseModel &phase, const phaseModel &otherPhase, const phaseModel &displacing)
Construct from phases.
TypeName("segregatedDisplacedSidedPhaseInterface")
Runtime type information.
Class to represent a interface between phases where the two phases are considered to be segregated; t...
Class to represent a certain side of an interface between phases.
const phaseModel & otherPhase() const
Phase on the other side of the interface.
const phaseModel & phase() const
Phase on the this side of the interface.
A class for handling words, derived from string.
Definition: word.H:62
Namespace for OpenFOAM.