siconos package

siconos, a Python package dedicated to

nonsmooth systems modelisation and simulation.

Subpackages

• siconos.io package
  • Submodules
    • siconos.io.FrictionContactTrace module
    • siconos.io.mechanics_hdf5 module
    • siconos.io.mechanics_run module
    • siconos.io.pprocess module
    • siconos.io.rocks_generator module
    • siconos.io.shape_collection module
    • siconos.io.tools module
    • siconos.io.vview module
• siconos.mechanics package
  • Subpackages
    • siconos.mechanics.collision package
    • siconos.mechanics.fem package
    • siconos.mechanics.joints package
  • Submodules
    • siconos.mechanics.quaternions module
• siconos.numerics package

Submodules

• siconos.geometry module
  • quaternionFromRotationVector()
  • rewriteVectorFromAbsoluteToBodyFrame()
  • rewriteVectorFromBodyToAbsoluteFrame()
  • rotationVectorFromQuaternion()
• siconos.integrators module
  • EulerMoreauOSI
    • EulerMoreauOSI.gamma
    • EulerMoreauOSI.theta
    • EulerMoreauOSI.useGamma
    • EulerMoreauOSI.useGammaForRelation
  • MoreauJeanDirectProjectionOSI
  • MoreauJeanGOSI
  • MoreauJeanOSI
    • MoreauJeanOSI.computeWorkForces()
    • MoreauJeanOSI.gamma
    • MoreauJeanOSI.setConstraintActivationThreshold()
    • MoreauJeanOSI.theta
  • OneStepIntegrator
  • disable_solver_check()
  • enable_solver_check()
