Methods

{
  "name": "PauseEvent",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/PauseEvent.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 `PauseEvent` is an event in the SOFA framework used to signal when it is necessary to stop or pause the simulation animation. It inherits from the base `Event` class and is part of the `sofa::simulation` namespace within the `Sofa.framework.Simulation.Core` module.\n\n**Role**: The primary role of the `PauseEvent` is to halt the ongoing animation in a SOFA simulation, providing a mechanism for controlling the simulation flow. This event can be triggered under specific conditions or through user interactions to pause the simulation.\n\n**Interactions with Other Components**: As an event, it interacts with other components that listen and respond to events within the SOFA simulation framework. Specifically, any component designed to handle `Event` types would be able to detect a `PauseEvent` and act accordingly to stop or halt the ongoing animation.\n\n**Usage Guidance**: The `PauseEvent` can be used in scenarios where it is necessary to pause the simulation for inspection, debugging, or user interaction. Components that are listening for events can check if an event of type `PauseEvent` has occurred using the provided methods such as `checkEventType`. Practical usage involves implementing event handling logic within components to respond appropriately when a `PauseEvent` occurs.\n\n**Data Fields**: The `PauseEvent` does not contain any specific data fields, as it serves primarily as a signal or trigger for pausing the simulation.",
  "maths": "The `PauseEvent` is an event within the SOFA framework that signals the need to stop or pause the simulation animation. It does not contribute directly to any governing equations, constitutive laws, kinematic models, or numerical methods associated with FEM simulations. Instead, it serves as a control mechanism within the simulation pipeline.\n\n**Governing Equations and Operators**: The `PauseEvent` does not implement or contribute to any specific governing equations such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), etc. It is a control event that triggers the pause of the simulation flow.\n\n**Constitutive and Kinematic Laws**: The `PauseEvent` does not involve any constitutive or kinematic laws such as strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc.\n\n**Role in Global FEM Pipeline**: In terms of its role within the global FEM pipeline, the `PauseEvent` serves primarily to halt ongoing simulation activities. It does not directly participate in assembly, time integration, nonlinear solve, linear solve, constraint handling, or mapping steps. Instead, it provides a mechanism for controlling and managing the flow of the simulation.\n\n**Numerical Methods and Discretization**: The `PauseEvent` is not involved in any numerical methods or discretization choices related to FEM simulations. It does not contribute to any specific numerical integration schemes, spatial discretizations, iterative solvers, or preconditioning techniques.\n\n**Variational / Lagrangian Mechanics Framework**: The `PauseEvent` operates outside of the variational or Lagrangian mechanics framework and is purely a control mechanism for managing the simulation's execution flow.",
  "abstract": "The `PauseEvent` signals the need to stop or pause the simulation animation in SOFA.",
  "sheet": "<h1>PauseEvent</h1>\n\n<h2>Overview</h2>\n<p>The <code>PauseEvent</code> is an event that signals when it is necessary to halt the ongoing animation within a SOFA simulation. It inherits from the base <code>Event</code> class and provides mechanisms for controlling the flow of the simulation.</p>\n\n<h2>Dependencies and Connections</h2>\n<p>The <code>PauseEvent</code> interacts with other components that listen to events in the SOFA framework, particularly those designed to handle event types. Components can detect a <code>PauseEvent</code> using methods such as <code>checkEventType</code>.</p>\n\n<h2>Practical Notes</h2>\n<p>The <code>PauseEvent</code> is useful for pausing the simulation for inspection, debugging, or user interaction. Components must implement event handling logic to respond appropriately when a <code>PauseEvent</code> occurs.</p>"
}