data/src/OpenFOAM/dimensionSet/dimensionSetIO.C

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2011-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 "dimensionSet.H"
#include "NamedEnum.H"
#include "symbols.H"

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

void Foam::dimensionSet::round(const scalar tol)
{
    for (int i=0; i<dimensionSet::nDimensions; ++i)
    {
        scalar integralPart;
        scalar fractionalPart = std::modf(exponents_[i], &integralPart);

        if (mag(fractionalPart - 1.0) <= tol)
        {
            exponents_[i] = 1.0 + integralPart;
        }
        else if (mag(fractionalPart + 1.0) <= tol)
        {
            exponents_[i] = -1.0 + integralPart;
        }
        else if (mag(fractionalPart) <= tol)
        {
            exponents_[i] = integralPart;
        }
    }
}


// * * * * * * * * * * * * * * * * Constructors  * * * * * * * * * * * * * * //

Foam::dimensionSet::dimensionSet(Istream& is)
{
    is >> *this;
}


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

Foam::Istream& Foam::dimensionSet::readNoBeginOrEnd(Istream& is)
{
    token nextToken;

    // Peek at the next token
    is >> nextToken;
    is.putBack(nextToken);

    // If not a number, then these are named dimensions. Parse.
    if (!nextToken.isNumber())
    {
        reset(symbols::parseNoBeginOrEnd(is, dimless, dimensions::table));
        return is;
    }

    // Otherwise these are numbered dimensions. Read directly...

    // Read first five dimensions
    for (int i=0; i<dimensionSet::CURRENT; i++)
    {
        is >> exponents_[i];
    }

    // Peek at the next token
    is >> nextToken;
    is.putBack(nextToken);

    // If next token is another number then read the last two dimensions
    // and then read another token for the end of the dimensionSet
    if (nextToken.isNumber())
    {
        is >> exponents_[dimensionSet::CURRENT];
        is >> exponents_[dimensionSet::LUMINOUS_INTENSITY];
    }
    else
    {
        exponents_[dimensionSet::CURRENT] = 0;
        exponents_[dimensionSet::LUMINOUS_INTENSITY] = 0;
    }

    return is;
}


Foam::Istream& Foam::dimensionSet::read(Istream& is)
{
    // Read beginning of dimensionSet
    token startToken(is);
    if (startToken != token::BEGIN_SQR)
    {
        FatalIOErrorInFunction(is)
            << "expected a " << token::BEGIN_SQR << " in dimensionSet"
            << endl << "in stream " << is.info()
            << exit(FatalIOError);
    }

    readNoBeginOrEnd(is);

    // Read end of dimensionSet
    token endToken(is);
    if (endToken != token::END_SQR)
    {
        FatalIOErrorInFunction(is)
            << "expected a " << token::END_SQR << " in dimensionSet "
            << endl << "in stream " << is.info()
            << exit(FatalIOError);
    }

    // Check state of Istream
    is.check("Istream& operator>>(Istream&, dimensionSet&)");

    return is;
}


Foam::Ostream& Foam::dimensionSet::writeNoBeginOrEnd(Ostream& os) const
{
    if (dimensionless())
    {
        // Do nothing
    }
    else
    {
        for (int i=0; i<dimensionSet::nDimensions-1; i++)
        {
            os << exponents_[i] << token::SPACE;
        }

        os << exponents_[dimensionSet::nDimensions-1];
    }

    return os;
}


Foam::Ostream& Foam::dimensionSet::write(Ostream& os) const
{
    os << token::BEGIN_SQR;

    writeNoBeginOrEnd(os);

    os << token::END_SQR;

    // Check state of Ostream
    os.check("Ostream& operator<<(Ostream&, const dimensionSet&)");

    return os;
}


Foam::Ostream& Foam::dimensionSet::writeInfoNoBeginOrEnd(Ostream& os) const
{
    for (int first=true, i=0; i<dimensionSet::nDimensions; i++)
    {
        if (mag(exponents_[i]) > dimensionSet::smallExponent)
        {
            if (!first)
            {
                os << token::SPACE;
            }

            os << dimensionSet::dimensionTypeNames_
                  [static_cast<dimensionSet::dimensionType>(i)];

            if (exponents_[i] != 1)
            {
                os << '^' << exponents_[i];
            }

            first = false;
        }
    }

    return os;
}


void Foam::writeEntry(Ostream& os, const dimensionSet& value)
{
    os << value;
}


// * * * * * * * * * * * * * * * IOstream Operators  * * * * * * * * * * * * //

Foam::Istream& Foam::operator>>(Istream& is, dimensionSet& dims)
{
    dims.read(is);

    // Check state of Istream
    is.check("Istream& operator>>(Istream&, dimensionSet&)");

    return is;
}


Foam::Ostream& Foam::operator<<(Ostream& os, const dimensionSet& dims)
{
    dims.write(os);

    // Check state of Ostream
    os.check("Ostream& operator<<(Ostream&, const dimensionSet&)");

    return os;
}


Foam::Ostream& Foam::operator<<(Ostream& os, const InfoProxy<dimensionSet>& ip)
{
    os << token::BEGIN_SQR;

    ip.t_.writeInfoNoBeginOrEnd(os);

    os << token::END_SQR;

    // Check state of Ostream
    os.check("Ostream& operator<<(Ostream&, const InfoProxy<dimensionSet>&)");

    return os;
}


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