SolverParameters.h

#ifndef INCLUDE_NONLINEARSOLVERPARAMETERS_H_
#define INCLUDE_NONLINEARSOLVERPARAMETERS_H_
 
#include <vector>
 
enum SolverToleranceType
{
  ABSOLUTE_RESIDUAL,
  RELATIVE_RESIDUAL_CHANGE,
  ABSOLUTE_SOLUTION_CHANGE
};
 
class SolverParametersBase
{
public:
  SolverToleranceType
  getToleranceType(unsigned int index);
 
  double
  getToleranceValue(unsigned int index);
 
protected:
  std::vector<unsigned int> var_index_list;
 
  std::vector<SolverToleranceType> tolerance_type_list;
  std::vector<double>              tolerance_value_list;
 
  unsigned int
  getEquationIndex(unsigned int global_index);
};
 
class LinearSolverParameters : public SolverParametersBase
{
public:
  void
  loadParameters(unsigned int        _var_index,
                 SolverToleranceType _tolerance_type,
                 double              _tolerance_value,
                 unsigned int        _max_iterations);
 
  unsigned int
  getMaxIterations(unsigned int index);
 
protected:
  std::vector<unsigned int> max_iterations_list;
};
 
class NonlinearSolverParameters : public SolverParametersBase
{
public:
  void
  setMaxIterations(unsigned int _max_iterations);
 
  [[nodiscard]] double
  getMaxIterations() const;
 
  void
  loadParameters(unsigned int        _var_index,
                 SolverToleranceType _tolerance_type,
                 double              _tolerance_value,
                 bool                _backtrack_damping_flag,
                 double              _backtrack_step_modifier,
                 double              _backtrack_residual_decrease_coeff,
                 double              _default_dampling_coefficient,
                 bool                _laplace_for_initial_guess);
 
  bool
  getBacktrackDampingFlag(unsigned int index);
 
  double
  getBacktrackStepModifier(unsigned int index);
 
  double
  getBacktrackResidualDecreaseCoeff(unsigned int index);
 
  double
  getDefaultDampingCoefficient(unsigned int index);
 
  bool
  getLaplaceInitializationFlag(unsigned int index);
 
private:
  unsigned int max_iterations;
 
  std::vector<bool>   backtrack_damping_flag_list;
  std::vector<double> backtrack_step_modifier_list;
  std::vector<double> backtrack_residual_decrease_coeff_list;
  std::vector<double> default_damping_coefficient_list;
  std::vector<bool>   laplace_for_initial_guess_list;
};
 
#endif