siconos.nonsmooth_formulations module

Siconos nonsmooth formulations module

class siconos.nonsmooth_formulations.FrictionContact(*args, **kwargs)

Bases: LinearOSNS

Overloaded function.

1. __init__(self: siconos.nonsmooth_formulations.FrictionContact, dimPb: typing.SupportsInt | typing.SupportsIndex = 3, numericsSolverId: typing.SupportsInt | typing.SupportsIndex = <FRICTION_SOLVER.SICONOS_FRICTION_3D_NSGS: 500>) -> None

2. __init__(self: siconos.nonsmooth_formulations.FrictionContact, dimPb: typing.SupportsInt | typing.SupportsIndex, options: siconos.numerics._numerics.SolverOptions) -> None

solve(self: siconos.nonsmooth_formulations.FrictionContact) → int

updateMu(self: siconos.nonsmooth_formulations.FrictionContact) → None

class siconos.nonsmooth_formulations.GenericMechanical(*args, **kwargs)

Bases: LinearOSNS

Overloaded function.

1. __init__(self: siconos.nonsmooth_formulations.GenericMechanical, numericsSolverId: typing.SupportsInt | typing.SupportsIndex = <FRICTION_SOLVER.SICONOS_FRICTION_3D_ONECONTACT_NSN: 550>) -> None

2. __init__(self: siconos.nonsmooth_formulations.GenericMechanical, options: siconos.numerics._numerics.SolverOptions) -> None

class siconos.nonsmooth_formulations.GlobalFrictionContact(*args, **kwargs)

Bases: LinearOSNS

Overloaded function.

1. __init__(self: siconos.nonsmooth_formulations.GlobalFrictionContact, dimPb: typing.SupportsInt | typing.SupportsIndex, numericsSolverId: typing.SupportsInt | typing.SupportsIndex = <FRICTION_SOLVER.SICONOS_GLOBAL_FRICTION_3D_NSGS: 605>) -> None

2. __init__(self: siconos.nonsmooth_formulations.GlobalFrictionContact, dimPb: typing.SupportsInt | typing.SupportsIndex, options: siconos.numerics._numerics.SolverOptions) -> None

solve(self: siconos.nonsmooth_formulations.GlobalFrictionContact) → int

updateMu(self: siconos.nonsmooth_formulations.GlobalFrictionContact) → None

class siconos.nonsmooth_formulations.GlobalRollingFrictionContact(*args, **kwargs)

Bases: GlobalFrictionContact

Overloaded function.

1. __init__(self: siconos.nonsmooth_formulations.GlobalRollingFrictionContact, dimPb: typing.SupportsInt | typing.SupportsIndex = 5, numericsSolverId: typing.SupportsInt | typing.SupportsIndex = <ROLLING_FRICTION_SOLVER_enum.SICONOS_GLOBAL_ROLLING_FRICTION_3D_NSGS_WR: 5000>) -> None

2. __init__(self: siconos.nonsmooth_formulations.GlobalRollingFrictionContact, dimPb: typing.SupportsInt | typing.SupportsIndex, options: siconos.numerics._numerics.SolverOptions) -> None

solve(self: siconos.nonsmooth_formulations.GlobalRollingFrictionContact, arg0: GlobalRollingFrictionContactProblem) → int

updateMu(self: siconos.nonsmooth_formulations.GlobalRollingFrictionContact) → None

class siconos.nonsmooth_formulations.LCP(self: siconos.nonsmooth_formulations.LCP, numericsSolverId: typing.SupportsInt | typing.SupportsIndex = <LCP_SOLVER.SICONOS_LCP_LEMKE: 200>)

Bases: LinearOSNS

solve(self: siconos.nonsmooth_formulations.LCP) → int

class siconos.nonsmooth_formulations.LinearOSNS

Bases: OneStepNSProblem

preCompute(self: siconos.nonsmooth_formulations.LinearOSNS, time: SupportsFloat | SupportsIndex) → bool

build problem coefficients (if required)

setAssemblyType(self: siconos.nonsmooth_formulations.LinearOSNS, arg0: siconos.nonsmooth_formulations.LinearOSNSAssemblyType) → None

setKeepLambdaAndYState(self: siconos.nonsmooth_formulations.LinearOSNS, arg0: bool) → None

setMStorageType(self: siconos.nonsmooth_formulations.LinearOSNS, arg0: siconos.numerics._numerics.params.NumericsMatrix_types) → None

