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-2018 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 class aspectRatioModel;
45 
46 /*---------------------------------------------------------------------------*\
47  Class orderedPhasePair Declaration
48 \*---------------------------------------------------------------------------*/
49 
50 class orderedPhasePair
51 :
52  public phasePair
53 {
54  // Private data
55 
56  //- Aspect ratio model
57  autoPtr<aspectRatioModel> aspectRatio_;
58 
59 
60 public:
61 
62  // Constructors
63 
64  //- Construct from two phases, gravity, surface tension and aspect
65  // ratio tables
67  (
68  const phaseModel& dispersed,
69  const phaseModel& continuous,
70  const dimensionedVector& g,
71  const scalarTable& sigmaTable,
72  const dictTable& aspectRatioTable
73  );
74 
75 
76  //- Destructor
77  virtual ~orderedPhasePair();
78 
79 
80  // Member Functions
81 
82  //- Dispersed phase
83  virtual const phaseModel& dispersed() const;
84 
85  //- Continuous phase
86  virtual const phaseModel& continuous() const;
87 
88  //- Pair name
89  virtual word name() const;
90 
91  //- Aspect ratio
92  virtual tmp<volScalarField> E() const;
93 };
94 
95 
96 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 
98 } // End namespace Foam
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 #endif
103 
104 // ************************************************************************* //
HashTable< dictionary, phasePairKey, phasePairKey::hash > dictTable
Dictionary hash table.
Definition: phasePair.H:59
virtual ~orderedPhasePair()
Destructor.
virtual word name() const
Pair name.
dimensioned< vector > dimensionedVector
Dimensioned vector obtained from generic dimensioned type.
const uniformDimensionedVectorField & g() const
Return gravitation acceleration.
Definition: phasePairI.H:91
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.
HashTable< scalar, phasePairKey, phasePairKey::hash > scalarTable
Scalar hash table.
Definition: phasePair.H:63
virtual const phaseModel & dispersed() const
Dispersed phase.
Namespace for OpenFOAM.