distributionModel.C
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2019 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  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 * * * * * * * * * * * * * //
29 
30 namespace Foam
31 {
32  defineTypeNameAndDebug(distributionModel, 0);
33  defineRunTimeSelectionTable(distributionModel, dictionary);
34 }
35 
36 
37 // * * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * //
38 
40 {
41  if (minValue() < 0)
42  {
44  << type() << "distribution: Minimum value must be greater than "
45  << "zero." << nl << "Supplied minValue = " << minValue()
46  << abort(FatalError);
47  }
48 
49  if (maxValue() < minValue())
50  {
52  << type() << "distribution: Maximum value is smaller than the "
53  << "minimum value:" << nl << " maxValue = " << maxValue()
54  << ", minValue = " << minValue()
55  << abort(FatalError);
56  }
57 }
58 
59 
61 {
62  Info<< " Distribution min: " << minValue() << " max: " << maxValue()
63  << " mean: " << meanValue() << endl;
64 }
65 
66 
67 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
68 
70 (
71  const word& name,
72  const dictionary& dict,
73  Random& rndGen
74 )
75 :
76  distributionModelDict_(dict.subDict(name + "Distribution")),
77  rndGen_(rndGen)
78 {}
79 
80 
82 (
83  const distributionModel& p
84 )
85 :
86  distributionModelDict_(p.distributionModelDict_),
87  rndGen_(p.rndGen_)
88 {}
89 
90 
91 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
92 
94 {}
95 
96 
97 // ************************************************************************* //
Random & rndGen_
Reference to the random number generator.
error FatalError
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:156
#define FatalErrorInFunction
Report an error message using Foam::FatalError.
Definition: error.H:323
scalar minValue
Ostream & endl(Ostream &os)
Add newline and flush stream.
Definition: Ostream.H:251
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:982
void info() const
Print information about the distribution.
scalar maxValue
distributionModel(const word &name, const dictionary &dict, Random &rndGen)
Construct from dictionary.
A class for handling words, derived from string.
Definition: word.H:59
virtual void check() const
Check that the distribution model is valid.
errorManip< error > abort(error &err)
Definition: errorManip.H:131
virtual ~distributionModel()
Destructor.
Random number generator.
Definition: Random.H:57
static const char nl
Definition: Ostream.H:260
defineRunTimeSelectionTable(reactionRateFlameArea, dictionary)
defineTypeNameAndDebug(combustionModel, 0)
A library of runtime-selectable distribution models.
fileType type(const fileName &, const bool checkVariants=true, const bool followLink=true)
Return the file type: directory or file.
Definition: POSIX.C:488
const dictionary distributionModelDict_
Coefficients dictionary.
messageStream Info
Namespace for OpenFOAM.