Methods

{
  "name": "SceneLoader",
  "namespace": "sofa::core::loader",
  "module": "Sofa.framework.Core",
  "include": "sofa/core/loader/SceneLoader.h",
  "doc": "",
  "inherits": [
    "BaseLoader"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "canLoad",
      "return_type": "bool",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "parse",
      "return_type": "void",
      "params": [
        {
          "name": "arg",
          "type": "sofa::core::objectmodel::BaseObjectDescription *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "reinit",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `SceneLoader` is part of the SOFA framework and belongs to the `sofa::core::loader` namespace within the Sofa.framework.Core module. It inherits from the `BaseLoader` class, indicating its role in loading scenes or configurations into a SOFA simulation environment.\n\nIts primary function is to parse scene descriptions and load them if they are compatible (`canLoad()` returns true). The `parse` method takes a pointer to a `BaseObjectDescription`, which contains information about the objects to be loaded into the scene. If the loader can handle the loading, it proceeds; otherwise, it logs an informational message.\n\nThe `reinit` and `canLoad` methods are also provided as part of its interface, although their specific implementations in `SceneLoader` currently delegate back to base class functionality.\n\nIn terms of interactions with other components, `SceneLoader` would typically be used alongside scene files or object descriptions to initialize the simulation environment. It is a key component for setting up simulations by integrating external data and configurations.",
  "maths": "The `SceneLoader` component in the SOFA framework is primarily responsible for loading and parsing scene descriptions, rather than directly contributing to any specific mathematical or physical operators such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), constitutive laws, strain measures, stress tensors, hyperelastic potentials, damping models, constraint Jacobians, etc. It is a utility component that facilitates the initialization and setup of simulations by integrating external data and configurations into the simulation environment.\n\n**Governing Equations or Operators:**\n- `SceneLoader` does not directly implement any specific governing equations or operators related to FEM simulations (e.g., mass matrix, stiffness matrix, internal forces).\n\n**Constitutive or Kinematic Laws Involved:**\n- No constitutive or kinematic laws are involved in the `SceneLoader`. Its role is limited to loading and parsing scene descriptions.\n\n**Role in the Global FEM Pipeline:*\n- In the context of the global FEM pipeline, `SceneLoader` primarily functions during the initialization phase. It loads and parses scene configurations into the simulation environment, setting up the initial conditions for subsequent phases such as assembly, time integration, nonlinear solve, linear solve, constraint handling, mapping, etc.\n\n**Numerical Methods or Discretization Choices Encoded:**\n- `SceneLoader` does not encode any specific numerical methods or discretization choices. Its role is to facilitate the loading of scene descriptions and configurations into the simulation environment.\n\n**Fit into Broader Variational / Lagrangian Mechanics Framework:*\n- The broader variational / Lagrangian mechanics framework involves a series of steps from defining continuum physics to performing nonlinear solves, linear solves, and time integration. `SceneLoader` plays an ancillary role by setting up the initial conditions based on external scene descriptions, thereby indirectly contributing to the setup phase of the simulation.\n\nIn summary, while `SceneLoader` is crucial for initializing simulations in SOFA, it does not directly contribute to any specific mathematical or physical operators involved in FEM simulations. Its primary function is to load and parse scene configurations.",
  "abstract": "`SceneLoader` loads and parses scene descriptions into the SOFA simulation environment, facilitating the initialization of simulations based on external configurations.",
  "sheet": "# SceneLoader\n\n## Overview\nThe `SceneLoader` is a utility component in the SOFA framework that inherits from `BaseLoader`. It handles loading and parsing scene descriptions to initialize the simulation environment with external data and configurations.\n\n## Dependencies and Connections\n`SceneLoader` typically interacts with scene files or object descriptions to load initial conditions into the simulation. It fits into the scene graph by setting up the initial state of the simulation based on provided configurations.\n\n## Practical Notes\nWhile `SceneLoader` is essential for initializing simulations, it does not directly contribute to any specific mathematical operators or numerical methods used in FEM simulations. Its primary role is to load and parse external scene descriptions."
}