src/lagrangian/distributionModels/distributionModel/distributionModel.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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     {
  34         defineTypeNameAndDebug(distributionModel, 0);
  35         defineRunTimeSelectionTable(distributionModel, dictionary);
  36     }
  37 }
  38
  39 // * * * * * * * * * * * * * Protected Member Functions  * * * * * * * * * * //
  40
  41 void Foam::distributionModels::distributionModel::check() const
  42 {
  43     if (minValue() < 0)
  44     {
  45         FatalErrorIn("distributionModels::distributionModel::check() const")
  46             << type() << "distribution: Minimum value must be greater than "
  47             << "zero." << nl << "Supplied minValue = " << minValue()
  48             << abort(FatalError);
  49     }
  50
  51     if (maxValue() < minValue())
  52     {
  53         FatalErrorIn("distributionModels::distributionModel::check() const")
  54             << type() << "distribution: Maximum value is smaller than the "
  55             << "minimum value:" << nl << "    maxValue = " << maxValue()
  56             << ", minValue = " << minValue()
  57             << abort(FatalError);
  58     }
  59 }
  60
  61
  62 // * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
  63
  64 Foam::distributionModels::distributionModel::distributionModel
  65 (
  66     const word& name,
  67     const dictionary& dict,
  68     cachedRandom& rndGen
  69 )
  70 :
  71     distributionModelDict_(dict.subDict(name + "Distribution")),
  72     rndGen_(rndGen)
  73 {}
  74
  75
  76 Foam::distributionModels::distributionModel::distributionModel
  77 (
  78     const distributionModel& p
  79 )
  80 :
  81     distributionModelDict_(p.distributionModelDict_),
  82     rndGen_(p.rndGen_)
  83 {}
  84
  85
  86 // * * * * * * * * * * * * * * * * Destructor  * * * * * * * * * * * * * * * //
  87
  88 Foam::distributionModels::distributionModel::~distributionModel()
  89 {}
  90
  91
  92 // * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //
  93
  94 Foam::scalar Foam::distributionModels::distributionModel::sample() const
  95 {
  96     notImplemented
  97     (
  98         "Foam::scalar "
  99         "Foam::distributionModels::distributionModel::sample() const"
 100     );
 101     return 0.0;
 102 }
 103
 104
 105 Foam::scalar Foam::distributionModels::distributionModel::minValue() const
 106 {
 107     notImplemented
 108     (
 109         "Foam::scalar "
 110         "Foam::distributionModels::distributionModel::minValue() const"
 111     );
 112     return 0.0;
 113 }
 114
 115
 116 Foam::scalar Foam::distributionModels::distributionModel::maxValue() const
 117 {
 118     notImplemented
 119     (
 120         "Foam::scalar "
 121         "Foam::distributionModels::distributionModel::maxValue() const"
 122     );
 123     return 0.0;
 124 }
 125
 126
 127 // ************************************************************************* //