{
  "name": "GIDMeshLoader",
  "main": {
    "name": "GIDMeshLoader",
    "namespace": "sofa::component::io::mesh",
    "module": "Sofa.Component.IO.Mesh",
    "include": "sofa/component/io/mesh/GIDMeshLoader.h",
    "doc": "Load volumetric meshes generated by GID. Some element types are not implemented.",
    "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": "readGID",
        "return_type": "bool",
        "params": [
          {
            "name": "file",
            "type": "int &"
          }
        ],
        "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"
      }
    ]
  },
  "desc": {
    "description": "The GIDMeshLoader component in the SOFA framework is designed to load mesh data from files using the GID file format, which is commonly used for representing finite element models and simulations. This loader specifically supports various types of elements such as lines, triangles, quadrilaterals, tetrahedra, hexahedra, prisms, pyramids, spheres, and circles.\n\n### Key Features:\n- **Compatibility**: The component is part of the Sofa.Component.IO.Mesh module, making it compatible with other components in the SOFA ecosystem for handling different types of mesh data.\n- **Element Types**: Supports a wide range of geometric elements including 1D (lines), 2D (triangles and quadrilaterals) and 3D (tetrahedra, hexahedra).\n- **Customizable Loading**: The component has methods to read different types of elements from the file, providing flexibility in handling various mesh configurations.\n- **Dimension Handling**: Capable of loading data for simulations in different dimensions (1D, 2D, 3D) based on the content of the GID file.\n\n### Usage:\nThe GIDMeshLoader can be integrated into SOFA applications to load complex geometries and simulation setups defined in GID files. This is particularly useful in biomechanical simulations where detailed mesh models are often used. The component reads the necessary data from a specified file, processes it according to the element types present, and populates the internal structures of the SOFA framework with this information.\n\n### Internals:\nThe class definition includes protected methods for reading specific elements (like `readLinearElements`, `readTriangleElements`, etc.), indicating that the loading process is modular and can be extended or modified to support additional element types if needed. The loader also keeps track of the dimensions and type of elements in the file through member variables like `m_dimensions` and `m_eltType`. \n\n### Integration:\nThe component extends the sofa::core::loader::MeshLoader class, inheriting its functionalities and adding specific capabilities for GID files. This modular design allows it to integrate seamlessly with other components within the SOFA framework, supporting a broad range of simulation scenarios.",
    "component": "GIDMeshLoader",
    "namespace": "sofa::component::io::mesh"
  },
  "maths": {
    "maths": "<h2>GIDMeshLoader Component Description</h2>\n\n<h3>Introduction</h3>\n<p>The GIDMeshLoader component in the SOFA (Simulation Open-Framework Architecture) framework is designed to parse and load mesh data from files formatted according to the General Interface for Pre- and Post-processing (GID). This loader supports a wide variety of geometric elements, including lines, triangles, quadrilaterals, tetrahedra, hexahedra, prisms, pyramids, spheres, and circles. The mathematical and physical descriptions are centered around the handling of these elements in the context of finite element simulations.</p>\n\n<h3>Element Types</h3>\n<p>The GIDMeshLoader supports several types of elements that can be categorized based on their geometric dimensionality:</p>\n<ul>\n  <li><strong>1D Elements (Lines):</strong> These are typically used for modeling beams or trusses. Each line element is defined by two nodes and can be represented mathematically as a segment between points \\(P_0 = (x_0, y_0)\\) and \\(P_1 = (x_1, y_1)\\). In 3D, the coordinates would also include the z-axis.</li>\n  <li><strong>2D Elements (Triangles and Quadrilaterals):</strong> Triangles are defined by three nodes, forming a triangular region in space. The area of a triangle can be calculated using the formula \\(A = \\frac{1}{2} |x_1(y_2 - y_3) + x_2(y_3 - y_1) + x_3(y_1 - y_2)|\\), where \\((x_i, y_i)\\) are the coordinates of the vertices. Quadrilaterals are defined by four nodes and can be decomposed into triangles for calculations.</li>\n  <li><strong>3D Elements (Tetrahedra, Hexahedra):</strong> Tetrahedral elements consist of four triangular faces with one vertex shared among all three dimensions. The volume of a tetrahedron is given by \\(V = \\frac{1}{6} |\\mathbf{a} \\. (\textbf{b} \times \textbf{c})|\\), where \\(\textbf{a}\\), \\(\textbf{b}\\), and \\(\textbf{c}\\) are vectors connecting the vertices. Hexahedral elements have eight nodes forming a parallelepiped, with volume calculated as the product of edge lengths along each dimension.</li>\n  <li><strong>Other Elements (Prisms, Pyramids, Spheres, Circles):</strong> These represent more complex shapes and can be defined using specific geometric properties. For instance, prisms can be considered extensions of quadrilaterals into three dimensions, pyramids have a polygonal base with all vertices converging at a single apex, spheres are defined by their radius \\(r\\) in 3D space, and circles are represented as circular regions in the plane.</li>\n</ul>\n\n<h3>File Format Handling</h3>\n<p>The GID file format is structured to contain information about nodes (coordinates), elements (connectivity between nodes), and material properties. The loader reads this data line-by-line, identifying element types based on predefined markers in the file.</p>\n<ul>\n  <li><strong>Node Data:</strong> Each node has coordinates that define its position in space. For example, a node at \\((x_i, y_i)\\) or \\((x_i, y_i, z_i)\\) in 2D and 3D respectively.</li>\n  <li><strong>Element Data:</strong> Each element entry specifies the connectivity between nodes, e.g., for a triangle with nodes 1, 2, and 3 connected as \\(\\{1, 2, 3\\}\\).</li>\n</ul>\n\n<h3>Loading Process</h3>\n<p>The loading process involves parsing the GID file to extract node coordinates and element connectivity information. This data is then used to construct geometric representations in memory for simulation purposes:</p>\n<ul>\n  <li><strong>Node Parsing:</strong> Coordinates are stored as \\((x_i, y_i)\\) or \\((x_i, y_i, z_i)\\).</li>\n  <li><strong>Element Parsing:</strong> Connectivity lists define how nodes form elements.</li>\n</ul>\n\n<h3>Integration with SOFA Framework</h3>\n<p>The GIDMeshLoader extends the core MeshLoader class in SOFA, inheriting its functionalities and adding specific methods for handling GID files. This modular design allows it to seamlessly integrate with other components within the SOFA framework, supporting a wide range of simulation scenarios involving complex geometries.</p>"
  },
  "summary": {
    "abstract": "The GIDMeshLoader loads volumetric meshes from files in the GID format, supporting a variety of element types including lines, triangles, quadrilaterals, tetrahedra, hexahedra, prisms, pyramids, spheres, and circles.",
    "sheet": "# GIDMeshLoader\n\n## Overview\nThe GIDMeshLoader is an I/O component in the SOFA framework designed to load mesh data from files formatted according to the General Interface for Pre- and Post-processing (GID). It supports a wide variety of geometric elements such as lines, triangles, quadrilaterals, tetrahedra, hexahedra, prisms, pyramids, spheres, and circles. The component extends the `MeshLoader` class, inheriting its functionalities while adding specific capabilities for handling GID files.\n\n## Dependencies and Connections\nThe GIDMeshLoader typically requires a file in the GID format to load mesh data into the SOFA simulation environment. It fits into the scene graph by providing the necessary geometric information for further processing or visualization components within the framework."
  }
}