siconos.numerics constants (Python API)

All the predefined global constants in siconos.numerics(generated from C++ enum, global variables, …)

Usage :

import siconos.numerics as sn

print(sn.CONSTNAME)

List and descriptions of available constants :

SICONOS_VI_EG_DPARAM_RHO

index in iparam to store the initial value of rho (= 3)

SICONOS_VI_EG_DPARAM_LS_TAU

index in iparam to store the tau coeff of line-search (= 4)

SICONOS_VI_EG_DPARAM_LS_TAUINV

index in iparam to store the tauinv coeff of line-search (= 5)

SICONOS_VI_EG_DPARAM_LS_L

index in iparam to store the L coeff of line-search (= 6)

SICONOS_VI_EG_DPARAM_LS_LMIN

index in iparam to store the LMIN coeff of line-search (= 7)

SICONOS_VI_IPARAM_LINESEARCH_METHOD

index in iparam to store the error evaluation method (= 6)

SICONOS_VI_IPARAM_ERROR_EVALUATION

index in iparam to store the error evaluation method (= 7)

SICONOS_VI_IPARAM_ERROR_EVALUATION_FREQUENCY

index in iparam to store the frequency of error evaluation method (= 8)

SICONOS_FRICTION_2D_NSGS

2D Frictional Contact solvers (= 400)

SICONOS_FRICTION_3D_NSGS

Non-smooth Gauss Seidel, local formulation. (= 500)

SICONOS_FRICTION_3D_NSGSV

Non-smooth Gauss Seidel-velocity, local formulation. (= 501)

SICONOS_FRICTION_3D_PROX

proximal, local formulation (= 502)

SICONOS_FRICTION_3D_TFP

Tresca, fixed point, local formulation. (= 503)

SICONOS_FRICTION_3D_NSN_AC

Non-smooth Newton Alart-Curnier, local formulation. (= 504)

SICONOS_FRICTION_3D_DSFP

De Saxce fixed point, local formulation. (= 505)

SICONOS_FRICTION_3D_VI_FPP

VI formulation, fixed point projection, local formulation. (= 506)

SICONOS_FRICTION_3D_VI_EG

VI formulation, Extra-gradient, local formulation. (= 507)

SICONOS_FRICTION_3D_HP

Hyperplane projection, local formulation. (= 508)

SICONOS_FRICTION_3D_NCPGlockerFBFixedPoint

Fischer Burmeister fixed point, local formulation. (= 510)

SICONOS_FRICTION_3D_FPP

Fixed point projection, local formulation. (= 511)

SICONOS_FRICTION_3D_EG

Extra-gradient, local formulation. (= 512)

SICONOS_FRICTION_3D_NSN_FB

Non-smooth Newton Fischer Burmeister, local formulation. (= 513)

SICONOS_FRICTION_3D_GAMS_PATH

GAMS/Path (Ferris), local formulation. (= 514)

SICONOS_FRICTION_3D_GAMS_PATHVI

VI formulation, GAMS/Path (Ferris), local formulation. (= 515)

SICONOS_FRICTION_3D_ACLMFP

Alart-Curnier fixed point, local formulation. (= 516)

SICONOS_FRICTION_3D_SOCLCP

Second-order Cone LCP, local formulation. (= 517)

SICONOS_FRICTION_3D_GAMS_LCP_PATH

GAMS/PATH (Ferris) LCP, local formulation. (= 518)

SICONOS_FRICTION_3D_GAMS_LCP_PATHVI

VI formulation, GAMS/PATH (Ferris) LCP, local formulation. (= 519)

SICONOS_FRICTION_3D_NSN_NM

Non-smooth Newton, natural map, local formulation. (= 520)

SICONOS_FRICTION_3D_PFP

Panagiotopoulos, fixed point, local formulation. (= 522)

SICONOS_FRICTION_3D_ADMM

ADMM local formulation. (= 523)

SICONOS_FRICTION_3D_ONECONTACT_NSN

Non-smooth Newton Alart-Curnier, ‘direct’, one contact solver. (= 550)

SICONOS_FRICTION_3D_ONECONTACT_NSN_GP

Non-smooth Newton Alart-Curnier, ‘damped’, one contact solver. (= 551)

SICONOS_FRICTION_3D_ONECONTACT_ProjectionOnCone

Projection on cone, one contact solver. (= 552)

SICONOS_FRICTION_3D_ONECONTACT_ProjectionOnConeWithLocalIteration

Projection on cone, one contact solver. (= 553)

SICONOS_FRICTION_3D_DeSaxceFixedPoint

De Saxce fixed point, one contact solver. (= 560)

SICONOS_FRICTION_3D_NCPGlockerFBPATH

Fischer Burmeister/Path, Glocker formulation, one contact solver. (= 556)

SICONOS_FRICTION_3D_NCPGlockerFBNewton

Newton/Fischer Burmeister, Glocker formulation, one contact solver. (= 561)

SICONOS_GLOBAL_FRICTION_3D_NSGS_WR

3D Frictional contact local solvers on global formulation (= 600)

SICONOS_GLOBAL_FRICTION_3D_VI_FPP

