nonlinear_convergence.hpp

// Copyright (c) Lawrence Livermore National Security, LLC and
// other Smith Project Developers. See the top-level LICENSE file for
// details.
//
// SPDX-License-Identifier: (BSD-3-Clause)
 
#pragma once
 
#include <vector>
 
#include "mpi.h"
#include "mfem.hpp"
 
namespace smith {
 
struct ConvergenceStatus {
  bool global_converged = false;         
  bool converged = false;                
  double global_norm = 0.0;              
  double global_goal = 0.0;              
  std::vector<double> block_norms = {};  
};
 
struct NonlinearConvergenceContext {
  double initial_global_norm = -1.0;  
 
  void reset();
};
 
std::vector<double> computeResidualBlockNorms(const std::vector<mfem::Vector>& residuals, MPI_Comm comm);
 
ConvergenceStatus evaluateResidualConvergence(double tolerance_multiplier, double abs_tol, double rel_tol,
                                              const std::vector<double>& block_norms,
                                              NonlinearConvergenceContext& context);
 
class EquationSolverConvergenceManager {
 public:
  EquationSolverConvergenceManager(MPI_Comm comm, double abs_tol, double rel_tol);
 
  void reset() const;
 
  void setTolerances(double abs_tol, double rel_tol) const;
 
  ConvergenceStatus evaluate(double tolerance_multiplier, const mfem::Vector& residual) const;
 
 private:
  MPI_Comm comm_;
  mutable double abs_tol_;
  mutable double rel_tol_;
  mutable NonlinearConvergenceContext context_ = {};
};
 
class ConvergenceManagedNonlinearSolver {
 public:
  virtual ~ConvergenceManagedNonlinearSolver() = default;
 
  virtual void setConvergenceManager(std::shared_ptr<EquationSolverConvergenceManager> convergence_manager) = 0;
};
 
}  // namespace smith