EquilibriumResult.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
 
// Optima includes
#include <Optima/Result.hpp>
 
namespace Reaktoro {
 
struct EquilibriumResult
{
    auto succeeded() const { return optima.succeeded; };
 
    auto failed() const { return !optima.succeeded; };
 
    auto iterations() const { return optima.iterations; };
 
    Optima::Result optima;
 
    auto operator+=(const EquilibriumResult& other) -> EquilibriumResult&;
};
 
} // namespace Reaktoro