• siconos.modeling module
  • BoundaryCondition
    • BoundaryCondition.computePrescribedVelocity()
    • BoundaryCondition.prescribedVelocity
    • BoundaryCondition.setComputePrescribedVelocityFunction()
    • BoundaryCondition.size
    • BoundaryCondition.velocityIndices
  • ComplementarityConditionNSL
  • DynamicalSystem
    • DynamicalSystem.dimension
    • DynamicalSystem.display()
    • DynamicalSystem.number()
    • DynamicalSystem.r()
    • DynamicalSystem.resetCount()
    • DynamicalSystem.resetToInitialState()
    • DynamicalSystem.setNumber()
    • DynamicalSystem.swapInMemory()
    • DynamicalSystem.x()
  • EqualityConditionNSL
  • FirstOrderLinearDS
    • FirstOrderLinearDS.A
    • FirstOrderLinearDS.b
    • FirstOrderLinearDS.computeb()
    • FirstOrderLinearDS.setComputebVectorFunction()
    • FirstOrderLinearDS.setConstantA()
    • FirstOrderLinearDS.setConstantbVector()
  • FirstOrderLinearR
    • FirstOrderLinearR.setConstantBAlias()
    • FirstOrderLinearR.setConstantCAlias()
  • FirstOrderLinearTIR
    • FirstOrderLinearTIR.display()
    • FirstOrderLinearTIR.setConstantD()
  • FirstOrderNonLinearDS
    • FirstOrderNonLinearDS.MMatrix
    • FirstOrderNonLinearDS.setConstantMMatrix()
  • FirstOrderR
  • FremondImpactFrictionNSL
  • HarmonicBC
  • Interaction
    • Interaction.computeInput()
    • Interaction.computeOutput()
    • Interaction.lambda_python()
    • Interaction.relation()
    • Interaction.y()
  • Lagrangian2d1DR
    • Lagrangian2d1DR.distance()
  • Lagrangian2d2DR
    • Lagrangian2d2DR.distance()
  • Lagrangian2d3DR
    • Lagrangian2d3DR.distance()
  • LagrangianDS
    • LagrangianDS.computeFext()
    • LagrangianDS.computeFgyr()
    • LagrangianDS.computeFint()
    • LagrangianDS.computeJacobianTotalForcesOver_q()
    • LagrangianDS.computeJacobianTotalForcesOver_velocity()
    • LagrangianDS.computeKineticEnergy()
    • LagrangianDS.computeMass()
    • LagrangianDS.computeTotalForces()
    • LagrangianDS.fext
    • LagrangianDS.fgyr
    • LagrangianDS.fint
    • LagrangianDS.jacobianTotalForcesOver_q
    • LagrangianDS.jacobianTotalForcesOver_velocity
    • LagrangianDS.mass
    • LagrangianDS.mass_alias
    • LagrangianDS.q()
    • LagrangianDS.q0
    • LagrangianDS.resetToInitialState()
    • LagrangianDS.reset_q0()
    • LagrangianDS.reset_velocity0()
    • LagrangianDS.setComputeFextFunction()
    • LagrangianDS.setComputeFgyrFunction()
    • LagrangianDS.setComputeFintFunction()
    • LagrangianDS.setComputeMassFunction()
    • LagrangianDS.setConstantFext()
    • LagrangianDS.setConstantMass()
    • LagrangianDS.totalForces
    • LagrangianDS.velocity()
    • LagrangianDS.velocity0
  • LagrangianLinearDiagonalDS
    • LagrangianLinearDiagonalDS.dampingMatrix
    • LagrangianLinearDiagonalDS.massMatrix
    • LagrangianLinearDiagonalDS.setDampingMatrix()
    • LagrangianLinearDiagonalDS.setMassMatrix()
    • LagrangianLinearDiagonalDS.setStiffnessMatrix()
    • LagrangianLinearDiagonalDS.stiffnessMatrix
  • LagrangianLinearTIDS
    • LagrangianLinearTIDS.dampingMatrix
    • LagrangianLinearTIDS.setDampingMatrix()
    • LagrangianLinearTIDS.setStiffnessMatrix()
    • LagrangianLinearTIDS.stiffnessMatrix
  • LagrangianLinearTIR
    • LagrangianLinearTIR.display()
  • LagrangianR
  • LagrangianScleronomousR
  • LagrangianSparseDS
    • LagrangianSparseDS.computeFext()
    • LagrangianSparseDS.computeJacobianFgyrOver_q()
    • LagrangianSparseDS.computeJacobianFgyrOver_velocity()
    • LagrangianSparseDS.computeJacobianFintOver_q()
    • LagrangianSparseDS.computeJacobianFintOver_velocity()
    • LagrangianSparseDS.computeMass()
    • LagrangianSparseDS.fext
    • LagrangianSparseDS.hasConstantJacobianTotalForcesOver_q()
    • LagrangianSparseDS.hasConstantJacobianTotalForcesOver_velocity()
    • LagrangianSparseDS.hasConstantMass()
    • LagrangianSparseDS.hasJacobianFgyrOver_q()
    • LagrangianSparseDS.hasJacobianFgyrOver_velocity()
    • LagrangianSparseDS.hasJacobianFintOver_q()
    • LagrangianSparseDS.hasJacobianFintOver_velocity()
    • LagrangianSparseDS.hasMass()
    • LagrangianSparseDS.jacobianFgyrOver_q_alias
    • LagrangianSparseDS.jacobianFgyrOver_q_view
    • LagrangianSparseDS.jacobianFgyrOver_velocity_alias
    • LagrangianSparseDS.jacobianFgyrOver_velocity_view
    • LagrangianSparseDS.jacobianFintOver_q_alias
    • LagrangianSparseDS.jacobianFintOver_q_view
    • LagrangianSparseDS.jacobianFintOver_velocity_alias
    • LagrangianSparseDS.jacobianFintOver_velocity_view
    • LagrangianSparseDS.mass_alias
    • LagrangianSparseDS.mass_view
    • LagrangianSparseDS.q()
    • LagrangianSparseDS.q0
    • LagrangianSparseDS.resetToInitialState()
    • LagrangianSparseDS.reset_q0()
    • LagrangianSparseDS.reset_velocity0()
    • LagrangianSparseDS.setComputeFextFunction()
    • LagrangianSparseDS.setComputeJacobianFgyrOver_qFunction()
    • LagrangianSparseDS.setComputeJacobianFgyrOver_velocityFunction()
    • LagrangianSparseDS.setComputeJacobianFintOver_qFunction()
    • LagrangianSparseDS.setComputeJacobianFintOver_velocityFunction()
    • LagrangianSparseDS.setComputeMassFunction()
    • LagrangianSparseDS.setConstantFext()
    • LagrangianSparseDS.setConstantJacobianFgyrOver_q()
    • LagrangianSparseDS.setConstantJacobianFgyrOver_velocity()
    • LagrangianSparseDS.setConstantJacobianFintOver_q()
    • LagrangianSparseDS.setConstantJacobianFintOver_velocity()
    • LagrangianSparseDS.setConstantMass()
    • LagrangianSparseDS.velocity()
    • LagrangianSparseDS.velocity0
  • LagrangianSparseLinearTIDS
    • LagrangianSparseLinearTIDS.damping_alias
    • LagrangianSparseLinearTIDS.damping_view
    • LagrangianSparseLinearTIDS.setDampingMatrix()
    • LagrangianSparseLinearTIDS.setStiffnessMatrix()
    • LagrangianSparseLinearTIDS.stiffness_alias
    • LagrangianSparseLinearTIDS.stiffness_view
  • NewtonEuler1DR
    • NewtonEuler1DR.distance()
  • NewtonEuler3DR
  • NewtonEuler5DR
  • NewtonEulerDS
    • NewtonEulerDS.angularVelocity()
    • NewtonEulerDS.angularVelocityInBodyFrame()
    • NewtonEulerDS.computeKineticEnergy()
    • NewtonEulerDS.fext()
    • NewtonEulerDS.fint
    • NewtonEulerDS.linearVelocity()
    • NewtonEulerDS.q()
    • NewtonEulerDS.q0
    • NewtonEulerDS.resetToInitialState()
    • NewtonEulerDS.reset_q0()
    • NewtonEulerDS.reset_twist0()
    • NewtonEulerDS.scalarMass
    • NewtonEulerDS.setComputeFextFunction()
    • NewtonEulerDS.setComputeJacobianMintOver_q_byFD()
    • NewtonEulerDS.setComputeMextFunction()
    • NewtonEulerDS.setConstantFext()
    • NewtonEulerDS.setConstantMext()
    • NewtonEulerDS.setIsMextExpressedInInertialFrame()
    • NewtonEulerDS.totalInertiaMatrix
    • NewtonEulerDS.twist()
    • NewtonEulerDS.twist0
  • NewtonEulerR
    • NewtonEulerR.haseVector()
  • NewtonImpactFrictionNSL
  • NewtonImpactNSL
    • NewtonImpactNSL.e
  • NewtonImpactRollingFrictionNSL
  • NonSmoothDynamicalSystem
    • NonSmoothDynamicalSystem.displayDynamicalSystems()
    • NonSmoothDynamicalSystem.dynamicalSystem()
    • NonSmoothDynamicalSystem.dynamicalSystemsVector()
    • NonSmoothDynamicalSystem.getNumberOfDS()
    • NonSmoothDynamicalSystem.insertDynamicalSystem()
    • NonSmoothDynamicalSystem.interaction()
    • NonSmoothDynamicalSystem.link()
    • NonSmoothDynamicalSystem.removeDynamicalSystem()
    • NonSmoothDynamicalSystem.setName()
    • NonSmoothDynamicalSystem.setTitle()
    • NonSmoothDynamicalSystem.topology()
  • NonSmoothLaw
    • NonSmoothLaw.size
  • Relation
  • RelayNSL
  • SecondOrderDS
    • SecondOrderDS.p()
    • SecondOrderDS.reactionToBoundaryConditions()
    • SecondOrderDS.setBoundaryConditions()
  • interactions()
