Methods

{
  "name": "QMomentumStatWidget",
  "namespace": "sofa::qt",
  "module": "sofa.qt.QMomentumStatWidget.cpp",
  "include": "sofa/qt/QMomentumStatWidget.h",
  "doc": "",
  "inherits": [
    "QGraphStatWidget"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "metaObject",
      "return_type": "const QMetaObject *",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "qt_metacast",
      "return_type": "void *",
      "params": [
        {
          "name": "",
          "type": "const char *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "qt_metacall",
      "return_type": "int",
      "params": [
        {
          "name": "",
          "type": "QMetaObject::Call"
        },
        {
          "name": "",
          "type": "int"
        },
        {
          "name": "",
          "type": "void **"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "tr",
      "return_type": "QString",
      "params": [
        {
          "name": "s",
          "type": "const char *"
        },
        {
          "name": "c",
          "type": "const char *"
        },
        {
          "name": "n",
          "type": "int"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "stepImpl",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `QMomentumStatWidget` is a widget component in the SOFA framework, specifically within the `sofa::qt` namespace. It inherits from `QGraphStatWidget`, suggesting that it provides a graphical user interface for displaying statistics related to momentum or similar physical quantities. The primary role of this widget seems to be visualizing and providing real-time feedback on momentum-related data during simulations.\n\nThe component implements several virtual methods, such as `metaObject`, `qt_metacast`, and `qt_metacall`, which are standard for Qt-based widgets, indicating its integration with the Qt framework. The `stepImpl` method suggests that it updates or renders the statistical information at each simulation step.\n\nThis widget likely interacts with other components of SOFA to retrieve and display momentum-related data. Practical usage would involve embedding this widget into a larger GUI setup where users can monitor momentum statistics during simulations.\n\nGiven its inheritance from `QGraphStatWidget`, it is expected that the interactions are through typical Qt signals and slots mechanism, allowing for dynamic updates and integration with other SOFA components.",
  "maths": "The `QMomentumStatWidget` is primarily a visualization tool within the SOFA framework, specifically designed to display statistics related to momentum during simulations. Given its role as a widget and its inheritance from `QGraphStatWidget`, it does not directly contribute to the mathematical or physical components of the simulation pipeline. Instead, it serves as an interface for visualizing and providing real-time feedback on momentum-related data.\n\n### Governing Equations and Operators\nThe `QMomentumStatWidget` itself does not implement any governing equations or operators such as mass matrix $M$, stiffness matrix $K$, internal force $\boldsymbol{f}_{int}$, residual $\boldsymbol{R}$, etc. Its primary function is to visualize these quantities, which are typically computed by other components in the SOFA simulation pipeline.\n\n### Constitutive or Kinematic Laws Involved\nThe widget does not involve any constitutive laws (such as strain measures, stress tensors, hyperelastic potentials) or kinematic laws (such as constraint Jacobians). It simply displays data that is already calculated by other SOFA components involved in the physical simulation.\n\n### Role in the Global FEM Pipeline\n- **Assembly**: The widget does not participate in assembling the global mass matrix $M$, stiffness matrix $K$, internal force vector $\boldsymbol{f}_{int}$, or residual vector $\boldsymbol{R}$. These are handled by other components like `MechanicalObject`, `ForceField`, and `Solver`.\n- **Time Integration**: The widget does not perform time integration. It merely visualizes data at each simulation step via the `stepImpl` method.\n- **Nonlinear Solve and Linear Solve**: Similarly, it does not contribute to solving nonlinear or linear systems; it only displays information about these solutions.\n- **Constraint Handling and Mapping**: The widget is agnostic to constraint handling and mappings. It focuses on displaying momentum-related data.\n\n### Numerical Methods or Discretization Choices\nThe `QMomentumStatWidget` itself does not encode any numerical methods or discretization choices. These are implemented by the underlying SOFA simulation components such as solvers, mechanical objects, and force fields.\n\n### Fit into Variational / Lagrangian Mechanics Framework\nWhile the widget is part of a broader variational and Lagrangian mechanics framework within SOFA, it does not contribute to the mathematical formulation or numerical solution of these principles. It serves purely as an interface for visualizing simulation data, enabling users to monitor momentum-related statistics during simulations.\n\n### Summary\nIn summary, `QMomentumStatWidget` is a visualization tool that displays momentum-related statistical information. It does not directly participate in any mathematical or physical computations but rather interacts with the SOFA framework to retrieve and visualize pre-computed data.",
  "abstract": "The `QMomentumStatWidget` is a visualization tool that displays momentum-related statistical information during SOFA simulations, inheriting from `QGraphStatWidget` to provide real-time feedback on simulation data.",
  "sheet": "# QMomentumStatWidget\n\n## Overview\nThe `QMomentumStatWidget` is a widget component in the SOFA framework designed for visualizing and providing real-time feedback on momentum-related statistics during simulations. It inherits from `QGraphStatWidget`, indicating its role as part of the graphical user interface (GUI) within the SOFA ecosystem.\n\n## Dependencies and Connections\nThe `QMomentumStatWidget` interacts with other components in the SOFA scene graph to retrieve and display pre-computed momentum-related data. This interaction is facilitated through Qt signals and slots, allowing for dynamic updates during simulation steps."
}