Kernel component C/C++ API documentation

Check Kernel programs listings for a complete list of headers for this component.

Classes and structs

• AVI : Formalization and Resolution of an Affine Variational Inequality (AVI)

• BlockCSRMatrix : Definition of a compressed sparse row matrix of SiconosMatrix, used in OneStepNSProblem to store the M matrix.

• BlockMatrix : “Block” matrix, ie container of matrices

• BlockVector : “Block” vector : container (list) of SiconosVector

• BoundaryCondition : This class models simple boundary conditions for prescribing the velocities in a Dynamical System.

• ComplementarityConditionNSL : Complementarity NonSmoothLaw.

• D1MinusLinearOSI :

• DynamicalSystem : Abstract interface to Dynamical Systems.

• Equality : Formalization and Resolution of a Linear Complementarity Problem (Equality)

• EqualityConditionNSL : Equality NonSmoothLaw.

• EulerMoreauOSI : One Step time Integrator for First Order Dynamical Systems.

• Event : Abstract class that represents generic time events.

• EventDriven : Simulation based on event driven method, ie events detection (see theoretical manual for more details).

• EventsManager : Tools to handle a set of Events for the Simulation.

• FirstOrderLinearDS : First Order Linear Systems - \(M(t) \dot x = A(t)x(t)+ b(t) + r, \quad x(t_0)=x_0\).

• FirstOrderLinearR : First Order Linear Relation.

• FirstOrderLinearTIDS : First order linear and time-invariant coeff systems - \(M \dot x = Ax(t)+ b + r, x(t_0)=x_0\) .

• FirstOrderLinearTIR : Linear Time Invariant Relation, derived from class FirstOrderR.

• FirstOrderNonLinearDS : General First Order Non Linear Dynamical Systems.

• FirstOrderNonLinearR : FirstOrder Non Linear Relation.

• FirstOrderR : FirstOrder Relation.

• FirstOrderType1R : FirstOrder Non Linear Relation.

• FirstOrderType2R : First order non linear Relation.

• FixedBC : This class models a simple fixed boundary conditions for prescribing the velocities in a Dynamical System.

• FremondImpactFrictionNSL : Fremond Impact-Friction Non Smooth Law.

• FrictionContact : Formalization and Resolution of a Friction-Contact Problem.

• GenericMechanical : Formalization and Resolution of a generic mechanical problem: It mixes bilateral equality, complementarity, impact and friction problems.

• GlobalFrictionContact : Formalization and Resolution of a Friction-Contact Problem.

• GlobalRollingFrictionContact : Formalization and Resolution of a Friction-Contact Problem.

• HarmonicBC : This class models a simple harmonic boundary conditions for prescribing the velocities in a Dynamical System.

• Hem5OSI : Hem5OSI solver (odepack)

• Interaction : Description of a non-smooth interaction.

• InteractionManager :

• LCP : Formalization and Resolution of a Linear Complementarity Problem (LCP)

• Lagrangian2d1DR : Lagrangian2d1DR.

• Lagrangian2d2DR : Lagrangian2d2DR.

• Lagrangian2d3DR : Lagrangian2d3DR.

• LagrangianCompliantLinearTIR : Lagrangian Linear Relation.

• LagrangianCompliantR : Lagrangian Compliant Relation: Scleronomous, Non-Holonomic (function of lambda)

• LagrangianDS : Lagrangian non linear dynamical systems - \(M(q,z) \dot v = F(v, q, t, z) + p\).

• LagrangianLinearDiagonalDS : Lagrangian Linear Systems with time invariant and diagonal coefficients - \(M\dot v + Cv + Kq = F_{ext}(t,z) + p\).

• LagrangianLinearTIDS : Lagrangian Linear Systems with time invariant coefficients - \(M\dot v + Cv + Kq = F_{ext}(t,z) + p\).

• LagrangianLinearTIR : Lagrangian Linear Relation.

• LagrangianR : Lagrangian Non Linear Relation (generic interface)

• LagrangianRheonomousR : Lagrangian (Non Linear) Rheonomous Relation.

• LagrangianScleronomousR : Scleronomic Lagrangian (Non Linear) Relations.

• LinearComplementaritySystemsNSDS : The LinearComplementaritySystemsNSDS_H inherits frim NSDS for a direct instanciation of a LCS.