class siconos.nonsmooth_formulations.LinearOSNSAssemblyType(self: siconos.nonsmooth_formulations.LinearOSNSAssemblyType, value: SupportsInt | SupportsIndex)

Bases: pybind11_object

Members:

REDUCED_BLOCK : Reduced block formulation

GLOBAL : Global formulation

REDUCED_DIRECT : Reduced direct formulation

GLOBAL_REDUCED : Global reduced formulation

GLOBAL = <LinearOSNSAssemblyType.GLOBAL: 1>

GLOBAL_REDUCED = <LinearOSNSAssemblyType.GLOBAL_REDUCED: 3>

REDUCED_BLOCK = <LinearOSNSAssemblyType.REDUCED_BLOCK: 0>

REDUCED_DIRECT = <LinearOSNSAssemblyType.REDUCED_DIRECT: 2>

property name

property value

class siconos.nonsmooth_formulations.MLCP(*args, **kwargs)

Bases: LinearOSNS

Overloaded function.

1. __init__(self: siconos.nonsmooth_formulations.MLCP, numericsSolverId: typing.SupportsInt | typing.SupportsIndex = <MLCP_SOLVER.SICONOS_MLCP_ENUM: 105>) -> None

2. __init__(self: siconos.nonsmooth_formulations.MLCP, options: siconos.numerics._numerics.SolverOptions) -> None

solve(self: siconos.nonsmooth_formulations.MLCP) → int

class siconos.nonsmooth_formulations.MLCPProjectOnConstraints(*args, **kwargs)

Bases: MLCP

Overloaded function.

1. __init__(self: siconos.nonsmooth_formulations.MLCPProjectOnConstraints, numericsSolverId: typing.SupportsInt | typing.SupportsIndex = <MLCP_SOLVER.SICONOS_MLCP_ENUM: 105>, alpha: typing.SupportsFloat | typing.SupportsIndex = 1.0) -> None

2. __init__(self: siconos.nonsmooth_formulations.MLCPProjectOnConstraints, options: siconos.numerics._numerics.SolverOptions, alpha: typing.SupportsFloat | typing.SupportsIndex = 1.0) -> None

class siconos.nonsmooth_formulations.OneStepNSProblem

Bases: pybind11_object

property getSizeOutput

Get the size of the output of the problem

numericsSolverOptions(self: siconos.nonsmooth_formulations.OneStepNSProblem) → siconos.numerics._numerics.SolverOptions

Access to solver options object

postCompute(self: siconos.nonsmooth_formulations.OneStepNSProblem) → None

post treatment for output of the solver

setMaxSize(self: siconos.nonsmooth_formulations.OneStepNSProblem, arg0: SupportsInt | SupportsIndex) → None

Set the maximum size of the nonsmooth problem

setNumericsVerboseMode(self: siconos.nonsmooth_formulations.OneStepNSProblem, arg0: bool) → None

Set the verbose mode for the numerics solver

setSolverId(self: siconos.nonsmooth_formulations.OneStepNSProblem, arg0: SupportsInt | SupportsIndex) → None

Set the solver ID for the problem

class siconos.nonsmooth_formulations.Relay(self: siconos.nonsmooth_formulations.Relay, numericsSolverId: typing.SupportsInt | typing.SupportsIndex = <RELAY_SOLVER.SICONOS_RELAY_AVI_CAOFERRIS: 306>)

Bases: LinearOSNS

class siconos.nonsmooth_formulations.RollingFrictionContact(*args, **kwargs)

Bases: LinearOSNS

Overloaded function.

1. __init__(self: siconos.nonsmooth_formulations.RollingFrictionContact, dimPb: typing.SupportsInt | typing.SupportsIndex = 3, numericsSolverId: typing.SupportsInt | typing.SupportsIndex = <ROLLING_FRICTION_SOLVER_enum.SICONOS_ROLLING_FRICTION_3D_NSGS: 3000>) -> None

2. __init__(self: siconos.nonsmooth_formulations.RollingFrictionContact, dimPb: typing.SupportsInt | typing.SupportsIndex, options: siconos.numerics._numerics.SolverOptions) -> None

solve(self: siconos.nonsmooth_formulations.RollingFrictionContact, arg0: RollingFrictionContactProblem) → int

updateMu(self: siconos.nonsmooth_formulations.RollingFrictionContact) → None