Methods

{
  "name": "ContextObject",
  "namespace": "sofa::core::objectmodel",
  "module": "Sofa.framework.Core",
  "include": "sofa/core/objectmodel/ContextObject.h",
  "doc": "Base class for simulation objects that modify the shared context (such as gravity, local coordinate system, ...).",
  "inherits": [
    "BaseObject"
  ],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "toContextObject",
      "return_type": "const ContextObject *",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "apply",
      "return_type": "void",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": true,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "insertInNode",
      "return_type": "bool",
      "params": [
        {
          "name": "node",
          "type": "objectmodel::BaseNode *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "removeInNode",
      "return_type": "bool",
      "params": [
        {
          "name": "node",
          "type": "objectmodel::BaseNode *"
        }
      ],
      "is_virtual": true,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    }
  ],
  "description": "The `ContextObject` class in the SOFA framework is a base class for simulation objects that modify the shared context, such as gravity or local coordinate systems. It inherits from `BaseObject`, which indicates it is part of the core object model hierarchy within SOFA.\n\n### Role and Purpose\n- **Purpose**: To provide a mechanism to modify global/shared contexts (e.g., gravity) in the simulation environment.\n- **Role**: Base class that defines methods for insertion, removal from nodes, and modifying context properties.\n\n### Interactions with Other Components\n- **BaseNode Interaction**:\n  - The `insertInNode` method adds this object to a node's list of context objects.\n  - The `removeInNode` method removes it from the same list.\n- **Method Overriding**: Provides methods like `apply`, which must be implemented by derived classes, ensuring that any specific context modifications are defined.\n\n### Practical Usage Guidance and Data Fields\n- **Data Fields**: None explicitly listed in the metadata or source code provided. However, derived classes may define additional fields to represent context properties (e.g., gravity values).\n- **Methods**:\n  - `apply`: Abstract method that must be overridden by subclasses to specify how this object modifies the shared context.\n  - `toContextObject`: Virtual method that returns a pointer to itself as a `ContextObject` instance.\n\n### Usage Guidance\nDerived classes should implement the `apply` method to define specific modifications to the simulation context. The `insertInNode` and `removeInNode` methods handle registration with the scene graph, ensuring proper lifecycle management within SOFA nodes.",
  "maths": "The `ContextObject` class in the SOFA framework serves as a base class for simulation objects that modify shared context properties, such as gravity or local coordinate systems. This class does not directly participate in mathematical operations related to finite element analysis (FEA) or other physical simulations. Instead, it provides an abstract interface and methods for managing these shared contexts within the scene graph.\n\n### Mathematical and Physical Content\n- **Mathematical Role**: The `ContextObject` itself does not have inherent mathematical content; rather, it is designed to influence global properties that affect FEA calculations indirectly. For example, gravity can be considered a force field influencing the motion of objects in the simulation domain. Mathematically, this might be represented as a vector \\\\[ \\mathbf{g} = (0, -9.81, 0) \\\\] for Earth's gravitational acceleration.\n- **Physical Role**: Context properties like gravity can affect the equations of motion and forces acting on bodies in the simulation. For instance, the gravitational force \\( \\mathbf{F}_g \\) on a mass \\( m \\) is given by \\( \\mathbf{F}_g = m \\mathbf{g} \\).\n\n### Role in Global FEM Pipeline\n- **Assembly**: Context objects such as gravity do not directly participate in the assembly of system matrices or vectors. However, they can influence the load vector in static problems or the right-hand side in dynamic problems.\n- **Time Integration**: In time integration schemes (e.g., explicit Euler, Newmark), gravity or other context properties modify the acceleration terms used to compute new positions and velocities at each timestep.\n- **Nonlinear Solve**: Context properties can influence nonlinear residual calculations. For instance, if a context object modifies stiffness properties, it can affect the Jacobian matrix in Newton-Raphson methods.\n- **Linear Solve**: While not directly involved in linear solves, context modifications (e.g., gravity) indirectly affect the linear system of equations being solved.\n\n### Numerical Methods and Discretization Choices\nThe `ContextObject` class does not encode specific numerical methods or discretization choices. Instead, it provides a framework for derived classes to define and modify shared contexts that can influence various aspects of FEA and other simulation techniques.\n\n### Variational / Lagrangian Mechanics Framework\nIn the broader variational/Lagrangian mechanics context, `ContextObject` indirectly influences the potential energy terms in the Lagrangian formulation. For example, gravitational potential energy \\( V_g = mgh \\) can be modified by a context object that changes gravity values.\n\n### Summary\nThe `ContextObject` class is an abstract base class for objects that modify shared simulation contexts like gravity or local coordinate systems. It does not have direct mathematical content but influences the physical equations and numerical methods used in simulations.",
  "abstract": "`ContextObject` is an abstract base class that modifies shared context properties (e.g., gravity) within the SOFA simulation environment.",
  "sheet": "# ContextObject\n\n**Overview**\n\nThe `ContextObject` class serves as a base for simulation objects that modify global/shared contexts, such as gravity or local coordinate systems. It inherits from `BaseObject`, indicating its role in the core object model hierarchy within SOFA.\n\n**Dependencies and Connections**\n\nThis component interacts with `BaseNode` to manage insertion (`insertInNode`) and removal (`removeInNode`). Derived classes must implement the `apply` method to specify how they modify the shared context."
}