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