data/src/OpenFOAM/primitives/functions/Function1/Scale/ScaleI.H

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

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

template<class Type>
inline Type Foam::Function1s::Scale<Type>::value(const scalar x) const
{
    if (constantScale_ && constantValue_)
    {
        return scale_->value(NaN)*value_->value(NaN);
    }
    else
    {
        const scalar sx = xScale_->value(x)*x;
        return scale_->value(sx)*value_->value(sx);
    }
}


template<class Type>
inline Type Foam::Function1s::Scale<Type>::derivative(const scalar x) const
{
    if (constantScale_ && constantValue_)
    {
        return pTraits<Type>::zero;
    }
    else
    {
        const scalar s = xScale_->value(x), sx = s*x;
        return
            (s + xScale_->derivative(x)*x)
           *(
               scale_->derivative(sx)*value_->value(sx)
             + scale_->value(sx)*value_->derivative(sx)
            );
    }
}


template<class Type>
inline Type Foam::Function1s::Scale<Type>::integral
(
    const scalar x1,
    const scalar x2
) const
{
    if (constantXScale_ && constantScale_)
    {
        const scalar sx = xScale_->value(NaN);
        return scale_->value(NaN)*value_->integral(sx*x1, sx*x2)/sx;
    }

    if (constantXScale_ && constantValue_)
    {
        const scalar sx = xScale_->value(NaN);
        return scale_->integral(sx*x1, sx*x2)/sx*value_->value(NaN);
    }

    FatalErrorInFunction
        << "Integration is not defined for " << type() << " functions "
        << "unless x-scaling is constant and either scaling is constant or "
        << "the value is constant"
        << exit(FatalError);

    return Zero;
}


template<class Type>
inline bool Foam::Function1s::Scale<Type>::constant() const
{
    return constantScale_ && constantValue_;
}


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