All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
segregatedSidedPhaseInterface.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::segregatedSidedPhaseInterface
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.
30 
31 SourceFiles
32  segregatedSidedPhaseInterface.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef segregatedSidedPhaseInterface_H
37 #define segregatedSidedPhaseInterface_H
38 
40 #include "sidedPhaseInterface.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class segregatedSidedPhaseInterface Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
54  public sidedPhaseInterface
55 {
56 public:
57 
58  //- Runtime type information
59  TypeName("segregatedSidedPhaseInterface");
60 
61 
62  // Constructors
63 
64  //- Construct from phases
66  (
67  const phaseModel& phase,
68  const phaseModel& otherPhase
69  );
70 
71  //- Construct from fluid and name
73  (
74  const phaseSystem& fluid,
75  const word& name
76  );
77 
78 
79  //- Destructor
81 
82 
83  // Member Functions
84 
85  //- Name
86  virtual word name() const;
87 };
88 
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 } // End namespace Foam
93 
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95 
96 #endif
97 
98 // ************************************************************************* //
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 interface between phases where the two phases are considered to be segregated; t...
Class to represent a certain side of an interface between phases, where one phase is considered segre...
TypeName("segregatedSidedPhaseInterface")
Runtime type information.
segregatedSidedPhaseInterface(const phaseModel &phase, const phaseModel &otherPhase)
Construct from phases.
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.