Methods

{
  "name": "PolyDataVTKLoader",
  "namespace": "sofavtk",
  "module": "SOFA.VTK",
  "include": "sofa/vtk/PolyDataVTKLoader.h",
  "doc": "Mesh loader",
  "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 `PolyDataVTKLoader` is a SOFA component within the `sofavtk` namespace, part of the `SOFA.VTK` module. Its primary role is to load mesh data from VTK files into the simulation environment as polydata. This loader inherits from `BaseVTKLoader`, and it provides a method called `getDataSet` that retrieves a VTK dataset (of type `vtkSmartPointer<vtkDataSet>`) based on a specified file name. The `getDataSet` method is protected, meaning it's intended for internal use within the component or by derived classes.\n\nIn the SOFA ecosystem, this loader facilitates integrating external mesh data into simulations, enabling users to leverage pre-existing models stored in VTK format. This enhances versatility and interoperability with other tools that support VTK files.",
  "maths": "The `PolyDataVTKLoader` is a component within the SOFA framework designed to load mesh data from VTK (Visualization Toolkit) files into the simulation environment. This loader specifically handles polydata, which can represent points, lines, and surfaces in 3D space. The primary function of this component is to facilitate the integration of external geometric models into the simulation pipeline, enhancing interoperability with other tools that support VTK format.\n\n### Mathematical and Physical Description:\n\n#### Governing Equations and Operators\n- **Mesh Representation**: The `PolyDataVTKLoader` reads polydata from a VTK file, which is then represented as a set of vertices and connectivity information (e.g., edges or faces). Mathematically, this data can be described by the vertex coordinates \\( X_i \\) for each node in the mesh.\n\n#### Constitutive Laws and Kinematic Models\n- **Geometry Input**: The polydata loaded from VTK files does not directly involve constitutive laws or kinematic models. Instead, it provides the geometric structure that can later be associated with material properties (e.g., elasticity) through other components in the SOFA pipeline.\n\n#### Role in FEM Pipeline\n- **Mesh Loading and Assembly**: In the context of the broader FEM simulation framework, `PolyDataVTKLoader` is primarily involved in the mesh loading phase. It reads geometric data from VTK files and makes it available for further processing within the SOFA scene graph.\n- **Integration into Simulation**: The loaded polydata can be used to define the topology and geometry of a deformable object or boundary conditions, which are critical inputs for assembling mass matrix \\( M \\) and stiffness matrix \\( K \r\n- **Mapping and Constraints**: While `PolyDataVTKLoader` itself does not directly handle constraints or mappings, the loaded mesh can be used in conjunction with other components to define constraint relations (e.g., attaching points to a rigid body) or perform geometric mappings (e.g., multi-resolution coupling).\n\n#### Numerical Methods and Discretization Choices\n- **VTK File Parsing**: The component uses VTK libraries for parsing the input file. This involves reading vertex coordinates and connectivity information, which are then used to construct the mesh representation within SOFA.\n\n#### Fitting into Variational / Lagrangian Mechanics Framework\n- **Geometric Data Input**: The `PolyDataVTKLoader` serves as a bridge between external geometric data sources (in VTK format) and the internal simulation framework. Once loaded, this geometry can be used to define the discretization domain \\( \\Omega = \\bigcup_e \\Omega_e \r\n- **Integration into Weak Form**: While not directly involved in assembling operators like mass or stiffness matrices, the geometric data provided by `PolyDataVTKLoader` is essential for defining the weak form of the PDEs that underlie the variational formulation.\n\n### Summary\nThe `PolyDataVTKLoader` plays a crucial role in importing external mesh data into SOFA simulations. By loading VTK files, it provides geometric information necessary for constructing deformable objects and setting up boundary conditions, thus bridging the gap between external design tools and the computational mechanics framework provided by SOFA.",
  "abstract": "The `PolyDataVTKLoader` loads polydata from VTK files into the SOFA simulation environment, providing geometric data for further processing within the scene graph.",
  "sheet": "# PolyDataVTKLoader\n\n## Overview\n\nThe `PolyDataVTKLoader` is a component in the `sofavtk` namespace that reads mesh data from VTK (Visualization Toolkit) files into the SOFA simulation environment. It inherits from `BaseVTKLoader`, and its primary role is to load polydata, which can represent points, lines, and surfaces in 3D space. This loader facilitates integrating external geometric models into simulations, enhancing interoperability with other tools that support VTK format.\n\n## Parameters and Data\n\nThe `PolyDataVTKLoader` does not expose any significant data fields beyond those inherited from its parent class. Its primary functionality is provided through the method `getDataSet`, which retrieves a VTK dataset based on a specified file name."
}