Methods

{
  "name": "UnstructuredGridVTKLoader",
  "namespace": "sofavtk",
  "module": "SOFA.VTK",
  "include": "sofa/vtk/UnstructuredGridVTKLoader.h",
  "doc": "Mesh loader for unstructured grids",
  "inherits": [
    "BaseVTKLoader"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "getDataSet",
      "return_type": "vtkSmartPointer<vtkDataSet>",
      "params": [
        {
          "name": "fileName",
          "type": "const sofa::core::objectmodel::DataFileName &"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    }
  ],
  "description": "The `UnstructuredGridVTKLoader` is a SOFA component in the `sofavtk` namespace, part of the `SOFA.VTK` module. Its primary role is to load unstructured grid meshes from VTK (Visualization Toolkit) files into the simulation scene. This loader inherits from `BaseVTKLoader`, which provides foundational functionality for loading various types of VTK datasets. The component offers a protected method `getDataSet`, which takes a file name as input and returns a `vtkSmartPointer<vtkDataSet>`. This method is responsible for reading and processing the unstructured grid data from the specified VTK file, making it accessible within SOFA simulations. While there are no explicit public fields or links provided in this metadata, its interaction with other components typically involves loading mesh data that can be further processed by other modules such as mechanical models, collision detection systems, or visualization components.",
  "maths": "The `UnstructuredGridVTKLoader` is a utility component within the SOFA framework designed to load unstructured grid meshes from VTK (Visualization Toolkit) files. This component does not directly contribute to the mathematical and physical core of the FEM simulation pipeline, as it primarily serves an input/output role by handling mesh data loading rather than performing any computational mechanics tasks. Its primary function is to provide mesh geometry that can be further processed or utilized by other SOFA components involved in the simulation.\n\n### Governing Equations / Operators Involved\n- **Mesh Loading**: The `UnstructuredGridVTKLoader` does not directly implement governing equations such as the mass matrix (\\( M \")), stiffness matrix (\\( K \")), internal force (\\( f_{int} \")), or residual (\\( R \")). Instead, it focuses on loading unstructured grid data into a format usable by other SOFA components that do handle these physical and mathematical constructs.\n\n### Constitutive / Kinematic Laws Involved\n- **Mesh Geometry**: The component reads the mesh geometry from VTK files. This includes node coordinates and connectivity information for each element in the mesh. However, it does not define or process any constitutive laws such as strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc., which are left to other components.\n\n### Role in the Global FEM Pipeline\n- **Data Input**: The `UnstructuredGridVTKLoader` plays a role in the initial data input phase of the simulation pipeline. It loads mesh geometry from VTK files into a format that can be used by subsequent mechanical models, solvers, and other components.\n- **Mesh Processing**: Once the unstructured grid is loaded, it may be further processed or transformed by other SOFA components (e.g., remeshing, refinement) before being incorporated into the simulation. The mesh data is then utilized for spatial discretization in the FEM process, but this step itself is performed by other components.\n\n### Numerical Methods / Discretization Choices\n- **VTK Data Loading**: The `UnstructuredGridVTKLoader` does not encode any numerical methods or discretization choices directly. It simply reads and processes VTK data files to provide node coordinates and connectivity information, which are necessary for the subsequent FEM discretization process handled by other components.\n\n### Fit into Broader Variational / Lagrangian Mechanics Framework\n- **Data Provision**: While not directly involved in any variational or Lagrangian mechanics formulations, the `UnstructuredGridVTKLoader` is a critical component that provides the necessary mesh data for subsequent steps of the simulation. The mesh geometry it loads forms the basis for spatial discretization and further processing by other components in the FEM framework.\n\nIn summary, the `UnstructuredGridVTKLoader` serves as an input utility to load unstructured grid meshes into SOFA simulations without directly contributing mathematical or physical content beyond providing essential geometric data.",
  "abstract": "The `UnstructuredGridVTKLoader` loads unstructured grid meshes from VTK files into the SOFA simulation scene, providing essential geometric data for subsequent processing by other components.",
  "sheet": "# UnstructuredGridVTKLoader\n\n## Overview\nThe `UnstructuredGridVTKLoader` is a component in the `sofavtk` namespace within the `SOFA.VTK` module. It inherits from `BaseVTKLoader`, providing functionality to load unstructured grid meshes from VTK files into the SOFA simulation scene. This loader reads and processes mesh geometry, including node coordinates and connectivity information, which can then be utilized by other components for further processing or visualization.\n\n## Dependencies and Connections\nThe `UnstructuredGridVTKLoader` typically requires a VTK file containing unstructured grid data as input. It interacts with other SOFA components that process the loaded mesh geometry, such as mechanical models, collision detection systems, or visualization components. The component fits into the scene graph by providing essential geometric data for spatial discretization and further simulation steps."
}