• LinearOSNS : Base (abstract) class for linear non-smooth problems.

• LsodarOSI : LsodarOSI solver (odepack)

• MLCP : Formalization and Resolution of a Mixed Linear Complementarity Problem (MLCP)

• MLCPProjectOnConstraints : Formalization and Resolution of a Mixed Linear Complementarity Problem (MLCP)

• MatrixIntegrator :

• MixedComplementarityConditionNSL : Complementarity NonSmoothLaw.

• MoreauJeanBilbaoOSI : One-step integrator for event-capturing simulation combining Moreau-Jean and Bilbao numerical scheme.

• MoreauJeanCombinedProjectionOSI : One Step time Integrator for First Order Dynamical Systems for mechanical Systems (LagrangianDS and NewtonEulerDS) with Combined Projection Algorithm.

• MoreauJeanDirectProjectionOSI : One Step time Integrator for First Order Dynamical Systems for mechanical Systems (LagrangianDS and NewtonEulerDS) with Direct Projection Algorithm.

• MoreauJeanGOSI : A global version of the MoreauJeanOSI integrator.

• MoreauJeanOSI : One Step time Integrator, Moreau-Jean algorithm.

• MultipleImpact : Formalization and Resolution of a Multiple Impact Non-Smooth problem.

• MultipleImpactNSL :

• NSLawMatrix : This class uses (extends) a symmetric matrix to store NonSmoothLaws associated to pairs of integers.

• NewMarkAlphaOSI : NewMarkAlpha Scheme Time-Integrator for Dynamical Systems.

• NewtonEuler1DR : This class is an interface for a relation with impact.

• NewtonEuler3DR : This class is an interface for relation with impact and FC3D.

• NewtonEuler5DR : This class is an interface for relation with impact and RFC3D.

• NewtonEulerDS : NewtonEuler non linear dynamical systems.

• NewtonEulerR : NewtonEuler (Non Linear) Relation (generic interface)

• NewtonImpactFrictionNSL : Newton Impact-Friction Non Smooth Law.

• NewtonImpactNSL : Newton impact Non Smooth Law.

• NewtonImpactRollingFrictionNSL : Newton Impact-Friction Non Smooth Law.

• NonSmoothDynamicalSystem : the NonSmoothDynamicalSystem consists in Dynamical Systems and Interactions structured into a graph defined in a Topology.

• NonSmoothEvent : Events due to non smooth behavior (contact occurence…)

• NonSmoothLaw : Non Smooth Laws (NSL) Base Class.

• NormalConeNSL : NormalCone NonSmoothLaw.

• OSNSMatrix : Interface to some specific storage types for matrices used in OneStepNSProblem.

• OSNSMatrixProjectOnConstraints : Interface to some specific storage types for matrices used in OneStepNSProblem.

• OneStepIntegrator : Generic class to manage DynamicalSystem(s) time-integration.

• OneStepNSProblem : Non Smooth Problem Formalization and Simulation.

• PluggedObject : Class to deal with plugged functions.

• QP : Quadratic Problem.

• Relation : General Non Linear Relation (Abstract Base class for Relations).

• Relay : Formalization and Resolution of a Linear Complementarity Problem (Relay)

• RelayNSL : Relay NonSmoothLaw.

• RollingFrictionContact : Formalization and Resolution of a Friction-Contact Problem.

• SchatzmanPaoliOSI : SchatzmanPaoliOSI Time-Integrator for Dynamical Systems.

• SecondOrderDS : Second Order non linear dynamical systems - \(M(q,z) \dot v = F(v, q, t, z) + p\).

• SiconosGraph :

• SiconosMatrix : Abstract class to provide interface for matrices handling.

• SiconosMemory : Interface to stl container of SiconosVector.

• SiconosVector : Vectors of double.

• SimpleMatrix : Matrix (embedded various types of Boost matrices of double)

• Simulation : Description of the simulation process (integrators, time discretisation and so on).

• SubPluggedObject :

• TimeDiscretisation : A time discretisation scheme.

• TimeDiscretisationEvent : Event that corresponds to user-defined time discretisation points.

• TimeDiscretisationEventNoSaveInMemory : Event that corresponds to user-defined time discretisation points This Event does not automatically save in memory some variables.

• TimeStepping :

• TimeSteppingCombinedProjection : Time-Stepping scheme.

• TimeSteppingD1Minus : TimeSteppingD1Minus Timestepping Strategy.

• TimeSteppingDirectProjection : Time-Stepping scheme with a direct projection onto the constraint thanks to the GGL augmentation of the system.

• Topology : This class describes the topology of the non-smooth dynamical system.

• ZeroOrderHoldOSI : ZeroOrderHoldOSI Time-Integrator for Dynamical Systems.

• ExtraAdditionalTerms :

• Question : example :

• SiconosVectorIterator :

• SiconosVisitor :

Files documentation

• AVI.hpp :

• AlgebraTools.hpp :

• BlockCSRMatrix.hpp :

• BlockMatrixIterators.hpp :

• BlockMatrix.hpp : Object to handle block-matrices.

• BlockVector.hpp : Object to handle vectors of vectors.

• BoundaryCondition.hpp :

• ComplementarityConditionNSL.hpp :

• D1MinusLinearOSI.hpp :

• DynamicalSystemFactory.hpp : Factory to generate user-defined DynamicalSystems.

• DynamicalSystemTypes.hpp : enum of the available types for dynamical systems, plugin names …

• DynamicalSystem.hpp :

• EigenProblems.hpp :

• EqualityConditionNSL.hpp :

• Equality.hpp : Linear Complementarity Problem formulation and solving.

• EulerMoreauOSI.hpp :

• EventDriven.hpp :

• EventFactory.hpp : Factory to generate user-defined Events.

• Event.hpp :

• EventsManager.hpp : Management of a Set (STL) of Events for the Simulation process.

• ExtraAdditionalTerms.hpp : base class for struct of functions adding optional integration terms

• FirstOrderLinearDS.hpp :

• FirstOrderLinearR.hpp :

• FirstOrderLinearTIDS.hpp :

• FirstOrderLinearTIR.hpp :

• FirstOrderNonLinearDS.hpp : First Order Non Linear Dynamical Systems.

• FirstOrderNonLinearR.hpp : General interface for first-order nonlinear relations.

• FirstOrderR.helpers.hpp :

• FirstOrderR.hpp :

• FirstOrderType1R.hpp :

• FirstOrderType2R.hpp : non linear relations: \(y=h(x,\lambda,z), r=g(\lambda,z)\)

• FixedBC.hpp :

• FremondImpactFrictionNSL.hpp :

• FrictionContact.hpp :

• GenericMechanical.hpp :

• GlobalFrictionContact.hpp :

• GlobalRollingFrictionContact.hpp :

• HarmonicBC.hpp :

