Methods

{
  "name": "SceneCheckAPIChange",
  "namespace": "sofa::_scenechecking_",
  "module": "applications.projects.SceneChecking",
  "include": "SceneChecking/SceneCheckAPIChange.h",
  "doc": "",
  "inherits": [
    "SceneCheck"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "newSPtr",
      "return_type": "SPtr",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "getName",
      "return_type": "const int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getDesc",
      "return_type": "const int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doInit",
      "return_type": "void",
      "params": [
        {
          "name": "node",
          "type": "sofa::simulation::Node *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doCheckOn",
      "return_type": "void",
      "params": [
        {
          "name": "node",
          "type": "sofa::simulation::Node *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "doPrintSummary",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "installDefaultChangeSets",
      "return_type": "void",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "addHookInChangeSet",
      "return_type": "void",
      "params": [
        {
          "name": "version",
          "type": "const int &"
        },
        {
          "name": "fct",
          "type": "ChangeSetHookFunction"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `SceneCheckAPIChange` component is part of the SOFA framework's SceneChecking module and inherits from `sofa::simulation::SceneCheck`. Its primary role is to verify that components have not changed in behavior since a specified reference version of SOFA. This can be useful for ensuring backward compatibility or detecting changes in API usage across different versions of the software.\n\n**Role:**\n- It checks each component within a scene and identifies any changes in their behavior, API, default values, etc., compared to a selected API level.\n\n**Interactions with Other Components:*\n- `doInit`: Initializes the component by determining the current SOFA version and looking for an `APIVersion` component in the scene. If none is found, it defaults to a specific version (17.06).\n- `doCheckOn`: Iterates through all objects within a given node and checks if their behavior has changed based on predefined hooks.\n\n**Practical Usage Guidance:*\n- The component does not require explicit data fields for initialization; instead, it operates by examining the scene's components dynamically at runtime.\n- The `installDefaultChangeSets` method provides a template to add custom check functions via `addHookInChangeSet`, which allows users to define specific checks for different versions of SOFA.",
  "maths": "The `SceneCheckAPIChange` component in the SOFA framework is designed to ensure that components within a scene have not changed behavior since a specified reference version of SOFA. This is crucial for maintaining backward compatibility and detecting changes in API usage across different versions of the software. The mathematical and physical description of this component is limited due to its primary role being checks rather than direct involvement in FEM simulation processes, but here are the key points regarding its operation within the broader framework:\n\n### Role in the Global FEM Pipeline\n- **Assembly Phase**: While `SceneCheckAPIChange` does not directly contribute to assembling global mass matrices or stiffness matrices, it ensures that components used for assembly (e.g., force fields, constraints) have consistent behavior across different versions of SOFA.\n- **Time Integration and Nonlinear Solve**: It indirectly supports these phases by ensuring that components involved in time integration schemes and nonlinear solvers behave as expected based on their specified API version.\n\n### Numerical Methods or Discretization Choices\nThe component does not encode any specific numerical methods or discretizations. Instead, it operates at a meta-level to verify the consistency of components with respect to different SOFA versions.\n\n### Governing Equations and Operators\n`SceneCheckAPIChange` does not directly contribute to governing equations or operators such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), etc. Its role is more about ensuring that these components are used consistently across different versions.\n\n### Constitutive or Kinematic Laws Involved\nThe component does not directly involve any constitutive laws (e.g., stress-strain relationships) or kinematic laws (e.g., strain measures). Instead, it verifies the behavior of such laws as implemented in various SOFA components.\n\n### Constraint Handling and Mapping\nWhile `SceneCheckAPIChange` itself does not handle constraints or mappings directly, it ensures that these functionalities are consistent across different versions by checking for any changes in their implementation.\n\n### Variational / Lagrangian Mechanics Framework Fit\nThe component indirectly supports the variational mechanics framework by ensuring that all components used within this framework behave consistently with respect to specified API levels. This is crucial for maintaining the integrity and consistency of simulations across different SOFA versions.\n\nIn summary, `SceneCheckAPIChange` plays a role in maintaining compatibility and consistency in the broader FEM simulation pipeline but does not directly contribute to mathematical or physical aspects such as equations or operators.",
  "abstract": "`SceneCheckAPIChange` verifies that components have not changed in behavior since a specified reference version of SOFA, ensuring backward compatibility and detecting changes in API usage across different versions.",
  "sheet": "# SceneCheckAPIChange\n\n## Overview\nThe `SceneCheckAPIChange` component is part of the SOFA framework's SceneChecking module. It inherits from `sofa::simulation::SceneCheck`. Its primary role is to verify that components have not changed in behavior since a specified reference version of SOFA, ensuring backward compatibility and detecting changes in API usage across different versions.\n\n## Practical Notes\n- The component does not require explicit data fields for initialization; instead, it operates by examining the scene's components dynamically at runtime.\n- The `installDefaultChangeSets` method provides a template to add custom check functions via `addHookInChangeSet`, which allows users to define specific checks for different versions of SOFA."
}