• siconos.nonsmooth_formulations module
  • FrictionContact
    • FrictionContact.solve()
    • FrictionContact.updateMu()
  • GenericMechanical
  • GlobalFrictionContact
    • GlobalFrictionContact.solve()
    • GlobalFrictionContact.updateMu()
  • GlobalRollingFrictionContact
    • GlobalRollingFrictionContact.solve()
    • GlobalRollingFrictionContact.updateMu()
  • LCP
    • LCP.solve()
  • LinearOSNS
    • LinearOSNS.preCompute()
    • LinearOSNS.setAssemblyType()
    • LinearOSNS.setKeepLambdaAndYState()
    • LinearOSNS.setMStorageType()
  • LinearOSNSAssemblyType
    • LinearOSNSAssemblyType.GLOBAL
    • LinearOSNSAssemblyType.GLOBAL_REDUCED
    • LinearOSNSAssemblyType.REDUCED_BLOCK
    • LinearOSNSAssemblyType.REDUCED_DIRECT
    • LinearOSNSAssemblyType.name
    • LinearOSNSAssemblyType.value
  • MLCP
    • MLCP.solve()
  • MLCPProjectOnConstraints
  • OneStepNSProblem
    • OneStepNSProblem.getSizeOutput
    • OneStepNSProblem.numericsSolverOptions()
    • OneStepNSProblem.postCompute()
    • OneStepNSProblem.setMaxSize()
    • OneStepNSProblem.setNumericsVerboseMode()
    • OneStepNSProblem.setSolverId()
  • Relay
  • RollingFrictionContact
    • RollingFrictionContact.solve()
    • RollingFrictionContact.updateMu()
