distributionModel.C 3.87 KB
Newer Older
1
2
3
4
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
5
    \\  /    A nd           | Copyright (C) 2011-2013 OpenFOAM Foundation
6
7
8
9
10
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.

11
12
13
14
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
15
16
17
18
19
20
21

    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.

    You should have received a copy of the GNU General Public License
22
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
23
24
25

\*---------------------------------------------------------------------------*/

26
#include "distributionModel.H"
27
28

// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
Andrew Heather's avatar
Andrew Heather committed
29

30
31
namespace Foam
{
32
    namespace distributionModels
33
    {
34
35
        defineTypeNameAndDebug(distributionModel, 0);
        defineRunTimeSelectionTable(distributionModel, dictionary);
36
    }
Andrew Heather's avatar
Andrew Heather committed
37
}
38

39
40
// * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //

41
void Foam::distributionModels::distributionModel::check() const
42
43
44
{
    if (minValue() < 0)
    {
45
46
47
        FatalErrorIn("distributionModels::distributionModel::check() const")
            << type() << "distribution: Minimum value must be greater than "
            << "zero." << nl << "Supplied minValue = " << minValue()
48
49
50
51
52
            << abort(FatalError);
    }

    if (maxValue() < minValue())
    {
53
54
55
        FatalErrorIn("distributionModels::distributionModel::check() const")
            << type() << "distribution: Maximum value is smaller than the "
            << "minimum value:" << nl << "    maxValue = " << maxValue()
56
57
58
59
60
61
            << ", minValue = " << minValue()
            << abort(FatalError);
    }
}


62
63
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

64
Foam::distributionModels::distributionModel::distributionModel
65
66
67
68
69
(
    const word& name,
    const dictionary& dict,
    cachedRandom& rndGen
)
70
:
71
    distributionModelDict_(dict.subDict(name + "Distribution")),
72
73
74
75
    rndGen_(rndGen)
{}


76
77
78
79
Foam::distributionModels::distributionModel::distributionModel
(
    const distributionModel& p
)
80
:
81
    distributionModelDict_(p.distributionModelDict_),
82
83
84
85
    rndGen_(p.rndGen_)
{}


86
87
// * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //

88
Foam::distributionModels::distributionModel::~distributionModel()
89
90
91
{}


92
93
// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

94
Foam::scalar Foam::distributionModels::distributionModel::sample() const
95
{
96
97
98
99
100
    notImplemented
    (
        "Foam::scalar "
        "Foam::distributionModels::distributionModel::sample() const"
    );
101
102
103
104
    return 0.0;
}


105
Foam::scalar Foam::distributionModels::distributionModel::minValue() const
106
{
107
108
109
110
111
    notImplemented
    (
        "Foam::scalar "
        "Foam::distributionModels::distributionModel::minValue() const"
    );
112
113
114
115
    return 0.0;
}


116
Foam::scalar Foam::distributionModels::distributionModel::maxValue() const
117
{
118
119
120
121
122
    notImplemented
    (
        "Foam::scalar "
        "Foam::distributionModels::distributionModel::maxValue() const"
    );
123
124
125
126
    return 0.0;
}


127
128
129
130
131
132
133
134
135
136
137
Foam::scalar Foam::distributionModels::distributionModel::meanValue() const
{
    notImplemented
    (
        "Foam::scalar "
        "Foam::distributionModels::distributionModel::meanValue() const"
    );
    return 0.0;
}


138
// ************************************************************************* //