Methods

{
  "name": "IntegrateEndEvent",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/IntegrateEndEvent.h",
  "doc": "Event fired by IntegrateVisitor after performing the integrate detection step.",
  "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 `IntegrateEndEvent` is an event in the SOFA simulation framework, specifically designed to be fired by the `IntegrateVisitor` after completing its integrate detection step. This event inherits from the base `Event` class and is part of the core simulation module (`Sofa.framework.Simulation.Core`). Its primary role is to signal that a specific integration phase has concluded, facilitating coordination among different components within a simulation scenario.\n\nThrough its API, `IntegrateEndEvent` interacts with other SOFA components by allowing them to respond or react once this event occurs. This could involve triggering subsequent processes or updates based on the completion of an integrate detection step. The `getEventTypeIndex()` method returns the type index for the event, while `checkEventType(event)` is a static utility function that checks if another event matches its type. Additionally, the `GetClassName()` method provides the class name as a string.\n\nPractically, this component helps in maintaining synchronization and timing within SOFA simulations by clearly demarcating stages of integration processes.",
  "maths": "The `IntegrateEndEvent` is an event within the SOFA framework that signifies the completion of the integrate detection step by the `IntegrateVisitor`. This event does not directly contribute to any specific mathematical or physical equations or operators in the FEM simulation pipeline. Instead, it serves as a coordination mechanism for other components within the simulation scenario.\n\n### Role in the Global FEM Pipeline\n\nIn the context of the global FEM pipeline, `IntegrateEndEvent` is part of the time integration phase. Specifically, it signals that the integrate detection step has been completed, which can include tasks such as updating the state variables (e.g., displacements and velocities) based on the current system configuration.\n\n### Numerical Methods or Discretization Choices\n\nThe `IntegrateEndEvent` itself does not encode any numerical methods or discretization choices. It is purely a signaling mechanism that can be used to trigger subsequent steps in the simulation, such as advancing to the next time step, updating constraints, or performing post-processing tasks.\n\n### Broad Variational / Lagrangian Mechanics Framework\n\nWithin the broader variational and Lagrangian mechanics framework, `IntegrateEndEvent` is not directly involved with any specific equations of motion, constitutive laws, or variational principles. Its primary role is to ensure that different components within the simulation can synchronize their operations based on the completion of a particular integration step.\n\n### Summary\n\nThe `IntegrateEndEvent` does not contribute to the governing equations, constitutive laws, stiffness matrices, internal forces, or residuals in the FEM pipeline. Instead, it facilitates coordination and synchronization among different components within the SOFA simulation framework.",
  "abstract": "`IntegrateEndEvent` signals the completion of the integrate detection step in SOFA simulations, facilitating synchronization among different components.",
  "sheet": "\n# IntegrateEndEvent\n\n**Overview**\nThe `IntegrateEndEvent` is an event fired by the `IntegrateVisitor` after completing its integrate detection step. It inherits from the base `Event` class and serves as a coordination mechanism within SOFA simulations, allowing other components to react or trigger subsequent processes based on this event.\n\n**Practical Notes**\nThe `IntegrateEndEvent` is primarily used for synchronization purposes in SOFA simulations. Components can use it to ensure that certain operations are performed only after the integrate detection step has been completed. This helps maintain proper timing and coordination within complex simulation scenarios."
}