Methods

{
  "name": "SimulationInitStartEvent",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/events/SimulationInitStartEvent.h",
  "doc": "Event fired when needed to stop the animation.",
  "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 `SimulationInitStartEvent` is an event in the SOFA framework, specifically part of the `sofa::simulation` namespace within the `Sofa.framework.Simulation.Core` module. This event is fired to signal the beginning of a simulation initialization process, marking the point where animation or simulation-related operations need to start.\n\nIt inherits from the base `Event` class and provides methods for retrieving its type index (`getEventTypeIndex`) and checking if an event matches this specific event type (`checkEventType`). The `GetClassName` method returns the name of the class as a string, which is useful for debugging or logging purposes.\n\nThe primary interaction with other SOFA components occurs through the event handling mechanisms. Other components can listen for this event to coordinate actions related to simulation initialization. This event facilitates synchronization and ensures that all dependent components are properly informed about the start of simulation operations.",
  "maths": "The `SimulationInitStartEvent` is an event in the SOFA framework designed to signal the beginning of simulation initialization processes. This event does not directly contribute to the governing equations, constitutive laws, or numerical methods used in FEM simulations. Instead, it facilitates synchronization and coordination among various components within the SOFA framework during the setup phase of a simulation.\n\n**Mathematical/Physical Description: **\n- **Governing Equations / Operators:** This event does not implement any specific governing equations or operators like mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(\textbf{f}_{int}\\), residual \\(\textbf{R}\\), etc. It primarily serves as a signal mechanism.\n- **Constitutive / Kinematic Laws:** The event does not involve any constitutive or kinematic laws such as strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc.\n- **Role in FEM Pipeline:** This event is part of the initialization phase and does not directly participate in assembly, time integration, nonlinear solve, linear solve, constraint handling, mapping, etc. It signals other components to prepare for these subsequent steps.\n- **Numerical Methods / Discretization Choices:** The `SimulationInitStartEvent` itself does not encode any numerical methods or discretization choices; its role is purely as a signaling mechanism.\n- **Variational / Lagrangian Mechanics Framework:** This event is orthogonal to the variational and Lagrangian mechanics framework, serving instead to coordinate the initialization of simulation components within SOFA.",
  "abstract": "Signals the start of simulation initialization processes, facilitating synchronization among components.",
  "sheet": "# SimulationInitStartEvent\n\n## Overview\nThe `SimulationInitStartEvent` is an event that signals the beginning of simulation initialization processes in SOFA. It inherits from the base `Event` class and provides methods to retrieve its type index (`getEventTypeIndex`) and check if an event matches this specific event type (`checkEventType`). The `GetClassName` method returns the name of the class as a string, useful for debugging or logging purposes.\n\n## Dependencies and Connections\nThis event facilitates synchronization among various components during the setup phase. Other components can listen for this event to coordinate actions related to simulation initialization."
}