The open source CFD toolbox
orderedPhasePair.C
Go to the documentation of this file.
1/*---------------------------------------------------------------------------*\
2 ========= |
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4 \\ / O peration |
5 \\ / A nd | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2014-2018 OpenFOAM Foundation
9-------------------------------------------------------------------------------
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
15 the Free Software Foundation, either version 3 of the License, or
16 (at your option) any later version.
17
18 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 for more details.
22
23 You should have received a copy of the GNU General Public License
24 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25
26\*---------------------------------------------------------------------------*/
27
28#include "orderedPhasePair.H"
29#include "phaseSystem.H"
30
31// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32
34(
35 const phaseModel& dispersed,
36 const phaseModel& continuous
37)
38:
40 (
41 dispersed,
42 continuous,
43 true
44 )
45{}
46
47
48// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
49
51{}
52
53
54// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
55
57{
58 return phase1();
59}
60
61
63{
64 return phase2();
65}
66
67
69{
70 word namec(second());
71 namec[0] = toupper(namec[0]);
72 return first() + "In" + namec;
73}
74
75
77{
79 << "Requested other name phase from an ordered pair."
80 << exit(FatalError);
81
82 return word::null;
83}
84
85
87{
88 return phase1().fluid().E(*this);
89}
90
91
92// ************************************************************************* //
phaseModel & phase1
phaseModel & phase2
virtual word otherName() const
Other pair name.
virtual word name() const
Pair name.
virtual ~orderedPhasePair()=default
Destructor.
virtual const phaseModel & continuous() const
Continuous phase.
virtual const phaseModel & dispersed() const
Dispersed phase.
virtual tmp< volScalarField > E() const
Aspect ratio.
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:61
const phaseSystem & fluid() const
Return the system to which this phase belongs.
Definition: phaseModel.C:148
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:56
tmp< volScalarField > E(const phasePairKey &key) const
Return the aspect-ratio for a pair.
Definition: phaseSystem.C:300
A class for managing temporary objects.
Definition: tmp.H:65
A class for handling words, derived from Foam::string.
Definition: word.H:68
static const word null
An empty word.
Definition: word.H:80
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
error FatalError
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130