nonlinear_solve_parameters.h

// SPDX-FileCopyrightText: © 2025 PRISMS Center at the University of Michigan
// SPDX-License-Identifier: GNU Lesser General Public Version 2.1
 
#ifndef nonlinear_solve_parameters_h
#define nonlinear_solve_parameters_h
 
#include <prismspf/config.h>
#include <prismspf/core/types.h>
#include <prismspf/user_inputs/linear_solve_parameters.h>
 
PRISMS_PF_BEGIN_NAMESPACE
 
struct nonlinearSolverParameters
{
public:
  // Nonlinear step length
  mutable double step_length = 1.0;
 
  // Max number of iterations for the nonlinear solve
  unsigned int max_iterations = defaults::iterations;
};
struct nonlinearSolverParameters {…};
 
struct nonlinearSolveParameters
{
public:
  void
  postprocess_and_validate();
 
  void
  print_parameter_summary() const;
 
  // Map of nonlinear solve parameters for fields that require them
  std::map<unsigned int, nonlinearSolverParameters> nonlinear_solve;
};
struct nonlinearSolveParameters {…};
 
inline void
nonlinearSolveParameters::postprocess_and_validate()
{
  // Nothing to do here for now
}
nonlinearSolveParameters::postprocess_and_validate() {…}
 
inline void
nonlinearSolveParameters::print_parameter_summary() const
{
  if (!nonlinear_solve.empty())
    {
      conditionalOStreams::pout_summary()
        << "================================================\n"
        << "  Nonlinear Solve Parameters\n"
        << "================================================\n";
 
      for (const auto &[index, nonlinear_solver_parameters] : nonlinear_solve)
        {
          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;
    }
}
nonlinearSolveParameters::print_parameter_summary() const {…}
 
PRISMS_PF_END_NAMESPACE
 
#endif