Methods

{
  "name": "MeshVTKLoader",
  "namespace": "sofa::component::io::mesh",
  "module": "Sofa.Component.IO.Mesh",
  "include": "sofa/component/io/mesh/MeshVTKLoader.h",
  "doc": "Mesh loader for the VTK/VTU file format.\n\nFormat doc: http://www.vtk.org/VTK/img/file-formats.pdf\nhttp://www.cacr.caltech.edu/~slombey/asci/vtk/vtk_formats.simple.html",
  "inherits": [
    "MeshLoader"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "doLoad",
      "return_type": "bool",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "detectFileType",
      "return_type": "VTKFileType",
      "params": [
        {
          "name": "filename",
          "type": "const char *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "setInputsMesh",
      "return_type": "bool",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "setInputsData",
      "return_type": "bool",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    },
    {
      "name": "doClearBuffers",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "protected"
    }
  ],
  "description": "The `MeshVTKLoader` is a SOFA component in the `sofa::component::io::mesh` namespace, designed to load mesh data from VTK (Visualization Toolkit) or VTU files into SOFA simulations. This loader supports both legacy and XML-based VTK formats. It inherits from the `MeshLoader` class, indicating its role is specifically for loading mesh information such as points, edges, triangles, quads, tetrahedra, hexahedra, normals, and additional point or cell data from these files into SOFA's simulation framework.\n\nInteractions with other components are primarily through the inheritance of `MeshLoader`, which provides a common interface for loading various types of mesh formats. The `MeshVTKLoader` implements methods such as `doLoad()` to handle the actual file reading and parsing, `detectFileType()` to determine whether the file is legacy or XML-based VTK format, and additional methods like `setInputsMesh()` and `setInputsData()` for setting up the loaded mesh data within SOFA.\n\nPractical usage involves specifying a VTK/VTU file path as an input. This component automatically detects the file type and loads the appropriate reader (`LegacyVTKReader` or `XMLVTKReader`) to process the data, including points, polygons/cells, normals, and additional scalar/vectorial cell or point data fields. The loaded mesh is then made available within SOFA for further simulation setup and execution.",
  "maths": "The `MeshVTKLoader` component in the SOFA framework is designed to load mesh data from VTK (Visualization Toolkit) or VTU files into the simulation environment. This loader supports both legacy and XML-based VTK formats, facilitating the import of complex geometries for further analysis and simulation within SOFA. The primary function of this component is to read and parse the mesh information contained in these file formats, including points, edges, triangles, quads, tetrahedra, hexahedra, normals, and additional point or cell data fields. This process is crucial for initializing the geometry required for FEM simulations and other mechanical models within SOFA.\n\n### Governing Equations / Operators Implemented\n- **Mesh Data**: The component does not directly contribute to any governing equations or operators related to FEM simulation. Instead, it serves as a pre-processing tool by loading geometric information (points, edges, faces, etc.) into the simulation environment.\n  - Points: Positions of vertices in the mesh.\n  - Edges/Triangles/Quads/Tetrahedra/Hexahedra: Topological elements that define the connectivity between points and form the geometry of the object.\n  - Normals: Surface normals at each vertex or face, which are essential for visualization and certain types of boundary conditions in simulations.\n\n### Constitutive or Kinematic Laws Involved\n- The `MeshVTKLoader` does not implement any constitutive laws (stress-strain relationships) or kinematic laws (displacement formulations). Its role is purely to provide the geometric input necessary for defining a mesh, which can then be used by other components in SOFA for further processing such as discretization into finite elements.\n\n### Role in the Global FEM Pipeline\n- **Modeling Phase**: This component contributes to the initial setup of the simulation by loading the geometric data required to define the continuum (the domain over which the simulation will take place).\n  - The mesh loaded by `MeshVTKLoader` is used as input for spatial discretization in subsequent steps, where it is converted into a set of finite elements.\n- **Discretization Phase**: Although the component itself does not perform any discretization, the data it loads forms the basis for this phase. The points and cells loaded from the VTK/VTU file are used to define the nodes and elements in the FEM model.\n  - Points become the nodes of the finite element mesh.\n  - Cells (edges, triangles, quads, tetrahedra, hexahedra) form the elements of the mesh.\n- **Assembly Phase**: The geometric information provided by `MeshVTKLoader` is used to construct the global matrices and vectors required for simulation. This includes the mass matrix, stiffness matrix, and internal force vector, which are assembled based on the discretized elements derived from the loaded mesh.\n\n### Numerical Methods or Discretization Choices Encoded\n- The numerical methods and discretization choices are not implemented within `MeshVTKLoader`. Instead, this component provides the input data (mesh geometry) that will be used by other components in SOFA for these purposes. For example:\n  - **Shape Functions**: Once the mesh is loaded, shape functions are defined based on the type of elements used (e.g., linear or quadratic basis functions).\n  - **Integration Points**: The integration points within each element are determined based on the chosen numerical quadrature scheme.\n\n### Fit into the Broader Variational / Lagrangian Mechanics Framework\n- Within the variational mechanics framework, `MeshVTKLoader` contributes by providing the initial geometric data necessary to define the domain over which variational principles will be applied. The loaded mesh forms the basis for defining the weak form of the governing equations, leading to the construction of global system matrices and vectors.\n  - **Variational Formulation**: Once the geometry is defined by `MeshVTKLoader`, subsequent components in SOFA use this data to perform the variational formulation, leading to the assembly of the stiffness matrix (K) and internal force vector (f_int).\n\n### Summary\n- The `MeshVTKLoader` does not directly implement any mathematical or physical operators relevant to FEM simulation. Instead, it serves as a critical pre-processing step by loading geometric data from VTK/VTU files into SOFA. This loaded mesh is then used by other components in the framework for spatial discretization and further numerical processing.",
  "abstract": "The `MeshVTKLoader` loads mesh data from VTK/VTU files into SOFA simulations, providing essential geometric information for further processing.",
  "sheet": "# MeshVTKLoader\n\n## Overview\nThe `MeshVTKLoader` is a component in the `sofa::component::io::mesh` namespace designed to load mesh data from VTK (Visualization Toolkit) or VTU files into SOFA simulations. It inherits from the `MeshLoader` class, which provides a common interface for loading various types of mesh formats. The primary function of this component is to read and parse the geometric information contained in these file formats, including points, edges, triangles, quads, tetrahedra, hexahedra, normals, and additional point or cell data fields. This process is crucial for initializing the geometry required for FEM simulations and other mechanical models within SOFA."
}