LinearSolverConstraintCorrection
Component computing constraint forces within a simulated body using the compliance method.
Rigid3d
Templates:
- Rigid3d
Target: Sofa.Component.Constraint.Lagrangian.Correction
namespace: sofa::component::constraint::lagrangian::correction
parents:
- ConstraintCorrection
Data
| Name | Description | Default value | 
|---|---|---|
| name | object name | unnamed | 
| printLog | if true, emits extra messages at runtime. | 0 | 
| tags | list of the subsets the object belongs to | |
| bbox | this object bounding box | |
| componentState | The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). | Undefined | 
| listening | if true, handle the events, otherwise ignore the events | 0 | 
| wire_optimization | constraints are reordered along a wire-like topology (from tip to base) | 0 | 
| regularizationTerm | Add regularization factor times the identity matrix to the compliance W when solving constraints | 0 | 
Links
| Name | Description | Destination type name | 
|---|---|---|
| context | Graph Node containing this object (or BaseContext::getDefault() if no graph is used) | BaseContext | 
| slaves | Sub-objects used internally by this object | BaseObject | 
| master | nullptr for regular objects, or master object for which this object is one sub-objects | BaseObject | 
| mechanicalStates | List of mechanical states to which this component is associated | BaseMechanicalState | 
| mstate | MechanicalState used by this component | MechanicalState<Rigid3d> | 
| constraintSolvers | Constraint solvers using this constraint correction | ConstraintSolver | 
| linearSolver | Link towards the linear solver used to compute the compliance matrix, requiring the inverse of the linear system matrix | LinearSolver | 
| ODESolver | Link towards the ODE solver used to recover the integration factors | OdeSolver | 
Vec1d
Templates:
- Vec1d
Target: Sofa.Component.Constraint.Lagrangian.Correction
namespace: sofa::component::constraint::lagrangian::correction
parents:
- ConstraintCorrection
Data
| Name | Description | Default value | 
|---|---|---|
| name | object name | unnamed | 
| printLog | if true, emits extra messages at runtime. | 0 | 
| tags | list of the subsets the object belongs to | |
| bbox | this object bounding box | |
| componentState | The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). | Undefined | 
| listening | if true, handle the events, otherwise ignore the events | 0 | 
| wire_optimization | constraints are reordered along a wire-like topology (from tip to base) | 0 | 
| regularizationTerm | Add regularization factor times the identity matrix to the compliance W when solving constraints | 0 | 
Links
| Name | Description | Destination type name | 
|---|---|---|
| context | Graph Node containing this object (or BaseContext::getDefault() if no graph is used) | BaseContext | 
| slaves | Sub-objects used internally by this object | BaseObject | 
| master | nullptr for regular objects, or master object for which this object is one sub-objects | BaseObject | 
| mechanicalStates | List of mechanical states to which this component is associated | BaseMechanicalState | 
| mstate | MechanicalState used by this component | MechanicalState<Vec1d> | 
| constraintSolvers | Constraint solvers using this constraint correction | ConstraintSolver | 
| linearSolver | Link towards the linear solver used to compute the compliance matrix, requiring the inverse of the linear system matrix | LinearSolver | 
| ODESolver | Link towards the ODE solver used to recover the integration factors | OdeSolver | 
Vec2d
Templates:
- Vec2d
Target: Sofa.Component.Constraint.Lagrangian.Correction
namespace: sofa::component::constraint::lagrangian::correction
parents:
- ConstraintCorrection
Data
| Name | Description | Default value | 
|---|---|---|
| name | object name | unnamed | 
| printLog | if true, emits extra messages at runtime. | 0 | 
| tags | list of the subsets the object belongs to | |
| bbox | this object bounding box | |
| componentState | The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). | Undefined | 
| listening | if true, handle the events, otherwise ignore the events | 0 | 
| wire_optimization | constraints are reordered along a wire-like topology (from tip to base) | 0 | 
| regularizationTerm | Add regularization factor times the identity matrix to the compliance W when solving constraints | 0 | 
Links
| Name | Description | Destination type name | 
|---|---|---|
| context | Graph Node containing this object (or BaseContext::getDefault() if no graph is used) | BaseContext | 
| slaves | Sub-objects used internally by this object | BaseObject | 
| master | nullptr for regular objects, or master object for which this object is one sub-objects | BaseObject | 
| mechanicalStates | List of mechanical states to which this component is associated | BaseMechanicalState | 
| mstate | MechanicalState used by this component | MechanicalState<Vec2d> | 
| constraintSolvers | Constraint solvers using this constraint correction | ConstraintSolver | 
| linearSolver | Link towards the linear solver used to compute the compliance matrix, requiring the inverse of the linear system matrix | LinearSolver | 
| ODESolver | Link towards the ODE solver used to recover the integration factors | OdeSolver | 
Vec3d
Templates:
- Vec3d
Target: Sofa.Component.Constraint.Lagrangian.Correction
namespace: sofa::component::constraint::lagrangian::correction
parents:
- ConstraintCorrection
Data
| Name | Description | Default value | 
|---|---|---|
| name | object name | unnamed | 
| printLog | if true, emits extra messages at runtime. | 0 | 
| tags | list of the subsets the object belongs to | |
| bbox | this object bounding box | |
| componentState | The state of the component among (Dirty, Valid, Undefined, Loading, Invalid). | Undefined | 
| listening | if true, handle the events, otherwise ignore the events | 0 | 
| wire_optimization | constraints are reordered along a wire-like topology (from tip to base) | 0 | 
| regularizationTerm | Add regularization factor times the identity matrix to the compliance W when solving constraints | 0 | 
Links
| Name | Description | Destination type name | 
|---|---|---|
| context | Graph Node containing this object (or BaseContext::getDefault() if no graph is used) | BaseContext | 
| slaves | Sub-objects used internally by this object | BaseObject | 
| master | nullptr for regular objects, or master object for which this object is one sub-objects | BaseObject | 
| mechanicalStates | List of mechanical states to which this component is associated | BaseMechanicalState | 
| mstate | MechanicalState used by this component | MechanicalState<Vec3d> | 
| constraintSolvers | Constraint solvers using this constraint correction | ConstraintSolver | 
| linearSolver | Link towards the linear solver used to compute the compliance matrix, requiring the inverse of the linear system matrix | LinearSolver | 
| ODESolver | Link towards the ODE solver used to recover the integration factors | OdeSolver |