Methods

{
  "name": "SimulationStartEvent",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/events/SimulationStartEvent.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 `SimulationStartEvent` is an event class within the SOFA simulation framework, specifically in the `sofa::simulation` namespace and part of the `Sofa.framework.Simulation.Core` module. This class inherits from the general `Event` class and is used to signal when it is necessary to start the animation or simulation process. The primary role of this component is to facilitate event-driven mechanisms within SOFA, notifying other components that the simulation should begin.\n\nThe `SimulationStartEvent` has minimal data fields and methods, as indicated by its API metadata. It contains methods such as `getEventTypeIndex`, which retrieves an index for the type of event, and a static method `checkEventType` to verify if an event is of this specific type. Additionally, it provides a static method `GetClassName` to return the class name as a string.\n\nInteractions with other SOFA components through the API are primarily event-based. When an instance of `SimulationStartEvent` is triggered, other parts of the simulation framework can listen for and respond to this specific event type to start various processes or actions required at the beginning of a simulation run.",
  "maths": "The `SimulationStartEvent` is an event class within the SOFA simulation framework. It does not directly contribute to any governing equations, constitutive laws, or numerical methods used in finite element simulations. Instead, it serves as a signaling mechanism for initiating the simulation process.\n\n### Role in the Global FEM Pipeline:\nThe `SimulationStartEvent` is part of the event-driven architecture within SOFA. It facilitates communication between different components by notifying them that the simulation should begin. This event does not directly participate in assembly, time integration, nonlinear solve, linear solve, constraint handling, or mapping. Its primary role is to trigger the start of these processes.\n\n### Mathematical and Physical Content:\nThe `SimulationStartEvent` has no direct mathematical content related to FEM operations such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), or constitutive laws involving strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc.\n\n### Numerical Methods and Discretization Choices:\nThe `SimulationStartEvent` does not encode any numerical methods or discretization choices. It is purely an event mechanism that signals the start of the simulation process. The actual simulation steps are handled by other components within SOFA.\n\n### Fit into Variational / Lagrangian Mechanics Framework:\nThe `SimulationStartEvent` is not directly related to variational or Lagrangian mechanics frameworks. Its role is more aligned with the control and orchestration aspects of the simulation rather than the mathematical formulation and numerical solution of FEM problems.",
  "abstract": "The `SimulationStartEvent` signals the start of the simulation process within the SOFA framework, facilitating communication between components to initiate various processes at the beginning of a simulation run.",
  "sheet": "\n# SimulationStartEvent\n\n**Overview**\nThe `SimulationStartEvent` is an event class in the `sofa::simulation` namespace and part of the `Sofa.framework.Simulation.Core` module. It inherits from the general `Event` class and serves as a signaling mechanism to notify other components that the simulation should begin. This component plays a crucial role in the event-driven architecture within SOFA, enabling the orchestration of processes at the start of a simulation.\n\n**Dependencies and Connections**\nThe `SimulationStartEvent` is typically used by components that need to be notified when the simulation starts. It fits into the scene graph as part of the event system, allowing for coordinated actions across different parts of the simulation framework.\n"
}