CADETProcess.processModel.discretization.ConsistencySolverParameters

class CADETProcess.processModel.discretization.ConsistencySolverParameters(solver_name, init_damping, min_damping, max_iterations, subsolvers)

A class for defining the consistency solver parameters for Cadet.

Parameters:

solver_nameSwitch, optional

Name of the solver. Valid values are ‘LEVMAR’, ‘ATRN_RES’, ‘ATRN_ERR’, and ‘COMPOSITE’. The default is ‘LEVMAR’

init_dampingUnsignedFloat, optional

The initial damping parameter. Default is 0.01.

min_dampingUnsignedFloat, optional

The minimum damping parameter. Default is 0.0001.

max_iterationsUnsignedFloat, optional

The maximum number of iterations. Default is 50.

subsolversSwitch, optional

Vector with names of solvers for the composite solver (only required for composite solver). Valid values are ‘LEVMAR’, ‘ATRN_RES’, ‘ATRN_ERR’, and ‘COMPOSITE’. The default is ‘LEVMAR’

See also

Structure

Attributes:

aggregated_parameters

dict: Aggregated parameters of the instance.

init_damping

max_iterations

min_damping

missing_parameters

list: Parameters that are required but not set.

parameters

dict: Parameters of the instance.

polynomial_parameters

dict: Polynomial parameters of the instance.

required_parameters

list: Parameters that have no default value.

sized_parameters

dict: Sized parameters of the instance.

solver_name

subsolvers

Methods

check_required_parameters()

Verify if all required parameters are set.