RandomTemplates.C

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-2015 OpenFOAM Foundation
    Copyright (C) 2018-2022 OpenCFD Ltd.
-------------------------------------------------------------------------------
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/>.

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

#include "Random.H"
#include "Pstream.H"

// * * * * * * * * * * * * * * * Member Functions  * * * * * * * * * * * * * //

template<class Type>
Type Foam::Random::sample01()
{
    Type value;
    for (direction cmpt=0; cmpt<pTraits<Type>::nComponents; ++cmpt)
    {
        value.component(cmpt) = scalar01();
    }

    return value;
}


template<class Type>
Type Foam::Random::GaussNormal()
{
    Type value;
    for (direction cmpt=0; cmpt<pTraits<Type>::nComponents; ++cmpt)
    {
        value.component(cmpt) = GaussNormal<scalar>();
    }

    return value;
}


template<class Type>
Type Foam::Random::position(const Type& start, const Type& end)
{
    Type value(start);
    for (direction cmpt=0; cmpt<pTraits<Type>::nComponents; ++cmpt)
    {
        value.component(cmpt) +=
            scalar01()*(end.component(cmpt) - start.component(cmpt));
    }

    return value;
}


template<class Type>
void Foam::Random::randomise01(Type& value)
{
    value = sample01<Type>();
}


template<class Type>
void Foam::Random::shuffle(UList<Type>& values)
{
    for (label posi = values.size()-1; posi > 0; --posi)
    {
        const label i = position<label>(0, posi);
        Foam::Swap(values[i], values[posi]);
    }
}


template<class Type>
Type Foam::Random::globalSample01()
{
    Type value(Zero);

    if (Pstream::master())
    {
        value = sample01<Type>();
    }

    Pstream::broadcast(value);

    return value;
}


template<class Type>
Type Foam::Random::globalGaussNormal()
{
    Type value(Zero);

    if (Pstream::master())
    {
        value = GaussNormal<Type>();
    }

    Pstream::broadcast(value);

    return value;
}


template<class Type>
Type Foam::Random::globalPosition(const Type& start, const Type& end)
{
    Type value(Zero);

    if (Pstream::master())
    {
        value = position<Type>(start, end);
    }

    Pstream::broadcast(value);

    return value;
}


template<class Type>
void Foam::Random::globalRandomise01(Type& value)
{
    if (Pstream::master())
    {
        value = sample01<Type>();
    }

    Pstream::broadcast(value);
}


// ************************************************************************* //