scalarRange.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) 2018-2019 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 "scalarRange.H"
#include "string.H"
#include "Switch.H"
#include "MinMax.H"
#include "error.H"
 
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
 
const Foam::scalarRange Foam::scalarRange::null;
 
const Foam::scalarRange Foam::scalarRange::always
(
    scalarRange::ALWAYS,
    -GREAT,
    GREAT
);
 
 
// * * * * * * * * * * * * * Static Member Functions * * * * * * * * * * * * //
 
bool Foam::scalarRange::parse(const std::string& str, scalarRange& range)
{
    range.clear();
 
    const auto colon = str.find(':');
 
    if (colon == std::string::npos)
    {
        // No colon
 
        // Use Switch to accept none/true/false.
        // Do not accept shorter ones though (f|n|t|y) or (on|off|yes|no)
        // since these are not really appropriate here.
 
        if (str.size() >= 4)
        {
            Switch sw(str, true);
 
            if (sw.valid())
            {
                if (sw)
                {
                    range = scalarRange::always;
                }
 
                return true; // parsed ok
            }
        }
 
        // "VALUE"
        scalar val;
        if (readScalar(str, val))
        {
            range = scalarRange(val);
        }
    }
    else if (str.find(':', colon+1) != std::string::npos)
    {
        // A second colon is a syntax error
        return false;
    }
    else if (colon == 0)
    {
        // ":MAX"
        scalar val;
        if (readScalar(str.substr(1), val))
        {
            range = scalarRange::le(val);
        }
    }
    else if (colon == str.size()-1)
    {
        // "MIN:"
        scalar val;
        if (readScalar(str.substr(0, colon), val))
        {
            range = scalarRange::ge(val);
        }
    }
    else
    {
        // "MIN:MAX"
        scalar minVal, maxVal;
        if
        (
            readScalar(str.substr(0, colon), minVal)
         && readScalar(str.substr(colon+1), maxVal)
        )
        {
            range = scalarRange(minVal, maxVal);
        }
    }
 
    return range.valid();
}
 
 
Foam::scalarRange Foam::scalarRange::parse(const std::string& str)
{
    scalarRange range;
 
    if (!parse(str, range))
    {
        Info<< "Bad scalar-range while parsing: " << str << endl;
    }
 
    return range;
}
 
 
// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //
 
Foam::scalarRange::scalarRange(const MinMax<label>& range) noexcept
:
    min_(range.min()),
    max_(range.max()),
    type_(max_ < min_ ? scalarRange::NONE : scalarRange::GE_LE)
{}
 
 
Foam::scalarRange::scalarRange(const MinMax<scalar>& range) noexcept
:
    min_(range.min()),
    max_(range.max()),
    type_(max_ < min_ ? scalarRange::NONE : scalarRange::GE_LE)
{}
 
 
// * * * * * * * * * * * * * * * Friend Operators  * * * * * * * * * * * * * //
 
Foam::Ostream& Foam::operator<<(Ostream& os, const scalarRange& range)
{
    switch (range.type_)
    {
        case scalarRange::EQ:
            os << range.min();
            break;
 
        case scalarRange::GE:
        case scalarRange::GT:
            os << range.min() << ":Inf";
            break;
 
        case scalarRange::LE:
        case scalarRange::LT:
            os << "-Inf:" << range.max();
            break;
 
        case scalarRange::GE_LE:
            os << range.min() << ':' << range.max();
            break;
 
        case scalarRange::ALWAYS:
            os << "true";
            break;
 
        default:
            os << "none";
            break;
    }
 
    return os;
}
 
 
// ************************************************************************* //