phasePair.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) 2017-2022 OpenCFD Ltd.
9-------------------------------------------------------------------------------
10License
11 This file is part of OpenFOAM.
12
13 OpenFOAM is free software: you can redistribute it and/or modify it
14 under the terms of the GNU General Public License as published by
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 "phasePair.H"
29#include "surfaceTensionModel.H"
30
31
32// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
33
35(
38 const bool ordered
39)
40:
41 phasePairKey(phase1.name(), phase2.name(), ordered),
42 phase1_(phase1),
43 phase2_(phase2)
44{}
45
46
47// * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * * //
48
50{
52 << "Requested from phase from an unordered pair."
53 << exit(FatalError);
54
55 return phase1_;
56}
57
58
60{
62 << "Requested to phase from an unordered pair."
63 << exit(FatalError);
64
65 return phase1_;
66}
67
68
70{
71 word name2(second());
72 name2[0] = toupper(name2[0]);
73 return first() + "And" + name2;
74}
75
76
77// ************************************************************************* //
phaseModel & phase1
phaseModel & phase2
An ordered or unorder pair of phase names. Typically specified as follows.
Definition: phasePairKey.H:68
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition: phasePair.H:56
virtual const multiphaseInter::phaseModel & from() const
From phase.
Definition: phasePair.C:49
virtual const multiphaseInter::phaseModel & to() const
To phase.
Definition: phasePair.C:59
virtual word name() const
Pair name.
Definition: phasePair.C:69
A class for handling words, derived from Foam::string.
Definition: word.H:68
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
error FatalError
word name(const expressions::valueTypeCode typeCode)
A word representation of a valueTypeCode. Empty for INVALID.
Definition: exprTraits.C:59
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130