CADETProcess.processModel.discretization.ConsistencySolverParameters

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

Bases: Structure

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

init_damping

Parameter descriptor for unsigned floating-point parameters.

max_iterations

Parameter descriptor for unsigned integer parameters.

min_damping

Parameter descriptor for unsigned floating-point parameters.

solver_name

Parameter that can be set to one of several predefined options.

Attributes:

validlist

List of valid options for the parameter.

Notes

Assign a value to this parameter from the valid list.

subsolvers

Parameter that can be set to one of several predefined options.

Attributes:

validlist

List of valid options for the parameter.

Notes

Assign a value to this parameter from the valid list.