OpenFOAM: API Guide
v2006
The open source CFD toolbox
fixedValue.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) 2011-2016 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 "
fixedValue.H
"
29
#include "
addToRunTimeSelectionTable.H
"
30
31
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
32
33
namespace
Foam
34
{
35
namespace
distributionModels
36
{
37
defineTypeNameAndDebug
(fixedValue, 0);
38
addToRunTimeSelectionTable
(distributionModel, fixedValue, dictionary);
39
}
40
}
41
42
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
43
44
Foam::distributionModels::fixedValue::fixedValue
45
(
46
const
dictionary
&
dict
,
47
Random
&
rndGen
48
)
49
:
50
distributionModel
(typeName,
dict
,
rndGen
),
51
value_(distributionModelDict_.get<scalar>(
"value"
))
52
{}
53
54
55
Foam::distributionModels::fixedValue::fixedValue
(
const
fixedValue
&
p
)
56
:
57
distributionModel
(
p
),
58
value_(
p
.value_)
59
{}
60
61
62
// * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
63
64
Foam::distributionModels::fixedValue::~fixedValue
()
65
{}
66
67
68
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
69
70
Foam::scalar Foam::distributionModels::fixedValue::fixedValue::sample()
const
71
{
72
return
value_;
73
}
74
75
76
Foam::scalar
Foam::distributionModels::fixedValue::fixedValue::minValue
()
const
77
{
78
return
value_;
79
}
80
81
82
Foam::scalar
Foam::distributionModels::fixedValue::fixedValue::maxValue
()
const
83
{
84
return
value_;
85
}
86
87
88
Foam::scalar Foam::distributionModels::fixedValue::fixedValue::meanValue()
const
89
{
90
return
value_;
91
}
92
93
94
// ************************************************************************* //
Foam::Random
Random number generator.
Definition:
Random.H:59
p
volScalarField & p
Definition:
createFieldRefs.H:8
Foam::distributionModels::fixedValue
Returns a fixed value.
Definition:
fixedValue.H:51
Foam::distributionModels::addToRunTimeSelectionTable
addToRunTimeSelectionTable(distributionModel, binned, dictionary)
Foam::distributionModel
A library of runtime-selectable distribution models.
Definition:
distributionModel.H:70
Foam::distributionModels::fixedValue::~fixedValue
virtual ~fixedValue()
Destructor.
Definition:
fixedValue.C:64
dict
dictionary dict
Definition:
searchingEngine.H:14
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition:
dictionary.H:121
addToRunTimeSelectionTable.H
Macros for easy insertion into run-time selection tables.
Foam
Namespace for OpenFOAM.
Definition:
atmBoundaryLayer.C:33
Foam::distributionModels::defineTypeNameAndDebug
defineTypeNameAndDebug(binned, 0)
Foam::distributionModels::fixedValue::fixedValue
fixedValue(const dictionary &dict, Random &rndGen)
Construct from components.
Definition:
fixedValue.C:45
minValue
scalar minValue
Definition:
LISASMDCalcMethod2.H:12
rndGen
Random rndGen
Definition:
createFields.H:23
fixedValue.H
maxValue
scalar maxValue
Definition:
LISASMDCalcMethod1.H:5
src
lagrangian
distributionModels
fixedValue
fixedValue.C
Generated by
1.8.17
OPENFOAM® is a registered
trademark
of OpenCFD Ltd.