orderedPhasePair.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2014-2015 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  // Private member functions
61 
62  //- Set the aspect ratio model, if there is one
63  void setAspectRatioModel(const dictTable aspectRatioTable);
64 
65 
66 public:
67 
68  // Constructors
69 
70  //- Construct from two phases and gravity
72  (
73  const phaseModel& dispersed,
74  const phaseModel& continuous
75  );
76 
77 
78  //- Destructor
79  virtual ~orderedPhasePair();
80 
81 
82  // Member Functions
83 
84  //- Dispersed phase
85  virtual const phaseModel& dispersed() const;
86 
87  //- Continuous phase
88  virtual const phaseModel& continuous() const;
89 
90  //- Pair name
91  virtual word name() const;
92 
93  //- Aspect ratio
94  virtual tmp<volScalarField> E() const;
95 };
96 
97 
98 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
99 
100 } // End namespace Foam
101 
102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 
104 #endif
105 
106 // ************************************************************************* //
virtual tmp< volScalarField > E() const
Aspect ratio.
virtual const phaseModel & dispersed() const
Dispersed phase.
An STL-conforming hash table.
Definition: HashTable.H:61
A class for handling words, derived from string.
Definition: word.H:59
orderedPhasePair(const phaseModel &dispersed, const phaseModel &continuous)
Construct from two phases and gravity.
Namespace for OpenFOAM.
virtual ~orderedPhasePair()
Destructor.
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:53
virtual const phaseModel & continuous() const
Continuous phase.
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:117
A class for managing temporary objects.
Definition: PtrList.H:118
virtual word name() const
Pair name.