orderedPhasePair.C
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 \*---------------------------------------------------------------------------*/
25 
26 #include "orderedPhasePair.H"
27 #include "aspectRatioModel.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
32 (
33  const phaseModel& dispersed,
34  const phaseModel& continuous,
35  const dimensionedVector& g,
36  const scalarTable& sigmaTable,
37  const dictTable& aspectRatioTable
38 )
39 :
40  phasePair(dispersed, continuous, g, sigmaTable, true)
41 {
42  if (aspectRatioTable.found(*this))
43  {
44  aspectRatio_.set
45  (
47  (
48  aspectRatioTable[*this],
49  *this
50  ).ptr()
51  );
52  }
53 }
54 
55 
56 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
57 
59 {}
60 
61 
62 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
63 
65 {
66  return phase1();
67 }
68 
69 
71 {
72  return phase2();
73 }
74 
75 
77 {
78  word namec(continuous().name());
79  namec[0] = toupper(namec[0]);
80  return dispersed().name() + "In" + namec;
81 }
82 
83 
85 {
86  if (!aspectRatio_.valid())
87  {
89  << "Aspect ratio model not specified for " << *this << "."
90  << exit(FatalError);
91  }
92 
93  return aspectRatio_->E();
94 }
95 
96 
97 // ************************************************************************* //
static autoPtr< aspectRatioModel > New(const dictionary &dict, const phasePair &pair)
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
error FatalError
virtual ~orderedPhasePair()
Destructor.
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:319
virtual word name() const
Pair name.
dimensioned< vector > dimensionedVector
Dimensioned vector obtained from generic dimensioned type.
A class for handling words, derived from string.
Definition: word.H:59
phaseModel & phase1
virtual const phaseModel & continuous() const
Continuous phase.
virtual tmp< volScalarField > E() const
Aspect ratio.
word name(const complex &)
Return a string representation of a complex.
Definition: complex.C:47
orderedPhasePair(const phaseModel &dispersed, const phaseModel &continuous)
Construct from two phases and gravity.
phaseModel & phase2
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.