{
  "name": "CpuTask",
  "main": {
    "name": "CpuTask",
    "namespace": "sofa::simulation",
    "module": "Sofa.framework.Simulation.Core",
    "include": "sofa/simulation/task/CpuTask.h",
    "doc": "Base class to implement a CPU task\n  all the tasks running on the CPU should inherits from this class",
    "inherits": [
      "Task"
    ],
    "templates": [],
    "data_fields": [],
    "links": [],
    "methods": [
      {
        "name": "getStatus",
        "return_type": "Status *",
        "params": [],
        "is_virtual": true,
        "is_pure_virtual": false,
        "is_static": false,
        "access": "public"
      }
    ]
  },
  "desc": {
    "description": "The `CpuTask` class in the SOFA framework serves as a base for implementing tasks that run on the CPU. It inherits from the `Task` class and is designed to handle all tasks executed on the CPU within the simulation framework. The primary role of `CpuTask` is to manage the status and execution context of these tasks, ensuring they operate efficiently on the CPU.\n\n### Interactions with Other Components\n- **Inheritance**: `CpuTask` inherits from the `Task` class, which provides a common interface for task management in SOFA.\n- **Status Management**: The `getStatus()` method returns the status of the CPU task, allowing other components to query and manage task states effectively.\n\n### Practical Usage Guidance\n- **Inheritance Requirement**: All tasks intended to run on the CPU should inherit from `CpuTask` and implement its methods appropriately.\n- **Initialization**: Tasks are initialized with a status object (`Status*`) and an optional parameter for scheduling on specific threads. The default value `-1` indicates that no specific thread is assigned.\n\n### Data Fields\n- **m_status**: A private data field used to store the task's status, accessible via `getStatus()`. This ensures encapsulation and controlled access to the task's state."
  },
  "maths": {
    "maths": "The `CpuTask` class in the SOFA framework does not directly implement or contribute to any governing equations, constitutive laws, kinematic laws, or numerical methods that are specific to FEM. Instead, it serves as a base class for implementing tasks that run on the CPU within the simulation pipeline. The primary role of `CpuTask` is to manage and provide status information about these tasks, ensuring they operate efficiently in the context of computational mechanics simulations.\n\n### Governing Equations or Operators\n- **None**: `CpuTask` does not contribute directly to any mathematical operators such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), etc. It is a utility class that manages the execution context of tasks.\n\n### Constitutive or Kinematic Laws Involved\n- **None**: `CpuTask` does not involve any specific constitutive laws, kinematic models, strain measures, stress tensors, hyperelastic potentials, damping models, or constraint Jacobians. Its purpose is to manage task status and execution rather than perform mechanical computations.\n\n### Role in the Global FEM Pipeline\n- **Execution Management**: `CpuTask` ensures that tasks intended for CPU execution are managed properly within the simulation pipeline. It provides a standardized way to handle task statuses, which can be queried by other components of the SOFA framework.\n\n### Numerical Methods or Discretization Choices Encoded\n- **None**: The class itself does not encode any numerical methods or discretization choices. Its focus is on managing the execution and status of tasks rather than performing specific numerical computations.\n\n### How It Fits into the Broader Variational / Lagrangian Mechanics Framework\n- **Contextual Management**: `CpuTask` plays a role in providing the necessary infrastructure for executing tasks that may be part of the broader variational or Lagrangian mechanics framework. However, it does not directly contribute to the mathematical formulation or solution methods used in these frameworks.\n\n### Summary\nThe `CpuTask` class is primarily concerned with task management and status reporting within the SOFA simulation framework. It does not have direct mathematical content related to FEM equations or mechanical models."
  },
  "summary": {
    "abstract": "`CpuTask` manages the status and execution of CPU tasks within the SOFA simulation framework.",
    "sheet": "\n# CpuTask\n\n## Overview\n\nThe `CpuTask` class serves as a base for implementing tasks that run on the CPU. It inherits from the `Task` class, providing a common interface for task management in SOFA simulations.\n\n## Dependencies and Connections\n\n- **Inheritance**: `CpuTask` inherits from the `Task` class, which provides a standardized way to manage tasks within the simulation framework.\n- **Status Management**: The `getStatus()` method allows other components to query the status of CPU tasks effectively."
  }
}