ReactionRate.hpp

// Reaktoro is a unified framework for modeling chemically reactive systems.
//
// Copyright © 2014-2024 Allan Leal
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library. If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
// Reaktoro includes
#include <Reaktoro/Common/Real.hpp>
#include <Reaktoro/Common/NumberTraits.hpp>
 
namespace Reaktoro {
 
class ReactionRate
{
public:
    ReactionRate()
    {}
 
    template<typename T, Requires<isNumeric<T>> = true>
    ReactionRate(T const& value)
    : m_value(value) {}
 
    static auto enforce(real const& value) -> ReactionRate
    {
        ReactionRate res(value);
        res.m_equation_mode = true;
        return res;
    }
 
    auto value() const -> real const&
    {
        return m_value;
    }
 
    auto onEquationMode() const -> bool
    {
        return m_equation_mode;
    }
 
    operator real const&() const
    {
        return m_value;
    }
 
    template<typename T, Requires<isNumeric<T>> = true>
    auto operator=(T const& value) -> ReactionRate&
    {
        m_value = value;
        return *this;
    }
 
    template<typename T, Requires<isNumeric<T>> = true> auto operator+=(T const& scalar) -> ReactionRate& { m_value += scalar; return *this; }
    template<typename T, Requires<isNumeric<T>> = true> auto operator-=(T const& scalar) -> ReactionRate& { m_value -= scalar; return *this; }
    template<typename T, Requires<isNumeric<T>> = true> auto operator*=(T const& scalar) -> ReactionRate& { m_value *= scalar; return *this; }
    template<typename T, Requires<isNumeric<T>> = true> auto operator/=(T const& scalar) -> ReactionRate& { m_value /= scalar; return *this; }
 
private:
    real m_value = {};
 
    bool m_equation_mode = false;
};
 
inline auto operator+(ReactionRate const& rate) { return rate; }
inline auto operator-(ReactionRate rate) { return rate *= -1.0; }
 
template<typename T, Requires<isNumeric<T>> = true> auto operator+(ReactionRate rate, T const& scalar) { return rate += scalar; }
template<typename T, Requires<isNumeric<T>> = true> auto operator-(ReactionRate rate, T const& scalar) { return rate -= scalar; }
template<typename T, Requires<isNumeric<T>> = true> auto operator*(ReactionRate rate, T const& scalar) { return rate *= scalar; }
template<typename T, Requires<isNumeric<T>> = true> auto operator/(ReactionRate rate, T const& scalar) { return rate /= scalar; }
 
template<typename T, Requires<isNumeric<T>> = true> auto operator+(T const& scalar, ReactionRate rate) { return rate += scalar; }
template<typename T, Requires<isNumeric<T>> = true> auto operator-(T const& scalar, ReactionRate rate) { return rate -= scalar; }
template<typename T, Requires<isNumeric<T>> = true> auto operator*(T const& scalar, ReactionRate rate) { return rate *= scalar; }
template<typename T, Requires<isNumeric<T>> = true> auto operator/(T const& scalar, ReactionRate rate) { return rate /= scalar; }
 
} // namespace Reaktoro