normal.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2011-2013 OpenFOAM Foundation
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    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.
 
    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
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::distributionModels::normal
 
Description
    A normal distribution model
 
    \verbatim
        model = strength * exp(-0.5*((x - expectation)/variance)^2 )
    \endverbatim
 
    strength only has meaning if there's more than one distribution model
 
SourceFiles
    normal.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef distributionModels_normal_H
#define distributionModels_normal_H
 
#include "distributionModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace distributionModels
{
 
/*---------------------------------------------------------------------------*\
                           Class normal Declaration
\*---------------------------------------------------------------------------*/
 
class normal
:
    public distributionModel
{
    // Private data
 
 
        //- Distribution minimum
        scalar minValue_;
 
        //- Distribution maximum
        scalar maxValue_;
 
 
        // Model coefficients
 
            scalar expectation_;
            scalar variance_;
 
            scalar a_;
 
 
public:
 
    //- Runtime type information
    TypeName("normal");
 
 
    // Constructors
 
        //- Construct from components
        normal(const dictionary& dict, Random& rndGen);
 
        //- Construct copy
        normal(const normal& p);
 
        //- Construct and return a clone
        virtual autoPtr<distributionModel> clone() const
        {
            return autoPtr<distributionModel>(new normal(*this));
        }
 
 
    //- Destructor
    virtual ~normal();
 
 
    // Member Functions
 
        //- Sample the distributionModel
        virtual scalar sample() const;
 
        //- Return the minimum value
        virtual scalar minValue() const;
 
        //- Return the maximum value
        virtual scalar maxValue() const;
 
        //- Return the mean value
        virtual scalar meanValue() const;
 
        virtual scalar erfInv(const scalar y) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace distributionModels
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //