FixedLagrangianConstraint
This component belongs to the category of Constraint Laws used for the Lagrange constraint resolution. The FixedLagrangianConstraint defines a holonomic constraint law applied on some degrees on freedom to fix them in space.
The constraint equation can be written as:
\[
\Phi(q) = q - q_0
\]
where \(q\) is the position and \(q_0\) is the initial position.
The constraint matrix \(\mathbf{H}\) (derivative of the constraint law) is then filled with blocks of the identity matrix (of the dimension of the number of degrees of freedom per point) under each considered fixed index. If fixAll is selected, then this Jacobian is the identity matrix.
\[
\mathbf{H} = \mathbf{I}
\]
Lagrangian-based fixation of DOFs of the model.
Rigid3d
Templates:
- Rigid3d
Target: Sofa.Component.Constraint.Lagrangian.Model
namespace: sofa::component::constraint::lagrangian::model
parents:
- Constraint
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 |
| group | ID of the group containing this constraint. This ID is used to specify which constraints are solved by which solver, by specifying in each solver which groups of constraints it should handle. | 0 |
| constraintIndex | Constraint index (first index in the right hand term resolution vector) | 0 |
| endTime | The constraint stops acting after the given value. Use a negative value for infinite constraints | -1 |
| indices | Indices of points to fix | |
| fixAll | If true, fix all points | 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> |
Vec1d
Templates:
- Vec1d
Target: Sofa.Component.Constraint.Lagrangian.Model
namespace: sofa::component::constraint::lagrangian::model
parents:
- Constraint
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 |
| group | ID of the group containing this constraint. This ID is used to specify which constraints are solved by which solver, by specifying in each solver which groups of constraints it should handle. | 0 |
| constraintIndex | Constraint index (first index in the right hand term resolution vector) | 0 |
| endTime | The constraint stops acting after the given value. Use a negative value for infinite constraints | -1 |
| indices | Indices of points to fix | |
| fixAll | If true, fix all points | 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> |
Vec2d
Templates:
- Vec2d
Target: Sofa.Component.Constraint.Lagrangian.Model
namespace: sofa::component::constraint::lagrangian::model
parents:
- Constraint
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 |
| group | ID of the group containing this constraint. This ID is used to specify which constraints are solved by which solver, by specifying in each solver which groups of constraints it should handle. | 0 |
| constraintIndex | Constraint index (first index in the right hand term resolution vector) | 0 |
| endTime | The constraint stops acting after the given value. Use a negative value for infinite constraints | -1 |
| indices | Indices of points to fix | |
| fixAll | If true, fix all points | 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> |
Vec3d
Templates:
- Vec3d
Target: Sofa.Component.Constraint.Lagrangian.Model
namespace: sofa::component::constraint::lagrangian::model
parents:
- Constraint
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 |
| group | ID of the group containing this constraint. This ID is used to specify which constraints are solved by which solver, by specifying in each solver which groups of constraints it should handle. | 0 |
| constraintIndex | Constraint index (first index in the right hand term resolution vector) | 0 |
| endTime | The constraint stops acting after the given value. Use a negative value for infinite constraints | -1 |
| indices | Indices of points to fix | |
| fixAll | If true, fix all points | 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> |
Vec6d
Templates:
- Vec6d
Target: Sofa.Component.Constraint.Lagrangian.Model
namespace: sofa::component::constraint::lagrangian::model
parents:
- Constraint
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 |
| group | ID of the group containing this constraint. This ID is used to specify which constraints are solved by which solver, by specifying in each solver which groups of constraints it should handle. | 0 |
| constraintIndex | Constraint index (first index in the right hand term resolution vector) | 0 |
| endTime | The constraint stops acting after the given value. Use a negative value for infinite constraints | -1 |
| indices | Indices of points to fix | |
| fixAll | If true, fix all points | 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<Vec6d> |