PRISMS-PF Manual
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
NonlinearSolverParameters Struct Reference

Struct that stores relevant nonlinear solve information of a certain field. More...

#include <solve_parameters.h>

Inheritance diagram for NonlinearSolverParameters:
[legend]
Collaboration diagram for NonlinearSolverParameters:
[legend]

Public Member Functions

void assign (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections) override
 Assign the parameters from file.
 
void validate (const std::vector< FieldAttributes > &field_attributes, const std::vector< SolveBlock > &solve_blocks) const override
 Validate.
 
- Public Member Functions inherited from ParameterBase
 ParameterBase ()=default
 
virtual ~ParameterBase ()=default
 
 ParameterBase (const ParameterBase &)=default
 
 ParameterBase (ParameterBase &&)=default
 
ParameterBase & operator= (const ParameterBase &)=default
 
ParameterBase & operator= (ParameterBase &&)=default
 

Static Public Member Functions

static void declare (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections)
 Declare the parameters to be read from file.
 

Public Attributes

double step_length = 1.0
 
unsigned int max_iterations = 100
 
double tolerance_value = 1.0e-10
 

Detailed Description

Struct that stores relevant nonlinear solve information of a certain field.

Member Function Documentation

◆ assign()

void NonlinearSolverParameters::assign ( dealii::ParameterHandler & parameter_handler,
unsigned int n_subsections = Numbers::default_subsections )
overridevirtual

Assign the parameters from file.

Implements ParameterBase.

◆ declare()

void NonlinearSolverParameters::declare ( dealii::ParameterHandler & parameter_handler,
unsigned int n_subsections = Numbers::default_subsections )
static

Declare the parameters to be read from file.

◆ validate()

void NonlinearSolverParameters::validate ( const std::vector< FieldAttributes > & field_attributes,
const std::vector< SolveBlock > & solve_blocks ) const
overridevirtual

Validate.

Implements ParameterBase.

Member Data Documentation

◆ max_iterations

unsigned int NonlinearSolverParameters::max_iterations = 100

◆ step_length

double NonlinearSolverParameters::step_length = 1.0

◆ tolerance_value

double NonlinearSolverParameters::tolerance_value = 1.0e-10
The documentation for this struct was generated from the following files: