OpenFOAM: API Guide
v2112
The open source CFD toolbox
orderedPhasePair.H
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
Class
27
Foam::orderedPhasePair
28
29
Description
30
31
SourceFiles
32
orderedPhasePair.C
33
34
\*---------------------------------------------------------------------------*/
35
36
#ifndef orderedPhasePair_H
37
#define orderedPhasePair_H
38
39
#include "
phasePair.H
"
40
41
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42
43
namespace
Foam
44
{
45
46
/*---------------------------------------------------------------------------*\
47
Class orderedPhasePair Declaration
48
\*---------------------------------------------------------------------------*/
49
50
class
orderedPhasePair
51
:
52
public
phasePair
53
{
54
55
public
:
56
57
// Constructors
58
59
//- Construct from two phases and gravity
60
orderedPhasePair
61
(
62
const
phaseModel&
dispersed
,
63
const
phaseModel&
continuous
64
);
65
66
67
//- Destructor
68
virtual
~orderedPhasePair
();
69
70
71
// Member Functions
72
73
//- Dispersed phase
74
virtual
const
phaseModel&
dispersed
()
const
;
75
76
//- Continuous phase
77
virtual
const
phaseModel&
continuous
()
const
;
78
79
//- Pair name
80
virtual
word
name
()
const
;
81
82
//- Other pair name
83
virtual
word
otherName
()
const
;
84
85
//- Aspect ratio
86
virtual
tmp<volScalarField>
E
()
const
;
87
};
88
89
90
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91
92
}
// End namespace Foam
93
94
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
95
96
#endif
97
98
// ************************************************************************* //
phasePair.H
Foam::orderedPhasePair::name
virtual word name() const
Pair name.
Definition:
orderedPhasePair.C:56
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
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::orderedPhasePair::~orderedPhasePair
virtual ~orderedPhasePair()=default
Destructor.
Definition:
orderedPhasePair.C:50
Foam::orderedPhasePair::dispersed
virtual const phaseModel & dispersed() const
Dispersed phase.
Definition:
orderedPhasePair.C:56
Foam::orderedPhasePair::orderedPhasePair
orderedPhasePair(const phaseModel &from, const phaseModel &to)
Construct from two phases and gravity.
Definition:
orderedPhasePair.C:33
src
phaseSystemModels
reactingEuler
multiphaseSystem
phasePair
orderedPhasePair.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.