Data Fields

Links

Methods

{
  "name": "MeshVolume",
  "namespace": "sofa::component",
  "module": "SofaTestPlugin",
  "include": "utils/MeshVolume.h",
  "doc": "Compute tetrahedral mesh volume by sum of element volumes",
  "inherits": [
    "BaseObject"
  ],
  "templates": [
    "sofa::defaulttype::Vec3Types"
  ],
  "data_fields": [
    {
      "name": "d_volume",
      "type": "Real",
      "xmlname": "volume",
      "help": "Volume of the mesh"
    }
  ],
  "links": [
    {
      "name": "l_topology",
      "target": "TetrahedronSetTopologyContainer",
      "kind": "single",
      "xmlname": "topology",
      "help": "Link to topology"
    }
  ],
  "methods": [
    {
      "name": "init",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "handleEvent",
      "return_type": "void",
      "params": [
        {
          "name": "event",
          "type": "sofa::core::objectmodel::Event *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "update_volume",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `MeshVolume` component in the SOFA framework is designed to compute and output the total volume of a tetrahedral mesh by summing up the volumes of individual tetrahedra. It inherits from `BaseObject`, which suggests it operates at a fundamental level within the scene graph hierarchy.\n\n**Role and Purpose:**\nThe primary role of `MeshVolume` is to calculate and provide the overall volume of a tetrahedral mesh, which can be useful in various simulation scenarios where volumetric information is critical. It computes this by iterating through each tetrahedron defined in the topology and calculating its volume using the positions of the vertices.\n\n**Interactions with Other Components:**\nThe `MeshVolume` component interacts with a `TetrahedronSetTopologyContainer`, which it links to via `l_topology`. This container holds the topological information necessary for defining the tetrahedral mesh. The component also listens to and handles the `AnimateBeginEvent` from the simulation, ensuring that the volume is updated at appropriate times during the simulation loop.\n\n**Practical Usage Guidance:**\nThe main data field in `MeshVolume` is `d_volume`, which stores the computed total volume of the mesh. This value can be accessed for further analysis or visualization within a SOFA scene. To use this component effectively, one must ensure that it has access to the correct topology data through its link to a `TetrahedronSetTopologyContainer`. Additionally, the component updates the volume automatically during each simulation step via event handling.",
  "maths": "The `MeshVolume` component in the SOFA framework is designed to compute the total volume of a tetrahedral mesh by summing up the volumes of individual tetrahedra. This component does not directly contribute to any governing equations or operators typically associated with finite element methods (FEM), such as mass matrices, stiffness matrices, internal forces, residuals, or constitutive laws. Instead, its role is purely computational and serves to provide a derived quantity from the mesh geometry.\n\n### Mathematical Description\n\n#### Tetrahedral Volume Calculation\nThe volume of each tetrahedron in the mesh is computed using the positions of its four vertices \\(\\mathbf{X}_i\\) for \\(i = 0, 1, 2, 3\\). The formula for the volume of a tetrahedron defined by these vertices is given by:\n\n\begin{equation}\nV_t = \\frac{1}{6} \\left| (\\mathbf{X}_1 - \\mathbf{X}_0) \times (\\mathbf{X}_2 - \\mathbf{X}_0) \right| \bullet (\\mathbf{X}_3 - \\mathbf{X}_0)\n\tag{1}\n\nd\nequation\n\nwhere \\(\times\\) denotes the cross product and \\(\bullet\\) denotes the dot product.\n\n#### Total Mesh Volume\nThe total volume of the tetrahedral mesh is obtained by summing the volumes of all individual tetrahedra. If there are \\(N_{tet}\\) tetrahedra in the topology, the total volume \\(V\\) is given by:\n\n\begin{equation}\nV = \n\textstyle{\nsum_{i=1}^{N_{tet}} V_t^i}\n\tag{2}\n\nd\nequation\n\nwhere \\(V_t^i\\) denotes the volume of the \\(i\\)-th tetrahedron.\n\n### Role in the Global FEM Pipeline\nThe `MeshVolume` component plays a role in providing post-processing information rather than being part of the core simulation pipeline. It does not directly affect the assembly, time integration, nonlinear solve, or linear solve phases of an FEM simulation. Instead, it computes and stores the total volume as a derived quantity.\n\n### Numerical Methods\nThe numerical method employed by `MeshVolume` is straightforward geometric computation. The volume of each tetrahedron is calculated using the positions of its vertices directly, without any need for discretization or approximation beyond the mesh itself. There are no iterative solvers or complex linear algebraic operations involved in this component.\n\n### Variational / Lagrangian Mechanics Framework Fit\nWhile `MeshVolume` does not directly fit into the variational or Lagrangian mechanics framework, it provides a useful derived quantity that can be utilized in various simulation contexts. For instance, changes in mesh volume over time could be used to monitor deformation or other physical phenomena occurring within the tetrahedral mesh.\n",
  "abstract": "The `MeshVolume` component computes the total volume of a tetrahedral mesh by summing up individual tetrahedron volumes using vertex positions.",
  "sheet": "# MeshVolume\n\n**Overview:**\nThe `MeshVolume` component calculates and provides the overall volume of a tetrahedral mesh. It inherits from `BaseObject`, indicating its fundamental role in the scene graph hierarchy. The component interacts with a `TetrahedronSetTopologyContainer` to access topological information necessary for defining the tetrahedral mesh.\n\n**Mathematical Model:**\nThe volume of each tetrahedron is computed using the positions of its four vertices \\\\(\\mathbf{X}_i\\\\) for \\\\(i = 0, 1, 2, 3\\\\). The formula for the volume of a tetrahedron defined by these vertices is given by:\n\n\begin{equation}\nV_t = \\frac{1}{6} \\left| (\\mathbf{X}_1 - \\mathbf{X}_0) \\times (\\mathbf{X}_2 - \\mathbf{X}_0) \\right| \bullet (\\mathbf{X}_3 - \\mathbf{X}_0)\n\\tag{1}\n\nd\n\nequation\n\nwhere \\\\times\\\\ denotes the cross product and \\\\bullet\\\\ denotes the dot product.\n\nThe total volume of the tetrahedral mesh is obtained by summing the volumes of all individual tetrahedra. If there are \\\\(N_{tet}\\\\) tetrahedra in the topology, the total volume \\\\(V\\\\) is given by:\n\n\begin{equation}\nV = \\sum_{i=1}^{N_{tet}} V_t^i\n\\tag{2}\n\nd\n\nequation\n\nwhere \\\\(V_t^i\\\\) denotes the volume of the \\\\(i\\\\)-th tetrahedron.\n\n**Parameters and Data:**\nThe significant data field exposed by `MeshVolume` is:\n- **d_volume**: The computed total volume of the mesh, type `Real`, default not specified.\n\n**Dependencies and Connections:**\nThe component requires a link to a `TetrahedronSetTopologyContainer` via `l_topology` for topological information necessary for defining the tetrahedral mesh."
}