Methods

{
  "name": "MechanicalGetNonDiagonalMassesCountVisitor",
  "namespace": "sofa::simulation::mechanicalvisitor",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/mechanicalvisitor/MechanicalGetNonDiagonalMassesCountVisitor.h",
  "doc": "Count the number of masses which are not diagonal */",
  "inherits": [
    "MechanicalVisitor"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "fwdMass",
      "return_type": "Result",
      "params": [
        {
          "name": "ctx",
          "type": "VisitorContext *"
        },
        {
          "name": "mass",
          "type": "sofa::core::behavior::BaseMass *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `MechanicalGetNonDiagonalMassesCountVisitor` is a specialized visitor in the SOFA framework, designed to count the number of non-diagonal masses within a mechanical system. This class inherits from `MechanicalVisitor`, indicating its role in visiting and processing mechanical components during simulation operations.\n\nIn terms of interactions, it primarily interfaces with instances of `BaseMass` through the `fwdMass` method, which is part of the visitor pattern used extensively in SOFA for traversal and operation on different mechanical elements. The `fwdMass` method increments a counter (`m_nbNonDiagonalMassesPtr`) if the mass encountered is not diagonal.\n\nUsage involves creating an instance of this visitor and specifying where to store the count result via a pointer (`sofa::Size*`). It can be used in scenarios requiring information about non-diagonal masses, such as debugging or performance profiling.",
  "maths": "The `MechanicalGetNonDiagonalMassesCountVisitor` is a specialized visitor in the SOFA framework that counts the number of non-diagonal mass matrices within a mechanical system. This component plays a role in the broader FEM simulation pipeline, particularly during assembly and post-processing phases where information about the structure of the mass matrix is needed.\n\n### Governing Equations or Operators Involved\n- **Mass Matrix** ($M$): The mass matrix $M$ in FEM simulations is typically a symmetric positive semi-definite matrix that represents the inertial properties of the system. For each finite element, if the mass distribution within an element is uniform and the shape functions are linear, then the local mass matrix is often diagonal.\n\n### Constitutive or Kinematic Laws Involved\n- **Mass Distribution**: The mass distribution within elements can be described by various constitutive laws. If the mass distribution is non-uniform or if higher-order shape functions are used, the resulting mass matrix may not be diagonal.\n\n### Role in the Global FEM Pipeline\n1. **Assembly Phase**: During assembly, this visitor traverses through all `BaseMass` components to count those with non-diagonal matrices. This information can be useful for debugging or performance analysis since non-diagonal masses might indicate more complex mass distributions.\n2. **Post-Processing**: The result of the counting operation can be used in post-processing steps to analyze the structure of the assembled mass matrix, which is important for numerical stability and solver efficiency.\n\n### Numerical Methods or Discretization Choices Encoded\n- **Visitor Pattern**: This visitor uses a common traversal pattern (the `fwdMass` method) to visit each `BaseMass` component. The traversal ensures that every mass in the system is checked, maintaining consistency across different simulation setups.\n- **Incremental Counting**: For each visited `BaseMass`, if it is not diagonal, the counter (`m_nbNonDiagonalMassesPtr`) is incremented. This simple incremental mechanism efficiently accumulates the count of non-diagonal masses throughout the entire mechanical system.\n\n### Fit into Variational / Lagrangian Mechanics Framework\n- **Variational Context**: Although this visitor does not directly contribute to solving variational equations, it provides crucial information about the mass distribution within elements. In a variational context, understanding whether the mass matrix is diagonal or non-diagonal can impact how the weak form of the governing PDEs is discretized and solved.\n- **Lagrangian Mechanics**: The visitor indirectly supports the Lagrangian mechanics framework by ensuring that all masses are accounted for in their correct form. This alignment with Lagrangian principles helps maintain consistency across different aspects of the simulation, including mass distribution and its influence on inertial forces.\n\nIn summary, `MechanicalGetNonDiagonalMassesCountVisitor` plays a supporting role in the FEM pipeline by providing critical information about the structure of the mass matrix. This information is valuable for ensuring numerical stability and efficient solver performance, aligning with broader principles of variational mechanics.",
  "abstract": "Counts non-diagonal masses within a mechanical system by visiting each `BaseMass` component during simulation operations.",
  "sheet": "# MechanicalGetNonDiagonalMassesCountVisitor\n\n## Overview\nThe `MechanicalGetNonDiagonalMassesCountVisitor` is a specialized visitor in the SOFA framework designed to count the number of non-diagonal masses within a mechanical system. It inherits from `MechanicalVisitor`, indicating its role in visiting and processing mechanical components during simulation operations.\n\n## Practical Notes\nThis component primarily interfaces with instances of `BaseMass` through the `fwdMass` method, which increments a counter if the mass encountered is not diagonal. Usage involves creating an instance of this visitor and specifying where to store the count result via a pointer (`sofa::Size*`). This information can be useful for debugging or performance analysis since non-diagonal masses might indicate more complex mass distributions."
}