uniform_oneDimensionalDiscretisation.C

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2025-2026 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
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 "uniform_oneDimensionalDiscretisation.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
namespace Foam
{
namespace oneDimensionalDiscretisations
{
    defineTypeNameAndDebug(uniform, 0);
    addToRunTimeSelectionTable
    (
        oneDimensionalDiscretisation,
        uniform,
        dictionary
    );
}
}
 
 
// * * * * * * * * * * Private Static Member Functions * * * * * * * * * * * //
 
Foam::tmp<Foam::scalarField>
Foam::oneDimensionalDiscretisations::uniform::coordinates
(
    const dimensionSet& dims,
    const label n,
    const dictionary& dict
)
{
    const scalarField f(linearSequence01(n));
 
    const scalar min = dict.lookup<scalar>("min", dims);
    const scalar max = dict.lookup<scalar>("max", dims);
 
    if (min >= max)
    {
        FatalIOErrorInFunction(dict)
            << "The specified minimum and maximum values are not in order"
            << exit(FatalIOError);
    }
 
    const label q = dict.lookupOrDefault<label>("q", label(1));
 
    if (q < 0 && (min <= 0 || max <= 0))
    {
        FatalIOErrorInFunction(dict)
            << "Moments/powers must be positive if the coordinate range "
            << "includes negative values" << exit(FatalIOError);
    }
 
    if (q == 0)
    {
        return pow(min, 1 - f)*pow(max, f);
    }
 
    if (q == 1)
    {
        return (1 - f)*min + f*max;
    }
 
    return integerRoot((1 - f)*integerPow(min, q) + f*integerPow(max, q), q);
}
 
 
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
Foam::oneDimensionalDiscretisations::uniform::uniform
(
    const word& name,
    const dimensionSet& dims,
    const label n,
    const dictionary& dict
)
:
    oneDimensionalDiscretisation(name, dims, coordinates(dims, n, dict))
{}
 
 
// ************************************************************************* //