nonlinear_solve_parameters.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2025 PRISMS Center at the University of Michigan
// SPDX-License-Identifier: GNU Lesser General Public Version 2.1
 
#pragma once
 
#include <prismspf/core/types.h>
 
#include <prismspf/user_inputs/linear_solve_parameters.h>
 
#include <prismspf/config.h>
 
PRISMS_PF_BEGIN_NAMESPACE

struct NonlinearSolverParameters
{
  // Nonlinear step length
  mutable double step_length = 1.0;
 
  // Max number of iterations for the nonlinear solve
  unsigned int max_iterations = Defaults::iterations;
 
  // Tolerance value for the nonlinear solve
  double tolerance_value = Defaults::tolerance;
};

struct NonlinearSolveParameterSet
{
  void
  validate();

  void
  print_parameter_summary() const;
 
  // Map of nonlinear solve parameters for fields that require them
  std::map<Types::Index, NonlinearSolverParameters> newton_solvers;
};
 
inline void
NonlinearSolveParameterSet::validate()
{
  for (const auto &[index, nonlinear_solver_parameters] : newton_solvers)
    {
      AssertThrow(
        nonlinear_solver_parameters.step_length > 0.0 &&
          nonlinear_solver_parameters.step_length <= 1.0,
        dealii::ExcMessage(
          "Step length must be greater than 0.0 and less than or equal to 1.0"));
 
      AssertThrow(nonlinear_solver_parameters.tolerance_value > 0,
                  dealii::ExcMessage("Tolerance must be greater than 0.0"));
    }
}
 
inline void
NonlinearSolveParameterSet::print_parameter_summary() const
{
  if (!newton_solvers.empty())
    {
      ConditionalOStreams::pout_summary()
        << "================================================\n"
        << "  Nonlinear Solve Parameters\n"
        << "================================================\n";
 
      for (const auto &[index, nonlinear_solver_parameters] : newton_solvers)
        {
          ConditionalOStreams::pout_summary()
            << "Index: " << index << "\n"
            << "  Max iterations: " << nonlinear_solver_parameters.max_iterations << "\n"
            << "  Step length: " << nonlinear_solver_parameters.step_length << "\n";
        }
 
      ConditionalOStreams::pout_summary() << "\n" << std::flush;
    }
}
 
PRISMS_PF_END_NAMESPACE