OpenFOAM: API Guide
v2112
The open source CFD toolbox
constantAspectRatio.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::aspectRatioModels::constantAspectRatio
28
29
Description
30
Constant value aspect ratio model.
31
32
SourceFiles
33
constantAspectRatio.C
34
35
\*---------------------------------------------------------------------------*/
36
37
#ifndef constantAspectRatio_H
38
#define constantAspectRatio_H
39
40
#include "aspectRatioModel.H"
41
42
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43
44
namespace
Foam
45
{
46
namespace
aspectRatioModels
47
{
48
49
/*---------------------------------------------------------------------------*\
50
Class constantAspectRatio Declaration
51
\*---------------------------------------------------------------------------*/
52
53
class
constantAspectRatio
54
:
55
public
aspectRatioModel
56
{
57
// Private data
58
59
//- Constant aspect ratio value
60
const
dimensionedScalar
E0_;
61
62
63
public
:
64
65
//- Runtime type information
66
TypeName
(
"constant"
);
67
68
69
// Constructors
70
71
//- Construct from a dictionary and an ordered phase pair
72
constantAspectRatio
73
(
74
const
dictionary
&
dict
,
75
const
phasePair
& pair
76
);
77
78
79
//- Destructor
80
virtual
~constantAspectRatio
();
81
82
83
// Member Functions
84
85
//- Aspect ratio
86
virtual
tmp<volScalarField>
E
()
const
;
87
};
88
89
90
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91
92
}
// End namespace aspectRatioModels
93
}
// End namespace Foam
94
95
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96
97
#endif
98
99
// ************************************************************************* //
Foam::phasePair
Description for mass transfer between a pair of phases. The direction of the mass transfer is from th...
Definition:
phasePair.H:53
Foam::tmp
A class for managing temporary objects.
Definition:
PtrList.H:61
Foam::aspectRatioModels::constantAspectRatio::constantAspectRatio
constantAspectRatio(const dictionary &dict, const phasePair &pair)
Construct from a dictionary and an ordered phase pair.
Definition:
constantAspectRatio.C:52
Foam::aspectRatioModels::constantAspectRatio::TypeName
TypeName("constant")
Runtime type information.
Foam::aspectRatioModels::constantAspectRatio::~constantAspectRatio
virtual ~constantAspectRatio()
Destructor.
Definition:
constantAspectRatio.C:64
Foam::aspectRatioModel
Definition:
aspectRatioModel.H:55
dict
dictionary dict
Definition:
searchingEngine.H:14
Foam::aspectRatioModels::constantAspectRatio::E
virtual tmp< volScalarField > E() const
Aspect ratio.
Definition:
constantAspectRatio.C:71
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:123
Foam::dimensioned< scalar >
Foam::aspectRatioModels::constantAspectRatio
Constant value aspect ratio model.
Definition:
constantAspectRatio.H:52
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
src
phaseSystemModels
reactingEuler
multiphaseSystem
interfacialModels
aspectRatioModels
constantAspectRatio
constantAspectRatio.H
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.