VI formulation, Fixed Point Projection, local formulation. (= 610)

SICONOS_GLOBAL_FRICTION_3D_VI_EG

VI formulation, Extra-gradient, local formulation. (= 611)

SICONOS_FRICTION_3D_ADMM_RHO

index in dparam to store the rho value for projection formulation (= 3)

SICONOS_FRICTION_3D_ADMM_RESTART_ETA

index in dparam to store the eta value for the restarting criteria (= 4)

SICONOS_FRICTION_3D_ADMM_BALANCING_RESIDUAL_TAU

index in dparam to store the tau value for the balancing residual technique (= 5)

SICONOS_FRICTION_3D_ADMM_BALANCING_RESIDUAL_PHI

index in dparam to store the phi value for the balancing residual technique (= 6)

SICONOS_FRICTION_3D_ADMM_IPARAM_RHO_STRATEGY

index in iparam to store the strategy for computing rho (= 9)

SICONOS_FRICTION_3D_ADMM_IPARAM_ACCELERATION

index in iparam to store the acceleration parameter (= 10)

SICONOS_FRICTION_3D_ADMM_IPARAM_SYMMETRY

index in iparam to store the symmetry parameter (= 11)

SICONOS_FRICTION_3D_ADMM_IPARAM_SPARSE_STORAGE

index in iparam to store the sparse storage parameter (= 12)

SICONOS_FRICTION_3D_ADMM_RHO_STRATEGY_CONSTANT

A constant value given in dparam[SICONOS_FRICTION_3D_NSN_RHO] is used. (= 0)

SICONOS_FRICTION_3D_ADMM_RHO_STRATEGY_NORM_INF

A computed value stored in dparam[SICONOS_FRICTION_3D_NSN_RHO] is used. (=1)

SICONOS_FRICTION_3D_ADMM_RHO_STRATEGY_RESIDUAL_BALANCING

An adaptive strategy for rho is used. (=2)

SICONOS_FRICTION_3D_ADMM_RHO_STRATEGY_SCALED_RESIDUAL_BALANCING

An adaptive strategy for rho is used. (=3)

SICONOS_FRICTION_3D_DPARAM_INTERNAL_ERROR_RATIO

index in iparam to store the internal solver error ratio (= 2)

SICONOS_FRICTION_3D_IPARAM_INTERNAL_ERROR_STRATEGY

index in iparam to store the error strategy for the internal solver (=2)

SICONOS_FRICTION_3D_IPARAM_ERROR_EVALUATION

index in iparam to store the error evaluation method (= 7)

SICONOS_FRICTION_3D_IPARAM_ERROR_EVALUATION_FREQUENCY

index in iparam to store the frequency of error evaluation method (= 8)

SICONOS_FRICTION_3D_NSGS_RELAXATION_VALUE

index in dparam to store the relaxation strategy (=8)

SICONOS_FRICTION_3D_NSGS_ERROR_EVALUATION_FULL

Evaluation of the error with the expensive function fc3d_compute_error. (= 0)

SICONOS_FRICTION_3D_NSGS_ERROR_EVALUATION_LIGHT

Evaluation of the error with the cheap incremental variation. (= 1)

SICONOS_FRICTION_3D_NSGS_ERROR_EVALUATION_LIGHT_WITH_FULL_FINAL

Evaluation of the error with the cheap incremental variation but we modify the

incremental toleranve to reach the requred accuracy. (= 2)

SICONOS_FRICTION_3D_NSGS_ERROR_EVALUATION_ADAPTIVE

Evaluation of the error with the expensive function fc3d_compute_error and an

adaptive frequncy for calling the error function. (=3)

SICONOS_FRICTION_3D_NSGS_RELAXATION

index in iparam to store the relaxation strategy (=4)

SICONOS_FRICTION_3D_NSGS_SHUFFLE

index in iparam to store the shuffle strategy (=5)

SICONOS_FRICTION_3D_NSGS_SHUFFLE_SEED

index in iparam to store the shuffle seed (=6)

SICONOS_FRICTION_3D_NSGS_FILTER_LOCAL_SOLUTION

index in iparam to store the (=14)

SICONOS_FRICTION_3D_NSN_RHO

index in dparam to store the rho value for projection formulation (= 3)

SICONOS_FRICTION_3D_NSN_HYBRID_STRATEGY_NO

No strategy for the hybrid solver. (= 0)

SICONOS_FRICTION_3D_NSN_HYBRID_STRATEGY_PLI_NSN_LOOP

Loop PLI-NSN strategy for the hybrid solver. (= 1)

SICONOS_FRICTION_3D_NSN_HYBRID_STRATEGY_NSN_AND_PLI_NSN_LOOP

NSN and after Loop PLI-NSN strategy for the hybrid solver. (= 2)

SICONOS_FRICTION_3D_NSN_HYBRID_STRATEGY_VI_EG_NSN

VI_EG preconditionning to NSN strategy for the hybrid solver. (=3)

SICONOS_FRICTION_3D_NSN_RHO_STRATEGY

index in iparam to store the strategy for computing rho (= 9)

