All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
displacedSidedPhaseInterface.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::displacedSidedPhaseInterface
26 
27 Description
28  Class to represent a certain side of an interface between phases, where the
29  interface has been displaced to some extent by a third phase.
30 
31 SourceFiles
32  displacedSidedPhaseInterface.C
33 
34 \*---------------------------------------------------------------------------*/
35 
36 #ifndef displacedSidedPhaseInterface_H
37 #define displacedSidedPhaseInterface_H
38 
41 #include "sidedPhaseInterface.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class displacedSidedPhaseInterface Declaration
50 \*---------------------------------------------------------------------------*/
51 
53 :
55  public sidedPhaseInterface
56 {
57 public:
58 
59  //- Runtime type information
60  TypeName("displacedSidedPhaseInterface");
61 
62 
63  // Constructors
64 
65  //- Construct from phases
67  (
68  const phaseModel& phase,
69  const phaseModel& otherPhase,
70  const phaseModel& displacing
71  );
72 
73  //- Construct from fluid and name
75  (
76  const phaseSystem& fluid,
77  const word& name
78  );
79 
80 
81  //- Destructor
83 
84 
85  // Member Functions
86 
87  //- Name
88  virtual word name() const;
89 };
90 
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 } // End namespace Foam
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 #endif
99 
100 // ************************************************************************* //
Class to represent an interface between phases which has been displaced to some extent by a third pha...
const phaseModel & displacing() const
Displacing phase.
Class to represent a certain side of an interface between phases, where the interface has been displa...
TypeName("displacedSidedPhaseInterface")
Runtime type information.
displacedSidedPhaseInterface(const phaseModel &phase, const phaseModel &otherPhase, const phaseModel &displacing)
Construct from phases.
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.
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.