Methods

{
  "name": "PositionEvent",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/PositionEvent.h",
  "doc": "Event modify the position of model",
  "inherits": [
    "Event"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "getEventTypeIndex",
      "return_type": "int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "checkEventType",
      "return_type": "bool",
      "params": [
        {
          "name": "event",
          "type": "const Event *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "GetClassName",
      "return_type": "const char *",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    }
  ],
  "description": "The `PositionEvent` class in the SOFA framework is designed to modify the position of models within simulations. It inherits from the base `Event` class, indicating that it represents an event capable of altering simulation states dynamically.\n\n### Role and Purpose:\nThe primary role of `PositionEvent` is to provide a mechanism for changing model positions during runtime. This can be crucial for dynamic scenarios where external forces or user interactions necessitate position adjustments in real-time.\n\n### Interactions with Other Components:\n- **Inheritance from Event:** As a subclass of `sofa::core::objectmodel::Event`, `PositionEvent` integrates seamlessly into the event handling mechanism of SOFA. This allows it to participate in the framework's event-driven architecture, enabling coordination with other events and components.\n\n### Practical Usage Guidance:\nThe component does not expose explicit data fields or methods that directly manipulate model positions. Instead, its primary role is to serve as a signal or trigger for position modifications. Users should ensure they have appropriate listeners or handlers within the simulation pipeline to interpret `PositionEvent` and apply necessary changes to the model's position.\n\n### Data Fields:\nThe metadata provided does not list any specific data fields, indicating that `PositionEvent` itself is lightweight and acts more as a signal rather than carrying significant state information.",
  "maths": "The `PositionEvent` class in the SOFA framework is designed to modify the position of models within simulations. It inherits from the base `sofa::core::objectmodel::Event` class, indicating that it represents an event capable of altering simulation states dynamically.\n\n### Role and Purpose:\nThe primary role of `PositionEvent` is to provide a mechanism for changing model positions during runtime. This can be crucial for dynamic scenarios where external forces or user interactions necessitate position adjustments in real-time. The component itself does not contain any explicit mathematical equations, constitutive laws, or FEM operators. Instead, it serves as an event signal that triggers position modifications elsewhere within the simulation framework.\n\n### Governing Equations and Operators:\nThe `PositionEvent` class is primarily a trigger for changing positions rather than directly implementing governing equations such as mass matrices (\\(M\")), stiffness matrices (\\(K\")), internal forces (\\(f_{int}\")), or residuals (\\(R\")). It does not contain explicit strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, or similar mathematical constructs. Instead, it relies on other components in the simulation pipeline to interpret and apply these changes.\n\n### Constitutive or Kinematic Laws Involved:\nThe `PositionEvent` itself does not involve any constitutive or kinematic laws directly. It serves as a signal that can be interpreted by other parts of the simulation framework (such as force fields, constraints, or solvers) to modify the state of the model accordingly.\n\n### Role in the Global FEM Pipeline:\nThe `PositionEvent` class fits into the broader variational / Lagrangian mechanics framework by serving as a trigger for position modifications. It does not directly contribute to assembly, time integration, nonlinear solve, linear solve, constraint handling, or mapping processes within the FEM pipeline. Instead, it signals other components in the simulation that a modification is required, and those components then apply the appropriate mathematical operations (e.g., updating positions, recomputing internal forces) as needed.\n\n### Numerical Methods or Discretization Choices:\nThe `PositionEvent` does not encode any specific numerical methods or discretization choices. It merely acts as an event that can be interpreted by other components to modify simulation state.\n\n### Integration into Variational / Lagrangian Mechanics Framework:\nThe `PositionEvent` integrates into the broader variational / Lagrangian mechanics framework by providing a mechanism for external interventions in the simulation. While it does not directly contribute mathematical content, its use enables dynamic adjustments that can be crucial for interactive simulations where user input or real-time changes need to modify model positions.",
  "abstract": "`PositionEvent` modifies the position of models within simulations by serving as an event trigger in SOFA's event-driven architecture.",
  "sheet": "# PositionEvent\n\n**Overview**\n\nThe `PositionEvent` class is designed to modify the position of models during runtime. It inherits from the base `sofa::core::objectmodel::Event` class, allowing it to integrate seamlessly into SOFA’s event handling mechanism and coordinate with other events and components.\n\n**Practical Notes**\n\nThe component itself does not expose any explicit data fields or methods for direct position manipulation. Instead, its primary role is to serve as a signal or trigger for position modifications. Users should ensure they have appropriate listeners or handlers within the simulation pipeline to interpret `PositionEvent` and apply necessary changes to the model's position."
}