SICONOS_FRICTION_3D_NSN_FORMULATION

index in iparam to store the formulation (= 10)

SICONOS_FRICTION_3D_NSN_LINESEARCH

index in iparam to store the line-search (= 11)

SICONOS_FRICTION_3D_NSN_LINESEARCH_MAXITER

index in iparam to store the maximum number of iterations (= 12)

SICONOS_FRICTION_3D_NSN_HYBRID_STRATEGY

index in iparam to store the strategy for the hybrid solver (= 14)

SICONOS_FRICTION_3D_NSN_HYBRID_MAX_LOOP

index in iparam to store the maximum number of loop for the hybrid solver (= 15)

SICONOS_FRICTION_3D_NSN_HYBRID_MAX_ITER

index in iparam to store the maximum number of iterations for the projection

solver (= 16)

SICONOS_FRICTION_3D_NSN_MEMORY_ALLOCATION

index in iparam to store the boolean to know if allocation of dwork is needed (= 17)

SICONOS_FRICTION_3D_NSN_MPI_COM

index in iparam to store the boolean to know if allocation of dwork is needed (= 18)

SICONOS_FRICTION_3D_NSN_FORMULATION_RHO_STRATEGY_CONSTANT

A constant value given in dparam[SICONOS_FRICTION_3D_NSN_RHO] is used. (= 0)

SICONOS_FRICTION_3D_NSN_FORMULATION_RHO_STRATEGY_SPECTRAL_NORM

A computed value stored in dparam[SICONOS_FRICTION_3D_NSN_RHO] is used. (=1)

SICONOS_FRICTION_3D_NSN_FORMULATION_RHO_STRATEGY_SPLIT_SPECTRAL_NORM_COND

A computed value stored in dparam[SICONOS_FRICTION_3D_NSN_RHO] is used. (= 2)

SICONOS_FRICTION_3D_NSN_FORMULATION_RHO_STRATEGY_SPLIT_SPECTRAL_NORM

An adaptive strategy for rho is used. (=3)

SICONOS_FRICTION_3D_NSN_FORMULATION_RHO_STRATEGY_ADAPTIVE

An adaptive strategy for rho is used. (=4)

SICONOS_FRICTION_3D_PROXIMAL_PROX

Proximal algorithm. (= 0)

SICONOS_FRICTION_3D_PROXIMAL_REGULARIZATION

Regularization algorithm. (= 1)

SICONOS_FRICTION_3D_PROXIMAL_DPARAM_ALPHA

index in dparam to store the parameter alpha (=3)

SICONOS_FRICTION_3D_FP_ERROR_STRATEGY

index in iparam to store the error strategy for the internal solver (=2)

SICONOS_FRICTION_3D_PROXIMAL_IPARAM_CUMULATIVE_ITER_DONE

index in iparam to store the relaxation strategy (=6)

SICONOS_FRICTION_3D_PROXIMAL_IPARAM_RELAXATION

index in iparam to store the relaxation strategy (=8)

SICONOS_FRICTION_3D_PROXIMAL_IPARAM_STRATEGY

index in iparam to store the proximal strategy (=9)

SICONOS_CONVEXQP_ADMM_RHO

index in dparam to store the rho value for projection formulation (= 3)

SICONOS_CONVEXQP_ADMM_RESTART_ETA

index in dparam to store the rho value for projection formulation (= 4)

SICONOS_CONVEXQP_ADMM_IPARAM_RHO_STRATEGY

index in iparam to store the strategy for computing rho (= 9)

SICONOS_CONVEXQP_ADMM_IPARAM_ACCELERATION

index in iparam to store the acceleration paramter (= 10)

SICONOS_CONVEXQP_PGOC_RHO

index in dparam to store the rho value for projection formulation (= 3)

SICONOS_CONVEXQP_PGOC_RHOMIN

index in dparam to store the minrho value for projection formulation (= 4)

SICONOS_CONVEXQP_PGOC_LINESEARCH_MU

index in dparam to store the mu value for line search algo (= 5)

SICONOS_CONVEXQP_PGOC_LINESEARCH_TAU

index in dparam to store the tau value for line search algo (= 6)

SICONOS_CONVEXQP_PGOC_LINESEARCH_MAXITER

index in iparam to store the maximum number of iterations (= 10)

SICONOS_CONVEXQP_RHO_STRATEGY_CONSTANT

A constant value given in dparam[CONVEXQP_RHO_RHO] is used. (= 0)

SICONOS_CONVEXQP_RHO_STRATEGY_ADAPTIVE

An adaptive strategy for rho is used. (=1)

SICONOS_SOCLCP_NSGS

SOCLCP solvers on local formulation. (= 1100)

SICONOS_SOCLCP_ProjectionOnCone

SOCLCP for one cone (used mainly inside NSGS solvers) (= 1150)

NM_NONE

keep nothing

NM_KEEP_FACTORS

keep all the factorization data (useful to reuse the factorization)

NM_PRESERVE

keep the matrix as-is (useful for the dense case)

NM_DENSE

dense format

NM_SPARSE_BLOCK

sparse block format

NM_SPARSE

compressed column format