Methods

{
  "name": "MechanicalProjectPositionAndVelocityVisitor",
  "namespace": "sofa::simulation::mechanicalvisitor",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/mechanicalvisitor/MechanicalProjectPositionAndVelocityVisitor.h",
  "doc": "",
  "inherits": [
    "MechanicalVisitor"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "fwdMechanicalMapping",
      "return_type": "Result",
      "params": [
        {
          "name": "",
          "type": "simulation::Node *"
        },
        {
          "name": "map",
          "type": "sofa::core::BaseMapping *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "fwdProjectiveConstraintSet",
      "return_type": "Result",
      "params": [
        {
          "name": "",
          "type": "simulation::Node *"
        },
        {
          "name": "c",
          "type": "sofa::core::behavior::BaseProjectiveConstraintSet *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getInfos",
      "return_type": "int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "isThreadSafe",
      "return_type": "bool",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `MechanicalProjectPositionAndVelocityVisitor` is part of the SOFA framework's simulation and mechanical visitor system, designed to handle position and velocity projection in computational biomechanics simulations. It inherits from `MechanicalVisitor`, indicating its role as a specialized mechanical visitor that projects positions and velocities based on given parameters.\n\nThis component interacts with other mechanical visitors and nodes within the SOFA scene graph by implementing methods such as `fwdMechanicalMapping` and `fwdProjectiveConstraintSet`. These methods are virtual functions overridden to provide specific behavior for projecting position and velocity data, particularly through constraint sets. The visitor is designed to be thread-safe (`isThreadSafe` returns true), which allows it to operate efficiently in parallelized simulation contexts.\n\nThe component takes into account mechanical parameters (`mechaparams`) and time (`t`), as well as IDs for position and velocity (`pos` and `vel`). The visitor is responsible for projecting these positions and velocities using constraint sets, ensuring accurate state updates during simulations. This functionality is crucial for maintaining consistency across different simulation components and ensuring physically plausible interactions.",
  "maths": "The `MechanicalProjectPositionAndVelocityVisitor` is a specialized mechanical visitor in the SOFA framework designed to handle position and velocity projection. It does not directly contribute to the governing equations or operators such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), or residual \\(R\\). Instead, it focuses on projecting positions and velocities through constraint sets during simulation. Here is a detailed description of its role in the FEM pipeline:\n\n1. **Role in the Global FEM Pipeline**\n   - The component operates within the scene graph traversal phase of the FEM pipeline.\n   - It projects position \\(x\\) and velocity \\(v\\) based on given mechanical parameters (`mechaparams`) and time (`t`). This projection ensures consistency across different simulation components, particularly in maintaining physically plausible interactions.\n\n2. **Numerical Methods or Discretization Choices**\n   - The component does not encode any specific numerical methods or discretization choices directly related to solving the FEM equations.\n   - It relies on constraint sets (`BaseProjectiveConstraintSet`) to project positions and velocities, which are crucial for maintaining consistency in state updates during simulations.\n\n3. **Projection Mechanism**\n   - The `fwdProjectiveConstraintSet` method projects position \\(x\\) and velocity \\(v\\) using the constraint sets provided by SOFA's mechanical framework.\n     \n   \\[\n   c->projectPosition(mparams, pos)\n   \\]\n\n   \\[\n   c->projectVelocity(mparams, vel)\n   \\]\n   - This projection ensures that position and velocity states are consistent with the constraints defined in the simulation. The `mechaparams` parameter is used to specify mechanical parameters relevant to the projection process.\n\n4. **Constraint Handling**\n   - The component interacts with constraint sets (`BaseProjectiveConstraintSet`) to enforce physical consistency in state updates.\n   - By projecting positions and velocities, it ensures that all constraints are satisfied, which is essential for maintaining a physically accurate simulation.\n\n5. **Thread Safety**\n   - The visitor is designed to be thread-safe (`isThreadSafe` returns true), allowing efficient parallelized operation during simulations.\n\nIn summary, the `MechanicalProjectPositionAndVelocityVisitor` plays a critical role in ensuring consistency and physical plausibility by projecting positions and velocities through constraint sets during scene graph traversal. It does not directly contribute to solving the FEM equations but is essential for maintaining accurate state updates.",
  "abstract": "The `MechanicalProjectPositionAndVelocityVisitor` projects positions and velocities through constraint sets to maintain consistency across simulation components.",
  "sheet": "# MechanicalProjectPositionAndVelocityVisitor\n\n## Overview\nThe `MechanicalProjectPositionAndVelocityVisitor` is a specialized mechanical visitor that handles position and velocity projection in SOFA simulations. It inherits from the `MechanicalVisitor` class, indicating its role as a component designed to ensure consistency across different simulation components by projecting positions and velocities through constraint sets.\n\n## Parameters and Data\nThe component does not expose any significant data fields or parameters directly; it relies on mechanical parameters (`mechaparams`) and time (`t`) for projection operations. The `fwdProjectiveConstraintSet` method projects position and velocity states using the provided constraint sets, ensuring consistency in state updates.\n\n## Dependencies and Connections\nThe component typically requires interaction with other mechanical visitors and nodes within the SOFA scene graph. It implements methods such as `fwdMechanicalMapping` and `fwdProjectiveConstraintSet`, which are virtual functions overridden to provide specific behavior for projecting position and velocity data through constraint sets.\n\n## Practical Notes\nThis visitor is designed to be thread-safe (`isThreadSafe` returns true), allowing efficient parallelized operation during simulations. It ensures that all constraints are satisfied, maintaining a physically accurate simulation by projecting positions and velocities consistently."
}