{
  "name": "IdleEvent",
  "main": {
    "name": "IdleEvent",
    "namespace": "sofa::core::objectmodel",
    "module": "Sofa.framework.Core",
    "include": "sofa/core/objectmodel/IdleEvent.h",
    "doc": "@author Damien Marchal\n    @brief This event is propagated along the objects hierarchy at regular interval.",
    "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 `IdleEvent` is part of the SOFA framework and belongs to the `sofa::core::objectmodel` namespace within the `Sofa.framework.Core` module. It inherits from the `Event` class, which means it handles specific events in the simulation context.\n\n**Role and Purpose:**\nThis event is propagated along the objects hierarchy at regular intervals, typically when there are no other critical tasks to process or during idle periods of the simulation loop. This allows for periodic updates or actions that need to be taken without interfering with real-time performance-critical tasks.\n\n**Interactions with Other Components:*\nThe `IdleEvent` interacts with the SOFA event system and propagates through the object hierarchy via its inherited methods from the `Event` class. The `checkEventType` method, which is static, allows for type checking between events.\n\n**Practical Usage Guidance:**\nDevelopers can use this event to trigger actions that need periodic execution but are not time-sensitive, such as logging, debugging messages, or maintenance tasks. It should be used cautiously to avoid performance degradation by keeping the operations lightweight and non-blocking."
  },
  "maths": {
    "maths": "The `IdleEvent` component in the SOFA framework is an event handler that propagates through the simulation's object hierarchy at regular intervals. It does not directly contribute to any specific governing equations or operators related to FEM simulations such as mass matrix $M$, stiffness matrix $K$, internal force $f_{int}$, residual $R$, or other constitutive laws. Instead, it serves a more architectural role within the SOFA simulation pipeline.\n\n### Governing Equations and Operators:\n- **None**: The `IdleEvent` does not implement or contribute to any specific governing equations or operators related to FEM simulations such as mass matrix $M$, stiffness matrix $K$, internal force $f_{int}$, residual $R$, etc. It is purely an event handling mechanism.\n\n### Constitutive and Kinematic Laws:\n- **None**: The `IdleEvent` does not implement any constitutive or kinematic laws related to strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc.\n\n### Role in the Global FEM Pipeline:\n- **No Direct Contribution**: The `IdleEvent` does not directly participate in assembly, time integration, nonlinear solve, linear solve, constraint handling, or mappings. It is used for periodic updates and actions that need to be taken without interfering with real-time performance-critical tasks.\n\n### Numerical Methods or Discretization Choices:\n- **None**: The `IdleEvent` does not encode any numerical methods or discretization choices related to FEM simulations.\n\n### Integration into the Variational / Lagrangian Mechanics Framework:\n- **No Direct Contribution**: While `IdleEvent` is part of the broader SOFA framework, it does not directly integrate into the variational or Lagrangian mechanics framework. It serves as a mechanism for periodic updates and non-critical operations within the simulation context.\n\nIn summary, the `IdleEvent` component in SOFA is primarily an event handling tool that propagates through the object hierarchy at regular intervals to allow for periodic actions such as logging, debugging messages, or maintenance tasks without affecting performance-critical parts of the simulation."
  },
  "summary": {
    "abstract": "`IdleEvent` is an event handler that propagates through the SOFA simulation's object hierarchy at regular intervals to allow for periodic updates or non-time-sensitive operations.",
    "sheet": "# IdleEvent\n\n## Overview\n\nThe `IdleEvent` is part of the SOFA framework and belongs to the `sofa::core::objectmodel` namespace within the `Sofa.framework.Core` module. It inherits from the `Event` class, which means it handles specific events in the simulation context. This event propagates along the objects hierarchy at regular intervals when there are no other critical tasks to process or during idle periods of the simulation loop.\n\n## Practical Notes\n\nDevelopers can use this event to trigger actions that need periodic execution but are not time-sensitive, such as logging, debugging messages, or maintenance tasks. It should be used cautiously to avoid performance degradation by keeping the operations lightweight and non-blocking."
  }
}