Methods

{
  "name": "SceneCheckerVisitor",
  "namespace": "sofa::_scenechecking_",
  "module": "applications.projects.SceneChecking",
  "include": "SceneChecking/SceneCheckerVisitor.h",
  "doc": "",
  "inherits": [
    "Visitor"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "validate",
      "return_type": "void",
      "params": [
        {
          "name": "node",
          "type": "sofa::simulation::Node *"
        },
        {
          "name": "sceneLoader",
          "type": "simulation::SceneLoader *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "processNodeTopDown",
      "return_type": "Result",
      "params": [
        {
          "name": "node",
          "type": "sofa::simulation::Node *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "addCheck",
      "return_type": "void",
      "params": [
        {
          "name": "check",
          "type": "sofa::simulation::SceneCheck::SPtr"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "removeCheck",
      "return_type": "void",
      "params": [
        {
          "name": "check",
          "type": "sofa::simulation::SceneCheck::SPtr"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `SceneCheckerVisitor` is a visitor component in the SOFA ecosystem, part of the SceneChecking module. Its primary role is to validate and check nodes within the simulation scene for correctness and consistency. It inherits from the `sofa::simulation::Visitor`, allowing it to traverse the scene graph.\n\n### Interactions with Other Components:\n- **`validate`:** This method validates a given node using a set of `SceneCheck` objects, which can be added or removed through the `addCheck` and `removeCheck` methods. The validation process includes initialization, execution, and summary printing for each check.\n- **`processNodeTopDown`:** This virtual method is overridden to perform checks on nodes during a top-down traversal of the scene graph, ensuring that all specified checks are applied at each node visited.\n\n### Practical Usage:\nThis component is useful for debugging and validating scenes by allowing users to add custom checks. It ensures that the simulation setup adheres to predefined criteria or standards before proceeding with the actual simulation.\n\n- **Data Fields:**\n  - `m_checkset`: A vector of `SceneCheck` pointers, which holds the set of checks to be performed during validation.",
  "maths": "The `SceneCheckerVisitor` is a visitor component in the SOFA framework that does not directly implement any governing equations, constitutive laws, or numerical methods related to finite element analysis (FEM). Instead, it serves as an organizational and validation tool for ensuring the correctness of nodes within the simulation scene. Here is a detailed description of its role and functionalities:\n\n### Role in FEM Pipeline\n- **Validation and Consistency Checking:** The primary function of `SceneCheckerVisitor` is to validate and check nodes within the SOFA scene graph for consistency and adherence to predefined criteria. It does not contribute to any specific mathematical or physical operators such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force vector \\(\bm{f}_{\text{int}}\\), residual vector \\(\bm{R}\\), etc.\n\n### Mathematical Content\n- **None:** The `SceneCheckerVisitor` does not implement or contribute to any governing equations, constitutive laws, kinematic formulations, or numerical methods directly related to the FEM simulation process. It is a tool for ensuring that the scene setup is correct and consistent before proceeding with the actual simulation.\n\n### Numerical Methods and Discretization Choices\n- **None:** The `SceneCheckerVisitor` does not involve any specific discretization choices or numerical methods as it primarily focuses on validation rather than computation.\n\n### Integration into Variational/Lagrangian Mechanics Framework\n- **Validation at Scene Level:** While the component itself does not directly fit into the variational or Lagrangian mechanics framework by implementing mathematical operators, its role is to ensure that all components and configurations within the scene are consistent with expected criteria. This indirectly supports the overall integrity of the simulation pipeline by preventing errors in setup before running computationally intensive FEM simulations.\n\n### Summary\nThe `SceneCheckerVisitor` does not contain any significant mathematical or physical content but plays a crucial role in ensuring that the SOFA scene is correctly set up and validated, thus supporting the broader framework's accuracy and reliability.",
  "abstract": "`SceneCheckerVisitor` validates nodes within the SOFA scene graph for correctness and consistency by applying a set of checks during top-down traversal.",
  "sheet": "# SceneCheckerVisitor\n\n**Overview:**\n`SceneCheckerVisitor` is a validation tool that traverses the SOFA scene graph to ensure node correctness and consistency. It inherits from `sofa::simulation::Visitor`, allowing it to perform checks on nodes during a top-down traversal.\n\n**Parameters and Data:*\n- *m_checkset:* A vector of `SceneCheck` pointers, which holds the set of checks to be performed during validation.\n\n**Dependencies and Connections:**\nThis component typically requires a scene graph with nodes that need validation. It exchanges data with `sofa::simulation::Node` objects and can interact with custom `SceneCheck` implementations added by users."
}