Methods

{
  "name": "MechanicalVInitVisitor",
  "namespace": "sofa::simulation::mechanicalvisitor",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/mechanicalvisitor/MechanicalVInitVisitor.h",
  "doc": "Initialize unset MState destVecId vectors with srcVecId vectors value.",
  "inherits": [
    "BaseMechanicalVisitor"
  ],
  "templates": [
    "sofa::core::V_COORD",
    "sofa::core::V_DERIV"
  ],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "stopAtMechanicalMapping",
      "return_type": "bool",
      "params": [
        {
          "name": "",
          "type": "simulation::Node *"
        },
        {
          "name": "",
          "type": "sofa::core::BaseMapping *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "fwdMechanicalState",
      "return_type": "Result",
      "params": [
        {
          "name": "node",
          "type": "simulation::Node *"
        },
        {
          "name": "mm",
          "type": "sofa::core::behavior::BaseMechanicalState *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "fwdMappedMechanicalState",
      "return_type": "Result",
      "params": [
        {
          "name": "node",
          "type": "simulation::Node *"
        },
        {
          "name": "mm",
          "type": "sofa::core::behavior::BaseMechanicalState *"
        }
      ],
      "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 `MechanicalVInitVisitor` is part of the SOFA framework and plays a role in initializing unset vectors within mechanical states by copying values from specified source vectors to destination vectors. It operates as a visitor, inheriting from `BaseMechanicalVisitor`, and is templated on vector types (`sofa::core::V_COORD` and `sofa::core::V_DERIV`). This component interacts with other SOFA components through the API via its virtual methods such as `fwdMechanicalState` and `fwdMappedMechanicalState`. These methods are called during simulation to propagate initialization across different mechanical states. The method `stopAtMechanicalMapping` determines if the propagation should stop at certain mappings, while `isThreadSafe` indicates that this visitor is not thread-safe, ensuring proper synchronization when used in a multi-threaded environment. Practical usage involves configuring source (`vSrc`) and destination (`vDest`) vectors during initialization.",
  "maths": "The `MechanicalVInitVisitor` is a visitor component in the SOFA framework designed to initialize unset vectors within mechanical states by copying values from specified source vectors to destination vectors. This component does not directly contribute to governing equations, constitutive laws, or kinematic formulations typical of FEM and variational mechanics frameworks. Instead, it serves as an initialization tool that ensures proper vector configurations across different mechanical states during the simulation process.\n\n### Mathematical and Physical Description:\n\n#### Role in the Global FEM Pipeline\n- **Initialization**: The `MechanicalVInitVisitor` is responsible for initializing vectors within mechanical states. Specifically, if a destination vector (`vDest`) has not been set, it initializes it by copying values from a source vector (`vSrc`). This operation ensures that all necessary state variables are properly initialized before any simulation computations begin.\n\n- **Propagation**: The component propagates this initialization across different mechanical states using the methods `fwdMechanicalState` and `fwdMappedMechanicalState`. These methods ensure that the initialization is applied consistently throughout the simulation graph, particularly when dealing with mapped mechanical states.\n\n#### Numerical Methods or Discretization Choices\n- **Vector Initialization**: The visitor does not involve any complex numerical integration schemes or spatial discretizations. Instead, it performs a straightforward operation of copying values from one vector to another if the destination vector is not already set.\n\n- **Thread Safety**: It is explicitly noted that this component is not thread-safe (`isThreadSafe` returns `false`). This means care must be taken when using this visitor in multi-threaded environments to ensure proper synchronization and avoid race conditions.\n\n#### Integration into Variational / Lagrangian Mechanics Framework\n- **Variational Consistency**: The `MechanicalVInitVisitor` itself does not directly contribute to the variational formulation or the governing equations of motion. Instead, it ensures that all necessary state variables (e.g., displacement vectors) are properly initialized before any variational formulations or numerical integration steps begin.\n\n### Summary\nThe `MechanicalVInitVisitor` is a utility component within the SOFA framework used for initializing mechanical states by copying values from source to destination vectors. It plays an important role in ensuring that all state variables are properly configured before simulation computations commence, but does not directly participate in the mathematical formulation of mechanics problems such as FEM or variational principles.",
  "abstract": "The `MechanicalVInitVisitor` initializes unset vectors within mechanical states by copying values from source to destination vectors, ensuring proper initialization before simulation computations commence.",
  "sheet": "# MechanicalVInitVisitor\n\n## Overview\nThe `MechanicalVInitVisitor` is a utility component in the SOFA framework that ensures all necessary state variables are properly initialized before any simulation computations begin. It initializes unset vectors within mechanical states by copying values from specified source vectors to destination vectors.\n\n## Dependencies and Connections\nThis visitor interacts with other components through its virtual methods such as `fwdMechanicalState` and `fwdMappedMechanicalState`, which propagate initialization across different mechanical states. The method `stopAtMechanicalMapping` determines if the propagation should stop at certain mappings, ensuring consistent initialization throughout the simulation graph.\n\n## Practical Notes\nThe `MechanicalVInitVisitor` is not thread-safe (`isThreadSafe` returns `false`). Care must be taken when using this visitor in multi-threaded environments to ensure proper synchronization and avoid race conditions."
}