{
  "name": "IntegrateBeginEvent",
  "main": {
    "name": "IntegrateBeginEvent",
    "namespace": "sofa::simulation",
    "module": "Sofa.framework.Simulation.Core",
    "include": "sofa/simulation/IntegrateBeginEvent.h",
    "doc": "Event fired by IntegrateVisitor before 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"
      }
    ]
  },
  "desc": {
    "description": "The `IntegrateBeginEvent` is an event in the SOFA simulation framework, specifically part of the `sofa::simulation` namespace within the `Sofa.framework.Simulation.Core` module. It inherits from the base `Event` class and is designed to be fired by the `IntegrateVisitor` before it performs the integration detection step during a simulation process. This event facilitates communication between different components in SOFA, particularly those involved in simulation control and state management. The component provides methods such as `getEventTypeIndex`, which returns an integer representing the type index of the event, and `checkEventType`, used to verify if a given event matches this specific event type. Additionally, it includes the static method `GetClassName` for retrieving its class name."
  },
  "maths": {
    "maths": "The `IntegrateBeginEvent` in the SOFA simulation framework is an event class that does not contribute directly to any mathematical or physical equations related to finite element methods (FEM) or continuum mechanics. It serves as a signaling mechanism within the simulation pipeline rather than implementing or contributing to governing equations, constitutive laws, or numerical discretization schemes.\n\n### Mathematical and Physical Description:\n\n- **Governing Equations**: The `IntegrateBeginEvent` does not implement any specific governing equation such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), or other operators directly related to FEM.\n\n- **Constitutive Laws**: There are no constitutive laws, strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, or any kinematic laws involved in the `IntegrateBeginEvent` itself. These components are typically handled by specific force fields and mechanical objects within SOFA.\n\n- **Role in FEM Pipeline**: The `IntegrateBeginEvent` is part of the simulation control flow rather than a computational component. It signals that an integration detection step is about to begin, facilitating synchronization between different parts of the simulation framework.\n\n- **Numerical Methods and Discretization Choices**: This event does not encode any numerical methods or discretization choices directly related to FEM simulations. Instead, it acts as a trigger for other components responsible for these tasks.\n\n- **Variational / Lagrangian Mechanics Framework**: The `IntegrateBeginEvent` plays no role in the variational or Lagrangian mechanics framework. It is purely an event management component used to coordinate different phases of the simulation process."
  },
  "summary": {
    "abstract": "`IntegrateBeginEvent` signals the start of integration detection in SOFA simulations, facilitating synchronization between different simulation components.",
    "sheet": "# IntegrateBeginEvent\n\n**Overview**\n\nThe `IntegrateBeginEvent` is an event class within the `sofa::simulation` namespace that inherits from the base `Event` class. It is fired by the `IntegrateVisitor` before performing the integration detection step, enabling synchronization and communication between various components in SOFA simulations.\n\n**Dependencies and Connections**\n\nThis event typically requires interaction with the `IntegrateVisitor`, which triggers it at specific points during the simulation process. The event facilitates coordination within the scene graph by signaling that an integration detection step is about to begin, allowing other components to prepare accordingly."
  }
}