All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
orderedPhasePair.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) 2014-2020 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::orderedPhasePair
26 
27 Description
28 
29 SourceFiles
30  orderedPhasePair.C
31 
32 \*---------------------------------------------------------------------------*/
33 
34 #ifndef orderedPhasePair_H
35 #define orderedPhasePair_H
36 
37 #include "phasePair.H"
38 
39 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
40 
41 namespace Foam
42 {
43 
44 /*---------------------------------------------------------------------------*\
45  Class orderedPhasePair Declaration
46 \*---------------------------------------------------------------------------*/
47 
48 class orderedPhasePair
49 :
50  public phasePair
51 {
52 
53 public:
54 
55  // Constructors
56 
57  //- Construct from two phases and gravity
59  (
60  const phaseModel& dispersed,
61  const phaseModel& continuous
62  );
63 
64 
65  //- Destructor
66  virtual ~orderedPhasePair();
67 
68 
69  // Member Functions
70 
71  //- Dispersed phase
72  virtual const phaseModel& dispersed() const;
73 
74  //- Continuous phase
75  virtual const phaseModel& continuous() const;
76 
77  //- Pair name
78  virtual word name() const;
79 
80  //- Other pair name
81  virtual word otherName() const;
82 
83  //- Aspect ratio
84  virtual tmp<volScalarField> E() const;
85 };
86 
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 } // End namespace Foam
91 
92 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 
94 #endif
95 
96 // ************************************************************************* //
virtual word otherName() const
Other pair name.
virtual ~orderedPhasePair()
Destructor.
virtual word name() const
Pair name.
A class for handling words, derived from string.
Definition: word.H:59
virtual const phaseModel & continuous() const
Continuous phase.
virtual tmp< volScalarField > E() const
Aspect ratio.
orderedPhasePair(const phaseModel &dispersed, const phaseModel &continuous)
Construct from two phases and gravity.
A class for managing temporary objects.
Definition: PtrList.H:53
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
virtual const phaseModel & dispersed() const
Dispersed phase.
Namespace for OpenFOAM.