Methods

{
  "name": "SceneCheckCollisionResponse",
  "namespace": "sofa::_scenechecking_",
  "module": "applications.projects.SceneChecking",
  "include": "SceneChecking/SceneCheckCollisionResponse.h",
  "doc": "",
  "inherits": [
    "SceneCheck"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "newSPtr",
      "return_type": "SPtr",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "getName",
      "return_type": "const int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getDesc",
      "return_type": "const int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doInit",
      "return_type": "void",
      "params": [
        {
          "name": "node",
          "type": "sofa::simulation::Node *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doCheckOn",
      "return_type": "void",
      "params": [
        {
          "name": "node",
          "type": "sofa::simulation::Node *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doPrintSummary",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `SceneCheckCollisionResponse` is part of the SOFA framework's SceneChecking module and inherits from the `sofa::simulation::SceneCheck`. This component is designed to verify that appropriate collision response components are present in the scene, ensuring proper collision handling configurations. It checks for specific constraints and animation loops required by different collision responses like `StickContactConstraint`, `FrictionContactConstraint`, and `PenalityContactForceField`. Additionally, it verifies that necessary data fields such as `contactStiffness` are correctly set or unset based on the chosen collision response method. The component provides methods to initialize (`doInit`), check specific nodes (`doCheckOn`), and print summary messages (`doPrintSummary`) to help users ensure their scene configurations are valid.",
  "maths": "The `SceneCheckCollisionResponse` component is part of the SOFA framework's SceneChecking module. It inherits from the `sofa::simulation::SceneCheck` and is designed to verify that appropriate collision response components are present in the scene, ensuring proper collision handling configurations. This component does not directly contribute to the governing equations or operators such as mass matrix $M$, stiffness matrix $K$, internal force $\textbf{f}_{\text{int}}$, residual $R$, etc., but rather focuses on validating that necessary conditions for these components are met within the scene graph structure of SOFA simulations. \n\n### Governing Equations or Operators:\n\n- **None**: The `SceneCheckCollisionResponse` does not directly implement any governing equations, operators, constitutive laws, or kinematic laws. Its role is to ensure that such laws and conditions are correctly set up in the scene.\n\n### Constitutive or Kinematic Laws Involved:\n\n- **None**: The component itself does not involve any specific strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc., but it ensures that these aspects are properly configured within the scene.\n\n### Role in the Global FEM Pipeline:\n\nThe `SceneCheckCollisionResponse` plays a role primarily during initialization and verification phases of the simulation. It checks for specific constraints and animation loops required by different collision response methods (e.g., `StickContactConstraint`, `FrictionContactConstraint`, and `PenalityContactForceField`). This ensures that all necessary components are present and correctly configured, which indirectly supports the FEM pipeline in maintaining physical consistency.\n\n### Numerical Methods or Discretization Choices:\n\n- **None**: The component does not encode any numerical methods or discretization choices. Its role is purely to validate the configuration of the scene for proper collision response handling.\n\n### Integration into Variational / Lagrangian Mechanics Framework:\n\nThe `SceneCheckCollisionResponse` ensures that the scene's configuration aligns with variational principles and Lagrangian mechanics by verifying the presence of necessary components (e.g., constraints, animation loops). This indirect role supports maintaining consistency in simulations governed by these frameworks.\n\n### Summary:\n\n- **Initialization (`doInit`)**: Initializes internal state variables for the component.\n- **Checking Scene Configuration (`doCheckOn`)**: Verifies that the scene includes required components and configurations for different collision responses. This includes checking for single `CollisionResponse`, presence of appropriate animation loops, and correct settings for contact stiffness depending on the chosen response type.\n- **Printing Summary Messages (`doPrintSummary`)**: Reports any issues found during the checks to help users ensure their scene configurations are valid.\n\nThe component does not directly participate in solving equations or computing forces but ensures that the scene is correctly configured to support these operations within the FEM simulation framework.",
  "abstract": "The `SceneCheckCollisionResponse` ensures that necessary collision response components and configurations are present in the scene, verifying conditions for proper collision handling.",
  "sheet": "# SceneCheckCollisionResponse\n\n## Overview\n\nThe `SceneCheckCollisionResponse` is part of SOFA's SceneChecking module. It inherits from `sofa::simulation::SceneCheck` and its primary role is to verify that appropriate collision response components are present in the scene, ensuring proper collision handling configurations. This includes checking for specific constraints (e.g., `StickContactConstraint`, `FrictionContactConstraint`) and animation loops required by different collision responses.\n\n## Practical Notes\n\n- **Initialization (`doInit`)**: Initializes internal state variables for the component.\n- **Checking Scene Configuration (`doCheckOn`)**: Verifies that the scene includes required components and configurations for different collision response methods. This includes checking for single `CollisionResponse`, presence of appropriate animation loops, and correct settings for contact stiffness depending on the chosen response type.\n- **Printing Summary Messages (`doPrintSummary`)**: Reports any issues found during the checks to help users ensure their scene configurations are valid."
}