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 -------------------------------------------------------------------------------
10 License
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 "orderedPhasePair.H"
29 #include "phaseSystem.H"
30 
31 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
32 
34 (
35  const phaseModel& dispersed,
36  const phaseModel& continuous
37 )
38 :
39  phasePair
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 // ************************************************************************* //
Foam::phaseModel
Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture fo...
Definition: phaseModel.H:54
Foam::word
A class for handling words, derived from Foam::string.
Definition: word.H:65
Foam::orderedPhasePair::name
virtual word name() const
Pair name.
Definition: orderedPhasePair.C:56
Foam::tmp
A class for managing temporary objects.
Definition: PtrList.H:61
orderedPhasePair.H
Foam::orderedPhasePair::continuous
virtual const phaseModel & continuous() const
Continuous phase.
Definition: orderedPhasePair.C:62
Foam::orderedPhasePair::E
virtual tmp< volScalarField > E() const
Aspect ratio.
Definition: orderedPhasePair.C:86
Foam::orderedPhasePair::otherName
virtual word otherName() const
Other pair name.
Definition: orderedPhasePair.C:76
phase2
phaseModel & phase2
Definition: setRegionFluidFields.H:6
Foam::FatalError
error FatalError
Foam::orderedPhasePair::~orderedPhasePair
virtual ~orderedPhasePair()=default
Destructor.
Definition: orderedPhasePair.C:50
Foam::exit
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:130
FatalErrorInFunction
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:453
Foam::orderedPhasePair::dispersed
virtual const phaseModel & dispersed() const
Dispersed phase.
Definition: orderedPhasePair.C:56
Foam::word::null
static const word null
An empty word.
Definition: word.H:80
Foam::phaseModel::fluid
const phaseSystem & fluid() const
Return the system to which this phase belongs.
Definition: phaseModel.C:100
Foam::orderedPhasePair::orderedPhasePair
orderedPhasePair(const phaseModel &from, const phaseModel &to)
Construct from two phases and gravity.
Definition: orderedPhasePair.C:33
phase1
phaseModel & phase1
Definition: setRegionFluidFields.H:5
Foam::phaseSystem::E
tmp< volScalarField > E(const phasePairKey &key) const
Return the aspect-ratio for a pair.
Definition: phaseSystem.C:300