Methods

{
  "name": "TopologyHandler",
  "namespace": "sofa::core::topology",
  "module": "Sofa.framework.Core",
  "include": "sofa/core/topology/TopologyHandler.h",
  "doc": "A class that will interact on a topological Data */",
  "inherits": [
    "DDGNode"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "handleTopologyChange",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "update",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChanges",
      "return_type": "void",
      "params": [
        {
          "name": "_topologyChangeEvents",
          "type": "const int &"
        },
        {
          "name": "_dataSize",
          "type": "const int"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::EndingEvent *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::PointsIndicesSwap *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::PointsAdded *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::PointsRemoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::PointsRenumbering *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::PointsMoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::EdgesIndicesSwap *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::EdgesAdded *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::EdgesRemoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::EdgesMoved_Removing *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::EdgesMoved_Adding *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::EdgesRenumbering *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TrianglesIndicesSwap *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TrianglesAdded *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TrianglesRemoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TrianglesMoved_Removing *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TrianglesMoved_Adding *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TrianglesRenumbering *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::QuadsIndicesSwap *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::QuadsAdded *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::QuadsRemoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::QuadsMoved_Removing *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::QuadsMoved_Adding *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::QuadsRenumbering *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TetrahedraIndicesSwap *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TetrahedraAdded *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TetrahedraRemoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TetrahedraMoved_Removing *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TetrahedraMoved_Adding *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::TetrahedraRenumbering *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::HexahedraIndicesSwap *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::HexahedraAdded *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::HexahedraRemoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::HexahedraMoved_Removing *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::HexahedraMoved_Adding *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const core::topology::HexahedraRenumbering *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const TopologyChangeElementInfo<Topology::Point>::EMoved_Adding *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const TopologyChangeElementInfo<Topology::Point>::EMoved_Removing *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const TopologyChangeElementInfo<Topology::Edge>::EMoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const TopologyChangeElementInfo<Topology::Triangle>::EMoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const TopologyChangeElementInfo<Topology::Quad>::EMoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const TopologyChangeElementInfo<Topology::Tetrahedron>::EMoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "ApplyTopologyChange",
      "return_type": "void",
      "params": [
        {
          "name": "",
          "type": "const TopologyChangeElementInfo<Topology::Hexahedron>::EMoved *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "unregisterTopologyHandler",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "isTopologyHandlerRegistered",
      "return_type": "bool",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getNumberOfTopologicalChanges",
      "return_type": "int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "setNamePrefix",
      "return_type": "void",
      "params": [
        {
          "name": "s",
          "type": "const int &"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getName",
      "return_type": "int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "registerTopology",
      "return_type": "bool",
      "params": [
        {
          "name": "_topology",
          "type": "sofa::core::topology::BaseMeshTopology *"
        },
        {
          "name": "printLog",
          "type": "bool"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "addCallBack",
      "return_type": "void",
      "params": [
        {
          "name": "type",
          "type": "core::topology::TopologyChangeType"
        },
        {
          "name": "callback",
          "type": "TopologyChangeCallback"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `TopologyHandler` class in the SOFA framework interacts with topological data to manage and apply topology changes within simulations. It is part of the `sofa::core::topology` namespace and inherits from `DDGNode`, indicating its role in managing directed graphs related to simulation components.\n\n### Role and Purpose\n`TopologyHandler` monitors and applies various types of topological changes, such as adding or removing points, edges, triangles, tetrahedra, and hexahedra. It handles these changes by implementing different `ApplyTopologyChange` methods that correspond to specific topology change events. This class is crucial for maintaining consistency in the simulation's mesh representation when structural modifications occur.\n\n### Interactions with Other Components\n- **BaseMeshTopology**: The handler registers itself to a topology container via the `registerTopology` method, which allows it to receive and process topology changes.\n- **DDGNode**: It inherits from this base class, enabling integration into the SOFA scene graph structure.\n- **Callback Mechanism**: Users can register callback functions for specific types of topological events using `addCallBack`, allowing custom handling of these events within user-defined components.\n\n### Practical Usage Guidance and Data Fields\n- **Data Fields**:\n  - `m_prefix`: A string used to define the engine name, which helps in identifying the handler.\n  - `m_data_name`: Stores the name of the data being handled by this instance of `TopologyHandler`.\n  - `m_registeredElements`: A set that tracks which topology elements (e.g., points, edges) are currently registered with this handler.\n\n- **Methods**:\n  - `handleTopologyChange()`: Invoked to process any pending topological changes. This method is typically overridden by derived classes for specific behavior.\n  - `update()`: Ensures that the handler's state reflects recent topology updates, particularly during simulation steps.\n  - `ApplyTopologyChanges()`: Applies a list of topology change events to the managed data structure.\n  - `registerTopology()`: Links this handler with a specific topology container. Returns true if successful and false otherwise.\n\nOverall, `TopologyHandler` plays a central role in maintaining topological consistency within SOFA simulations by applying various types of changes across different elements.",
  "maths": "The `TopologyHandler` class in the SOFA framework is designed to manage and apply topological changes within simulations. It does not directly implement any governing equations or operators such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), etc. Instead, its role is to maintain the consistency of the simulation's mesh representation when structural modifications occur. The `TopologyHandler` class interacts with topological data and manages changes such as adding or removing points, edges, triangles, tetrahedra, and hexahedra.\n\n### Role in FEM Pipeline\n1. **Assembly Phase**:\n   - The handler ensures that any changes to the mesh topology are correctly propagated through the simulation pipeline. This includes updating connectivity information for elements such as edges, faces, and cells.\n2. **Time Integration**:\n   - Although not directly involved in time integration schemes like implicit Euler or Newmark-type methods, it ensures that the mesh remains consistent during each timestep.\n3. **Nonlinear Resolution**:\n   - The handler does not contribute to the nonlinear solve process but maintains the integrity of the mesh structure which is crucial for accurate discretization and solution convergence.\n4. **Linear Solve**:\n   - Ensures that the linear system matrices (such as \\(M\\) and \\(K\\)) are updated correctly in response to topological changes.\n5. **Constraint Handling**:\n   - It indirectly supports constraint handling by maintaining consistent mesh connectivity, which is necessary for applying constraints like Dirichlet or Neumann boundary conditions.\n\n### Numerical Methods and Discretization Choices\n- The `TopologyHandler` does not implement any specific numerical methods beyond managing topology changes. However, its role in ensuring correct mesh updates during simulations indirectly supports various numerical discretizations such as finite element method (FEM).\n\n### Variational / Lagrangian Mechanics Framework\n- Although the handler itself is not directly involved in deriving variational formulations or solving Euler–Lagrange equations, it plays a critical role in maintaining the consistency of the mesh. This ensures that the underlying physics and mechanics can be accurately modeled by other components in the SOFA framework.\n\n### Mathematical Description\nThe `TopologyHandler` does not implement any direct mathematical operators but manages topological changes through its methods such as:\n- **handleTopologyChange()**: Ensures processing of pending topology changes.\n- **update()**: Updates handler state based on recent topology updates.\n- **ApplyTopologyChanges()**: Applies a list of topology change events to the managed data structure.\n\n### Constitutive and Kinematic Laws\nThe `TopologyHandler` does not implement any constitutive or kinematic laws, as it focuses solely on maintaining mesh consistency. However, accurate mesh maintenance is essential for applying these laws correctly in other components within the SOFA framework.\n\n### Summary\nIn summary, the `TopologyHandler` class is a critical component of the SOFA framework that ensures the simulation's mesh remains consistent and accurately reflects any topological changes during simulations. While it does not directly implement governing equations or operators, its role is indispensable for maintaining the integrity of the mesh structure required by other components in the FEM pipeline.",
  "abstract": "`TopologyHandler` manages topological changes by applying modifications to points, edges, triangles, tetrahedra, and hexahedra within the SOFA simulation framework.",
  "sheet": "# TopologyHandler\n\n## Overview\nThe `TopologyHandler` class in the SOFA framework interacts with topological data to manage and apply topology changes. It is part of the `sofa::core::topology` namespace and inherits from `DDGNode`, indicating its role in managing directed graphs related to simulation components.\n\n## Dependencies and Connections\n- **BaseMeshTopology**: The handler registers itself to a topology container via the `registerTopology` method, which allows it to receive and process topology changes.\n- **DDGNode**: It inherits from this base class, enabling integration into the SOFA scene graph structure.\n- **Callback Mechanism**: Users can register callback functions for specific types of topological events using `addCallBack`, allowing custom handling of these events within user-defined components.\n\n## Parameters and Data\n- **m_prefix**: A string used to define the engine name, which helps in identifying the handler.\n- **m_data_name**: Stores the name of the data being handled by this instance of `TopologyHandler`.\n- **m_registeredElements**: A set that tracks which topology elements (e.g., points, edges) are currently registered with this handler."
}