Methods

{
  "name": "MechanicalVPrintVisitor",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/MechanicalVPrintVisitor.h",
  "doc": "Print a vector */",
  "inherits": [
    "Visitor"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "processNodeTopDown",
      "return_type": "Result",
      "params": [
        {
          "name": "node",
          "type": "simulation::Node *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `MechanicalVPrintVisitor` is part of the SOFA framework's simulation module and inherits from the `Visitor` class. Its role is to print vector data during a simulation, which can be useful for debugging or monitoring the state of mechanical components in real-time. The visitor traverses nodes within the scene graph, specifically targeting those with non-empty mechanical states, and prints the specified vector data associated with each node's degrees of freedom (DOFs). It interacts with other SOFA components through its `processNodeTopDown` method, which is part of the Visitor pattern. This method processes a given `simulation::Node`, retrieving and printing vector data to an output stream. Practical usage involves initializing `MechanicalVPrintVisitor` with specific parameters like execution context (`core::ExecParams*`) and the vector identifier (`ConstMultiVecId`).",
  "maths": "The `MechanicalVPrintVisitor` is a visitor component within the SOFA framework that facilitates printing vector data during simulations. This functionality can be particularly useful for debugging or monitoring purposes.\n\n### Governing Equations and Operators:\nThe `MechanicalVPrintVisitor` itself does not contribute to any governing equations, operators such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), etc. Its primary role is to facilitate the printing of vector data from mechanical states in the simulation graph.\n\n### Constitutive or Kinematic Laws:\nThe `MechanicalVPrintVisitor` does not implement any constitutive laws, strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc. It primarily interacts with existing mechanical state components to retrieve and print their vector data.\n\n### Role in the Global FEM Pipeline:\nIn terms of the global finite element method (FEM) simulation pipeline, `MechanicalVPrintVisitor` does not directly participate in assembly, time integration, nonlinear solve, linear solve, or constraint handling. Instead, its role is to provide an interface for inspecting and printing vector data from mechanical states at various points during the simulation.\n\n### Numerical Methods or Discretization Choices:\nThe `MechanicalVPrintVisitor` does not encode any numerical methods or discretization choices as it is purely a visitor component responsible for outputting data. It operates on the existing data structures provided by the SOFA framework's mechanical states and nodes.\n\n### Integration into Variational / Lagrangian Mechanics Framework:\nWhile the `MechanicalVPrintVisitor` itself does not directly contribute to the variational or Lagrangian mechanics framework, it provides a means to observe and inspect the internal state of mechanical components that are part of this framework. By printing out vectors representing DOFs, displacements, velocities, etc., it can assist in debugging and validating the correctness of the simulation.\n\n### Summary:\nThe `MechanicalVPrintVisitor` is a utility component designed for outputting vector data from mechanical states within the SOFA framework. It does not contribute to any mathematical or physical laws but serves as a tool for monitoring and debugging purposes during simulations.",
  "abstract": "The `MechanicalVPrintVisitor` prints vector data from mechanical states in the simulation graph, aiding in debugging and real-time state monitoring.",
  "sheet": "\n# MechanicalVPrintVisitor\n\n## Overview\n\nThe `MechanicalVPrintVisitor` is a utility component that inherits from the `Visitor` class within SOFA's simulation module. Its primary role is to print vector data associated with mechanical states during simulations, which can be useful for debugging or monitoring purposes.\n\n## Dependencies and Connections\n\nThis visitor interacts with other components through its `processNodeTopDown` method, which processes nodes in the scene graph to retrieve and print vector data from their degrees of freedom (DOFs). The component does not have any significant parameters or dependencies beyond those inherited from the `Visitor` class."
}