{
  "name": "DeleteVisitor",
  "main": {
    "name": "DeleteVisitor",
    "namespace": "sofa::simulation",
    "module": "Sofa.framework.Simulation.Core",
    "include": "sofa/simulation/DeleteVisitor.h",
    "doc": "",
    "inherits": [
      "Visitor"
    ],
    "templates": [],
    "data_fields": [],
    "links": [],
    "methods": [
      {
        "name": "processNodeBottomUp",
        "return_type": "void",
        "params": [
          {
            "name": "node",
            "type": "Node *"
          }
        ],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      }
    ]
  },
  "desc": {
    "description": "The `DeleteVisitor` is a component in the SOFA framework under the namespace `sofa::simulation`, part of the `Sofa.framework.Simulation.Core` module. It inherits from the `Visitor` class and is responsible for deleting nodes within the simulation scene graph. The `processNodeBottomUp` method is overridden to remove all child nodes and objects associated with a given node, effectively clearing its contents and freeing resources. This component plays a role in managing the lifecycle of simulation nodes and ensuring proper cleanup when needed."
  },
  "maths": {
    "maths": "The `DeleteVisitor` is a component in the SOFA framework responsible for managing the lifecycle of simulation nodes within the scene graph. It inherits from the `Visitor` class and implements the method `processNodeBottomUp`, which iterates through all child nodes and objects associated with a given node, removing them and freeing up resources.\n\nMathematically, this component does not contribute to any governing equations or operators such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force vector \\(\boldsymbol{f}_{int}\\), residual vector \\(\boldsymbol{R}\\), or other physical quantities. Instead, it handles the structural and organizational aspects of the simulation scene graph.\n\nThe `processNodeBottomUp` method ensures that when a node is being deleted, all its children nodes and objects are also removed. This iterative removal process is crucial for maintaining the integrity and coherence of the simulation state, particularly during dynamic modifications or cleanup operations within the SOFA framework.\n\nFrom a broader perspective in variational/Lagrangian mechanics, this component plays an essential role in managing the structure of the scene graph, ensuring that the hierarchical organization of nodes does not lead to memory leaks or orphaned resources. This is crucial for maintaining efficient and robust simulations but does not directly impact the physical models or mathematical formulations used within SOFA."
  },
  "summary": {
    "abstract": "The `DeleteVisitor` is responsible for deleting nodes within the SOFA simulation scene graph by removing all child nodes and associated objects.",
    "sheet": "# DeleteVisitor\n\n## Overview\nThe `DeleteVisitor` component in the SOFA framework handles the deletion of nodes within the simulation scene graph. It inherits from the `Visitor` class and implements the `processNodeBottomUp` method to ensure that all child nodes and their associated objects are removed, freeing up resources.\n\n## Dependencies and Connections\nThis component typically operates on a node in the SOFA scene graph and interacts with other components by removing them recursively. It is essential for maintaining the integrity of the simulation state during dynamic modifications or cleanup operations.\n\n## Practical Notes\nWhen using `DeleteVisitor`, ensure that all necessary nodes are properly marked for deletion to avoid memory leaks or orphaned resources. The method `processNodeBottomUp` should be called appropriately within the context of a larger scene graph management strategy."
  }
}