distributionModel.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 | Copyright (C) 2011-2015 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  namespace distributionModels
33  {
36  }
37 }
38 
39 
40 // * * * * * * * * * * * * * Protected Member Functions * * * * * * * * * * //
41 
43 {
44  if (minValue() < 0)
45  {
46  FatalErrorIn("distributionModels::distributionModel::check() const")
47  << type() << "distribution: Minimum value must be greater than "
48  << "zero." << nl << "Supplied minValue = " << minValue()
49  << abort(FatalError);
50  }
51 
52  if (maxValue() < minValue())
53  {
54  FatalErrorIn("distributionModels::distributionModel::check() const")
55  << type() << "distribution: Maximum value is smaller than the "
56  << "minimum value:" << nl << " maxValue = " << maxValue()
57  << ", minValue = " << minValue()
58  << abort(FatalError);
59  }
60 }
61 
62 
63 // * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
64 
66 (
67  const word& name,
68  const dictionary& dict,
69  cachedRandom& rndGen
70 )
71 :
72  distributionModelDict_(dict.subDict(name + "Distribution")),
73  rndGen_(rndGen)
74 {}
75 
76 
78 (
79  const distributionModel& p
80 )
81 :
82  distributionModelDict_(p.distributionModelDict_),
83  rndGen_(p.rndGen_)
84 {}
85 
86 
87 // * * * * * * * * * * * * * * * * Destructor * * * * * * * * * * * * * * * //
88 
90 {}
91 
92 
93 // ************************************************************************* //
defineTypeNameAndDebug(distributionModel, 0)
const dictionary distributionModelDict_
Coefficients dictionary.
defineRunTimeSelectionTable(distributionModel, dictionary)
A class for handling words, derived from string.
Definition: word.H:59
scalar maxValue
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const dictionary & subDict(const word &) const
Find and return a sub-dictionary.
Definition: dictionary.C:638
Namespace for OpenFOAM.
scalar minValue
cachedRandom & rndGen_
Reference to the random number generator.
static const char nl
Definition: Ostream.H:260
distributionModel(const word &name, const dictionary &dict, cachedRandom &rndGen)
Construct from dictionary.
errorManip< error > abort(error &err)
Definition: errorManip.H:131
fileName::Type type(const fileName &)
Return the file type: DIRECTORY or FILE.
Definition: POSIX.C:589
#define FatalErrorIn(functionName)
Report an error message using Foam::FatalError.
Definition: error.H:314
error FatalError
Random number generator.
Definition: cachedRandom.H:63
virtual void check() const
Check that the distribution model is valid.