NonlinearSolveParameterSet Struct Reference

Struct that holds nonlinear solver parameters. More...

#include <nonlinear_solve_parameters.h>

Public Member Functions
void	validate ()
	Validate parameters.
void	print_parameter_summary () const
	Print parameters to summary.log.
void	declare_parameters (dealii::ParameterHandler &parameter_handler, unsigned int max_criteria=5) const
	Declare the parameters to be read from an input file.
void	assign_parameters (dealii::ParameterHandler &parameter_handler, unsigned int max_criteria=5)
	Assign the parameters read from an input file to this object.

Public Attributes
std::map< Types::Index, NonlinearSolverParameters >	newton_solvers

Detailed Description

Struct that holds nonlinear solver parameters.

Member Function Documentation

assign_parameters()

void NonlinearSolveParameterSet::assign_parameters ( dealii::ParameterHandler & parameter_handler, unsigned int max_criteria = 5 )

inline

Assign the parameters read from an input file to this object.

declare_parameters()

void NonlinearSolveParameterSet::declare_parameters ( dealii::ParameterHandler & parameter_handler, unsigned int max_criteria = 5 ) const

inline

Declare the parameters to be read from an input file.

print_parameter_summary()

void NonlinearSolveParameterSet::print_parameter_summary ( ) const

inline

Print parameters to summary.log.

validate()

void NonlinearSolveParameterSet::validate ( )

inline

Validate parameters.

Member Data Documentation

newton_solvers

std::map<Types::Index, NonlinearSolverParameters> NonlinearSolveParameterSet::newton_solvers

---

The documentation for this struct was generated from the following file:

• include/prismspf/user_inputs/nonlinear_solve_parameters.h