• siconos.pb11_template module
  • ClassA
    • ClassA.computeMatrix1()
    • ClassA.computeVector2()
    • ClassA.computeVectorNameDirect()
    • ClassA.computeVectorNameSpan()
    • ClassA.matrix1
    • ClassA.setComputeMatrix1Function()
    • ClassA.setComputeVector2Function()
    • ClassA.setComputeVectorNameDirectFunction()
    • ClassA.setComputeVectorNameSpanFunction()
    • ClassA.setConstantMatrix1()
    • ClassA.setConstantVector2()
    • ClassA.setConstantVectorNameDirect()
    • ClassA.setConstantVectorNameSpan()
    • ClassA.var()
    • ClassA.vector2()
    • ClassA.vectorNameDirect()
    • ClassA.vectorNameSpan()
• siconos.plot_config module
  • choose_backend()
• siconos.simulation module
  • InteractionManager
    • InteractionManager.insertNonSmoothLaw()
    • InteractionManager.nonSmoothLaw()
    • InteractionManager.updateInteractions()
  • InteractionsGraph
  • Simulation
    • Simulation.applyNSDSChangelogForDS()
    • Simulation.clearNSDSChangeLog()
    • Simulation.computeInitialStateOfTheStep()
    • Simulation.computeIteration()
    • Simulation.computeOneStepNSProblem()
    • Simulation.computeResidu()
    • Simulation.firstInitialize()
    • Simulation.hasNextEvent()
    • Simulation.indexSet()
    • Simulation.initializeIndexSets()
    • Simulation.initializeNSDSChangelog()
    • Simulation.initializeOSIAssociations()
    • Simulation.initializeOneStepNSProblem()
    • Simulation.insertInteractionManager()
    • Simulation.insertNonSmoothProblem()
    • Simulation.lambda_input()
    • Simulation.nextTime()
    • Simulation.numberOfOSNSProblems
    • Simulation.oneStepNSProblem()
    • Simulation.startingTime()
    • Simulation.updateAllInput()
    • Simulation.updateAndSwapAllOutput()
    • Simulation.updateDSPlugins()
    • Simulation.updateIndexSets()
    • Simulation.updateInteractions()
    • Simulation.updateOutput()
    • Simulation.updateState()
    • Simulation.updateWorldFromDS()
    • Simulation.y_output()
  • TimeDiscretisation
  • TimeStepping
    • TimeStepping.DefaultCheckSolverOutput()
    • TimeStepping.computeFreeState()
    • TimeStepping.computeOneStep()
    • TimeStepping.displayNewtonConvergence()
    • TimeStepping.displayNewtonConvergenceAtTheEnd()
    • TimeStepping.displayNewtonConvergenceInTheLoop()
    • TimeStepping.insertIntegrator()
    • TimeStepping.newtonCheckConvergence()
    • TimeStepping.newtonMaxIteration
    • TimeStepping.newtonOptions
    • TimeStepping.newtonTolerance
    • TimeStepping.nextStep()
    • TimeStepping.prepareNewtonIteration()
    • TimeStepping.resetLambdas()
    • TimeStepping.setDisplayNewtonConvergence()
    • TimeStepping.setNewtonMaxIteration()
    • TimeStepping.setNewtonOptions()
    • TimeStepping.setNewtonTolerance()
    • TimeStepping.setNewtonWarningOnNonConvergence()
    • TimeStepping.setSkipLastUpdateInput()
    • TimeStepping.setSkipLastUpdateOutput()
    • TimeStepping.setSkipResetLambdas()
    • TimeStepping.setWarningNonsmoothSolver()
    • TimeStepping.skipLastUpdateInput()
    • TimeStepping.skipLastUpdateOutput()
    • TimeStepping.skipResetLambdas
    • TimeStepping.timeStep()
  • TimeSteppingDirectProjection
    • TimeSteppingDirectProjection.advanceToEvent()
    • TimeSteppingDirectProjection.computeCriteria()
    • TimeSteppingDirectProjection.nextStep()
    • TimeSteppingDirectProjection.setConstraintTol()
    • TimeSteppingDirectProjection.setConstraintTolUnilateral()
    • TimeSteppingDirectProjection.setProjectionMaxIteration()
  • TimeSteppingType
    • TimeSteppingType.LINEAR
    • TimeSteppingType.LINEAR_IMPLICIT
    • TimeSteppingType.NONLINEAR
    • TimeSteppingType.NONLINEAR_FULL
    • TimeSteppingType.name
    • TimeSteppingType.value
  • Topology
    • Topology.getDynamicalSystem()
    • Topology.getInteraction()
    • Topology.indexSetsSize()
    • Topology.numberOfIndexSet()
• siconos.utils module
  • parse_cmake_list()
  • parse_cmake_info()
  • format_list_multiline()