• Hem5OSI.hpp : Hem5OSI solver (from E.

• InteractionManager.hpp : Definition of a class that manages dynamic interactions.

• Interaction.hpp : Interaction class and related typedef.

• InvertMatrix.hpp :

• LCP.hpp :

• Lagrangian2d1DR.hpp :

• Lagrangian2d2DR.hpp :

• Lagrangian2d3DR.hpp :

• LagrangianCompliantLinearTIR.hpp :

• LagrangianCompliantR.hpp :

• LagrangianDS.hpp :

• LagrangianLinearDiagonalDS.hpp :

• LagrangianLinearTIDS.hpp :

• LagrangianLinearTIR.hpp :

• LagrangianR.hpp :

• LagrangianRheonomousR.hpp :

• LagrangianScleronomousR.hpp :

• LinearComplementaritySystemsNSDS.hpp :

• LinearOSNS.hpp : Linear Complementarity Problem formulation and solving.

• LsodarOSI.hpp :

• MLCPProjectOnConstraints.hpp : Linear Complementarity Problem formulation and solving.

• MLCP.hpp : Linear Complementarity Problem formulation and solving.

• MatrixIntegrator.hpp :

• MixedComplementarityConditionNSL.hpp :

• ModelingTools.hpp :

• MoreauJeanBilbaoOSI.hpp :

• MoreauJeanCombinedProjectionOSI.hpp :

• MoreauJeanDirectProjectionOSI.hpp :

• MoreauJeanGOSI.hpp :

• MoreauJeanOSI.hpp :

• MultipleImpactNSL.hpp :

• MultipleImpact.hpp : Linear Complementarity Problem formulation and solving.

• NSLawMatrix.hpp : Base (abstract) class for a symmetric matrix of nonsmooth laws.

• NewMarkAlphaOSI.hpp :

• NewtonEuler1DR.hpp :

• NewtonEuler3DR.hpp :

• NewtonEuler5DR.hpp :

• NewtonEulerDS.hpp :

• NewtonEulerR.hpp :

• NewtonImpactFrictionNSL.hpp :

• NewtonImpactNSL.hpp :

• NewtonImpactRollingFrictionNSL.hpp :

• NonSmoothDynamicalSystem.hpp : container for DynamicalSystem and Interaction

• NonSmoothEvent.hpp :

• NonSmoothLaw.hpp :

• NormalConeNSL.hpp : formalization of the NormalCone nonsmooth law

• OSNSMatrixProjectOnConstraints.hpp :

• OSNSMatrix.hpp :

• OneStepIntegratorTypes.hpp : enum of the available types for one-step time integrators.

• OneStepIntegrator.hpp :

• OneStepNSProblem.hpp : Interface to formalize and solve Non-Sooth problems.

• PluggedObject.hpp : utilities for plugin definition to compute matrices or vectors from user-defined functions.

• PluginTypes.hpp : list of typedef for pointers to functions used in plugin mechanism.

• ProgressBar.hpp :

• QP.hpp :

• Question.hpp : ask something to a class with a visitor

• RelationFactory.hpp : Factory to generate user-defined Relations.

• RelationNamespace.hpp : Namespace related to relations.

• RelationTypes.hpp : enum of the available types and subtypes for relations, plugin names …

• Relation.hpp : General interface for relations.

• RelayNSL.hpp : formalization of the Relay nonsmooth law

• Relay.hpp : Linear Complementarity Problem formulation and solving.

• RollingFrictionContact.hpp :

• RotationQuaternion.hpp :

• SSLH.hpp :

• SchatzmanPaoliOSI.hpp :

• SecondOrderDS.hpp :

• SiconosAlgebraProd.hpp :

• SiconosAlgebraScal.hpp :

• SiconosAlgebraTools.hpp : Standalone functions used with matrices and vectors.

• SiconosAlgebraTypeDef.hpp : !

• SiconosAlgebra.hpp : !

• SiconosConst.hpp : General constants for Siconos Kernel.

• SiconosException.hpp : !

• SiconosFwd.hpp :

• SiconosGraph.hpp :

• SiconosKernel.hpp :

• SiconosMatrixSetBlock.hpp :

• SiconosMatrix.hpp :

• SiconosMemory.hpp : class SiconosMemory

• SiconosPointers.hpp :

• SiconosProperties.hpp : Exterior properties to vertices or edges of a SiconosGraph can be attach with siconos::Properties. These properties are referenced with vertices or edges indices. update_vertices_indices() or update_edges_indices() must have been done after any vertices or edges insertion or deletion.

• SiconosSerialization.hpp :

• SiconosSharedLibrary.hpp :

• SiconosVectorFriends.hpp :

• SiconosVectorIterator.hpp :

• SiconosVector.hpp :

• SiconosVisitables.hpp :

• SiconosVisitor.hpp : A general visitor interface for siconos objects.

• SimpleMatrixFriends.hpp :

• SimpleMatrix.hpp :

• SimulationGraphs.hpp :

• SimulationTools.hpp :

• SimulationTypeDef.hpp : Typedef for simulation-related objects.

• Simulation.hpp :

• SubPluggedObject.hpp : utilities for plugin definition to compute extract a column from a matrix computed by an user-defined function.

• TimeDiscretisationEventNoSaveInMemory.hpp :

• TimeDiscretisationEvent.hpp :

• TimeDiscretisation.hpp :

• TimeSteppingCombinedProjection.hpp :

• TimeSteppingD1Minus.hpp :

• TimeSteppingDirectProjection.hpp :

• TimeStepping.hpp : Time-Stepping simulation.

• Tools.hpp :

• Topology.hpp : Describes the topology of the DynamicalSystem and Interaction in the Simulation.

• TypeName.hpp : get a string name from visitable classes

• Utils.hpp :

• VisitorMaker.hpp : Generation of visitors on base classes.

• ZeroOrderHoldOSI.hpp :

• ioMatrix.hpp : input/output for SiconosMatrix

• ioVector.hpp :