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-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 \*---------------------------------------------------------------------------*/
25 
26 #include "orderedPhasePair.H"
27 #include "phaseSystem.H"
28 
29 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
30 
32 (
33  const phaseModel& dispersed,
34  const phaseModel& continuous
35 )
36 :
37  phasePair
38  (
39  dispersed,
40  continuous,
41  true
42  )
43 {}
44 
45 
46 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
47 
49 {}
50 
51 
52 // * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
53 
55 {
56  return phase1();
57 }
58 
59 
61 {
62  return phase2();
63 }
64 
65 
67 {
68  word namec(second());
69  namec[0] = toupper(namec[0]);
70  return first() + "In" + namec;
71 }
72 
73 
75 {
77  << "Requested other name phase from an ordered pair."
78  << exit(FatalError);
79 
80  return word::null;
81 }
82 
83 
85 {
86  return phase1().fluid().E(*this);
87 }
88 
89 
90 // ************************************************************************* //
virtual word otherName() const
Other pair name.
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:323
virtual word name() const
Pair name.
A class for handling words, derived from string.
Definition: word.H:59
static const word null
An empty word.
Definition: word.H:77
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.