LinearSolverResult.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 Total, S.A
 * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2023-2024 Chevron
 * Copyright (c) 2019-     GEOS/GEOSX Contributors
 * All rights reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_LINEARALGEBRA_UTILITIES_LINEARSOLVERRESULT_HPP_
#define GEOS_LINEARALGEBRA_UTILITIES_LINEARSOLVERRESULT_HPP_
 
#include "common/DataTypes.hpp"
 
#include <vector>
 
namespace geos
{
 
struct LinearSolverResult
{
  enum class Status
  {
    InProgress,
    Success,
    NotConverged,
    Breakdown
  };
 
  Status status = Status::InProgress;
 
  integer numIterations = 0;
 
  real64 residualReduction = 0.0;
 
  real64 setupTime = 0.0;
 
  real64 solveTime = 0.0;
 
  bool success() const
  {
    return status == Status::Success;
  }
 
  bool breakdown() const
  {
    return status == Status::Breakdown;
  }
};
 
ENUM_STRINGS( LinearSolverResult::Status,
              "InProgress",
              "Success",
              "NotConverged",
              "Breakdown" );
 
}
 
#endif //GEOS_LINEARALGEBRA_UTILITIES_LINEARSOLVERRESULT_HPP_