Data Fields

Methods

{
  "name": "RequiredPlugin",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/RequiredPlugin.h",
  "doc": "Load the SOFA modules and/or plugins required to run a simulation.",
  "inherits": [
    "BaseObject"
  ],
  "templates": [],
  "data_fields": [
    {
      "name": "d_stopAfterFirstNameFound",
      "type": "bool",
      "xmlname": "stopAfterFirstNameFound",
      "help": "Stop after the first plugin name that is loaded successfully"
    },
    {
      "name": "d_stopAfterFirstSuffixFound",
      "type": "bool",
      "xmlname": "stopAfterFirstSuffixFound",
      "help": "For each plugin name, stop after the first suffix that is loaded successfully"
    },
    {
      "name": "d_requireOne",
      "type": "bool",
      "xmlname": "requireOne",
      "help": "Display an error message if no plugin names were successfully loaded"
    },
    {
      "name": "d_requireAll",
      "type": "bool",
      "xmlname": "requireAll",
      "help": "Display an error message if any plugin names failed to be loaded"
    }
  ],
  "links": [],
  "methods": [
    {
      "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": "loadPlugin",
      "return_type": "bool",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `RequiredPlugin` component in the SOFA ecosystem is designed to manage and load the necessary modules and/or plugins required for a simulation. It inherits from `BaseObject`, which indicates it is a foundational element within the framework, responsible for ensuring that all dependent components are properly initialized and available.\n\n**Interactions with Other Components:**\n- The component interacts with other SOFA components through its API methods such as `parse` and `loadPlugin`. It leverages the `sofa::core::ObjectFactory` to register objects from loaded plugins, ensuring that all required functionalities are accessible within the simulation.\n\n**Practical Usage Guidance: **\n- The component provides several data fields for configuration:\n  - `pluginName`: Specifies one or more plugin names to load. Multiple names can be provided if alternative names are available.\n  - `suffixMap`: Allows specifying standard and custom suffixes for differentiating versions of the plugins.\n  - `stopAfterFirstNameFound`: Stops loading after the first successful plugin name is found.\n  - `stopAfterFirstSuffixFound`: For each plugin, stops after the first successfully loaded suffix.\n  - `requireOne`: Displays an error if no plugin names are successfully loaded.\n  - `requireAll`: Displays an error if any plugin names fail to load.\n\n- The method `loadPlugin` is responsible for attempting to load the specified plugins and handling errors appropriately. If a required plugin fails to load, it can log warnings or errors based on the configuration settings (`requireOne`, `requireAll`).",
  "maths": "The `RequiredPlugin` component in the SOFA framework is primarily responsible for managing the loading and initialization of necessary modules and plugins required for a simulation. It does not directly contribute to the governing equations, constitutive laws, or numerical methods that are central to FEM simulations. Instead, it ensures that all dependent components (e.g., mechanical models, solvers, mappings) are properly registered and available within the SOFA environment.\n\n**Governing Equations / Operators:**\n- **Mass Matrix (M):** Not involved in loading plugins.\n- **Stiffness Matrix (K):** Not involved.\n- **Internal Force (f_int):** Not involved.\n- **Residual (R):** Not involved.\n\n**Constitutive Laws / Kinematic Laws:**\n- The component does not define any constitutive or kinematic laws. It only ensures that all required plugins containing such definitions are loaded correctly.\n\n**Role in the FEM Pipeline: **\n- **Assembly Phase:** Ensures all necessary components for assembly (e.g., mass and stiffness matrices) are registered.\n- **Time Integration:** Ensures availability of time integration schemes.\n- **Nonlinear Resolution:** Ensures nonlinear solvers are available if required by plugins.\n- **Linear Resolution:** Ensures linear solvers are loaded if needed.\n\n**Numerical Methods / Discretization Choices: **\n- The component does not encode any specific numerical methods or discretization choices. Instead, it ensures that all necessary modules and plugins containing these implementations are available for use in the simulation.\n\n**Variational / Lagrangian Mechanics Framework:** \n- Although `RequiredPlugin` itself does not implement variational principles or Lagrangian mechanics directly, it is crucial for ensuring that all components required to build a complete variational FEM framework are loaded and ready for use.\n\nIn summary, the `RequiredPlugin` component plays an essential role in the infrastructure of SOFA simulations by managing the loading and initialization of necessary modules and plugins. It does not contribute directly to the mathematical or physical aspects of the simulation but is crucial for ensuring that all required components are present.",
  "abstract": "`RequiredPlugin` manages and loads necessary modules and plugins required for a SOFA simulation, ensuring all dependent components are properly initialized.",
  "sheet": "# RequiredPlugin\n\n**Overview:**\n`RequiredPlugin` is responsible for loading the necessary modules and plugins required to run a simulation. It inherits from `BaseObject`, indicating its foundational role in ensuring that all dependencies are available.\n\n**Parameters and Data:**\nThe component provides several configuration options:\n- **stopAfterFirstNameFound (bool):** Stops after the first plugin name that is loaded successfully.\n- **stopAfterFirstSuffixFound (bool):** For each plugin name, stops after the first suffix that is loaded successfully.\n- **requireOne (bool):** Displays an error message if no plugin names were successfully loaded.\n- **requireAll (bool):** Displays an error message if any plugin names failed to be loaded.\n\n**Practical Notes:**\nThe `loadPlugin` method handles the loading of specified plugins and manages errors based on configuration settings (`requireOne`, `requireAll`). If a required plugin fails to load, it can log warnings or errors appropriately."
}