Scalar.H

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) 2011-2025 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/>.
 
Typedef
    Foam::Scalar
 
Description
    Single floating point number (float or double)
 
SourceFiles
    Scalar.C
 
\*---------------------------------------------------------------------------*/
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
// template specialisation for pTraits<Scalar>
template<>
class pTraits<Scalar>
{
    Scalar p_;
 
public:
 
    //- Component type
    typedef Scalar cmptType;
 
    //- Equivalent type of labels used for valid component indexing
    typedef label labelType;
 
 
    // Member constants
 
        //- Dimensionality of space
        static const direction dim = 3;
 
        //- Rank of Scalar is 0
        static const direction rank = 0;
 
        //- Number of components in Scalar is 1
        static const direction nComponents = 1;
 
 
    // Static Data Members
 
        static const char* const typeName;
        static const char* const componentNames[];
        static const Scalar zero;
        static const Scalar one;
        static const Scalar max;
        static const Scalar min;
        static const Scalar rootMax;
        static const Scalar rootMin;
        static const Scalar nan;
 
 
    // Constructors
 
        //- Construct from primitive
        explicit pTraits(const Scalar&);
 
        //- Construct from Istream
        pTraits(Istream&);
 
 
    // Member Functions
 
        //- Access to the Scalar value
        operator Scalar() const
        {
            return p_;
        }
 
        //- Access to the Scalar value
        operator Scalar&()
        {
            return p_;
        }
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
//- Return a string representation of a Scalar
word name(const Scalar);
 
 
// Standard C++ transcendental functions
transFunc(sqrt)
 
transFunc(cbrt)
transFunc(exp)
transFunc(log)
transFunc(log10)
transFunc(sin)
transFunc(cos)
transFunc(tan)
transFunc(asin)
transFunc(acos)
transFunc(atan)
transFunc(sinh)
transFunc(cosh)
transFunc(tanh)
transFunc(asinh)
transFunc(acosh)
transFunc(atanh)
 
// Standard ANSI-C (but not in <cmath>) transcendental functions
 
transFunc(erf)
transFunc(erfc)
transFunc(lgamma)
transFunc(tgamma)
 
transFunc(j0)
transFunc(j1)
 
transFunc(y0)
transFunc(y1)
 
 
inline Scalar& setComponent(Scalar& s, const direction)
{
    return s;
}
 
 
inline Scalar component(const Scalar s, const direction)
{
    return s;
}
 
 
//- Return 1 if s is positive or 0 otherwise -1
inline int sign(const Scalar s)
{
    return (s >= 0) ? 1: -1;
}
 
 
//- Return 1 if s is positive but not 0
inline int pos(const Scalar s)
{
    return (s > 0) ? 1: 0;
}
 
 
//- Return 1 if s is positive or 0
inline int pos0(const Scalar s)
{
    return (s >= 0) ? 1: 0;
}
 
 
//- Return 1 if s is negative but not 0
inline int neg(const Scalar s)
{
    return (s < 0) ? 1: 0;
}
 
 
//- Return 1 if s is negative or 0
inline int neg0(const Scalar s)
{
    return (s <= 0) ? 1: 0;
}
 
 
//- Return the positive part of s
inline Scalar posPart(const Scalar s)
{
    return (s > 0)? s: 0;
}
 
 
//- Return the negative part of s.
//  Note: this function returns the actual negative part of s as a
//  negative number and does not change the sign
inline Scalar negPart(const Scalar s)
{
    return (s < 0)? s: 0;
}
 
 
inline bool equal(const Scalar& s1, const Scalar& s2)
{
    return mag(s1 - s2) <= ScalarVSmall;
}
 
 
inline bool notEqual(const Scalar s1, const Scalar s2)
{
    return mag(s1 - s2) > ScalarVSmall;
}
 
 
inline Scalar limit(const Scalar s1, const Scalar s2)
{
    return (mag(s1) < mag(s2)) ? s1: 0.0;
}
 
 
inline Scalar minMod(const Scalar s1, const Scalar s2)
{
    return (mag(s1) < mag(s2)) ? s1: s2;
}
 
 
inline Scalar magSqr(const Scalar s)
{
    return s*s;
}
 
 
inline Scalar sqr(const Scalar s)
{
    return s*s;
}
 
 
inline Scalar pow3(const Scalar s)
{
    return s*sqr(s);
}
 
 
inline Scalar pow4(const Scalar s)
{
    return sqr(sqr(s));
}
 
 
inline Scalar pow5(const Scalar s)
{
    return s*pow4(s);
}
 
 
inline Scalar pow6(const Scalar s)
{
    return pow3(sqr(s));
}
 
 
inline Scalar pow025(const Scalar s)
{
    return sqrt(sqrt(s));
}
 
 
inline Scalar inv(const Scalar s)
{
    return 1.0/s;
}
 
 
template<class Type>
inline Type dot(const Scalar s, const Type& t)
{
    return s*t;
}
 
 
template<class Type>
inline Type dot(const Type& t, const Scalar s)
{
    return t*s;
}
 
 
inline Scalar dot(const Scalar s1, const Scalar s2)
{
    return s1*s2;
}
 
 
inline Scalar cmptMultiply(const Scalar s1, const Scalar s2)
{
    return s1*s2;
}
 
 
inline Scalar cmptPow(const Scalar s1, const Scalar s2)
{
    return pow(s1, s2);
}
 
 
inline Scalar cmptDivide(const Scalar s1, const Scalar s2)
{
    return s1/s2;
}
 
 
inline Scalar cmptMax(const Scalar s)
{
    return s;
}
 
 
inline Scalar cmptMin(const Scalar s)
{
    return s;
}
 
 
inline Scalar cmptAv(const Scalar s)
{
    return s;
}
 
 
inline Scalar cmptSqr(const Scalar s)
{
    return sqr(s);
}
 
 
inline Scalar cmptMag(const Scalar s)
{
    return mag(s);
}
 
 
inline Scalar sqrtSumSqr(const Scalar a, const Scalar b)
{
    Scalar maga = mag(a);
    Scalar magb = mag(b);
 
    if (maga > magb)
    {
        return maga*sqrt(1 + sqr(magb/maga));
    }
    else
    {
        return magb < ScalarVSmall ? 0 : magb*sqrt(1 + sqr(maga/magb));
    }
}
 
 
//- Stabilisation around zero for division
inline Scalar stabilise(const Scalar s, const Scalar small)
{
    if (s >= 0)
    {
        return s + small;
    }
    else
    {
        return s - small;
    }
}
 
 
//- Divide two numbers and protect the result from overflowing
inline Scalar protectedDivide(const Scalar a, const Scalar b)
{
    return mag(a)/ScalarVGreat < mag(b) ? a/b : sign(a)*sign(b)*ScalarVGreat;
}
 
 
//- Divide two numbers, protect the result from overflowing, and clip the
//  result between 0 and 1
inline Scalar protectedDivideAndClip01(const Scalar a, const Scalar b)
{
    const Scalar bStar = max(mag(a), mag(b));
 
    return bStar == 0 ? 0 : max(a*sign(b), 0)/bStar;
}
 
 
// * * * * * * * * * * * * * * * IOstream Functions  * * * * * * * * * * * * //
 
Scalar readScalar(Istream&);
 
void writeEntry(Ostream& os, const Scalar value);
 
 
// * * * * * * * * * * * * * * * IOstream Operators  * * * * * * * * * * * * //
 
Istream& operator>>(Istream&, Scalar&);
Ostream& operator<<(Ostream&, const Scalar);
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// ************************************************************************* //