Methods

{
  "name": "SimulationInitDoneEvent",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/events/SimulationInitDoneEvent.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 `SimulationInitDoneEvent` is an event in the SOFA framework that indicates when the animation initialization process has completed. This event inherits from the generic `Event` class and serves as a signal to other components within the simulation pipeline, informing them that further setup or initialization steps are no longer needed. It interacts with other components through its inherited methods and provides a static method `GetClassName()` to return its class name.\n\nThis event does not have any specific data fields but includes utility functions such as `getEventTypeIndex` and `checkEventType`, which help in identifying the type of event within the framework's event handling system.",
  "maths": "The `SimulationInitDoneEvent` is an event in the SOFA framework that signifies the completion of the initialization phase for animation processes. This event inherits from the generic `Event` class and does not contribute directly to any governing equations, constitutive laws, or kinematic formulations within the Finite Element Method (FEM) simulation pipeline. It serves primarily as a signal mechanism to other components within the simulation framework.\n\nMathematically and physically, this component has no direct role in:\n- Governing equations such as mass matrix $M$, stiffness matrix $K$, internal force $\boldsymbol{f}_{int}$, or residual $\boldsymbol{R}$.\n- Constitutive laws involving strain measures, stress tensors, hyperelastic potentials, damping models, or constraint Jacobians.\n\nThe `SimulationInitDoneEvent` does not participate in assembly phases, time integration steps, nonlinear or linear resolution processes, state updates, or any other specific variational mechanics framework components. Its role is solely to provide a signal that initialization has been completed, and it does not contain any numerical methods or discretization choices.\n\nIn summary, the `SimulationInitDoneEvent` is a utility component in SOFA that indicates the end of an initialization process but has no mathematical content related to FEM simulation.",
  "abstract": "The `SimulationInitDoneEvent` signals the completion of animation initialization in SOFA simulations. It inherits from the generic `Event` class and provides utility functions to identify event types within the framework's event handling system.",
  "sheet": "\n# SimulationInitDoneEvent\n\n## Overview\n\nThe `SimulationInitDoneEvent` is an event that signals the completion of the animation initialization process in SOFA simulations. It inherits from the generic `Event` class and serves as a signal to other components within the simulation pipeline, indicating that further setup or initialization steps are no longer needed.\n\n## Practical Notes\n\nThe `SimulationInitDoneEvent` does not have any specific data fields or mathematical content related to FEM simulation. Its role is solely to provide a signal that initialization has been completed. Practitioners should ensure proper handling of this event within their simulation pipelines to avoid unnecessary further initialization steps."
}