Methods

{
  "name": "Task",
  "namespace": "sofa::simulation",
  "module": "Sofa.framework.Simulation.Core",
  "include": "sofa/simulation/task/Task.h",
  "doc": "Task class interface    */",
  "inherits": [],
  "templates": [],
  "data_fields": [],
  "links": [],
  "methods": [
    {
      "name": "run",
      "return_type": "MemoryAlloc",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": true,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "operator new",
      "return_type": "void *",
      "params": [
        {
          "name": "sz",
          "type": "int"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "operator delete",
      "return_type": "void",
      "params": [
        {
          "name": "ptr",
          "type": "void *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "operator delete",
      "return_type": "void",
      "params": [
        {
          "name": "ptr",
          "type": "void *"
        },
        {
          "name": "sz",
          "type": "int"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "operator new[]",
      "return_type": "void *",
      "params": [
        {
          "name": "sz",
          "type": "int"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "getStatus",
      "return_type": "Task::Status *",
      "params": [],
      "is_virtual": true,
      "is_pure_virtual": true,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getScheduledThread",
      "return_type": "int",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": false,
      "access": "public"
    },
    {
      "name": "getAllocator",
      "return_type": "Task::Allocator *",
      "params": [],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    },
    {
      "name": "setAllocator",
      "return_type": "void",
      "params": [
        {
          "name": "allocator",
          "type": "Task::Allocator *"
        }
      ],
      "is_virtual": false,
      "is_pure_virtual": false,
      "is_static": true,
      "access": "public"
    }
  ],
  "description": "The `Task` class in the SOFA framework is an abstract interface for representing tasks within the simulation engine. It serves as a base for defining custom task types that can be scheduled and executed by the framework's scheduler.\n\n**Role and Purpose:**\n- The primary role of the `Task` class is to provide a consistent interface for task execution, synchronization, and memory management. \n- Tasks are essential for organizing and executing simulation steps in a structured manner, allowing for parallel or sequential processing depending on the scheduling policy.\n\n**Interactions with Other Components:**\n- The `Task` class interacts with the framework's scheduler through methods like `run()`, which must be overridden by derived classes to define specific task behavior. \n- It also uses an allocator (`Allocator`) and status (`Status`) system for memory management and synchronization, respectively.\n\n**Practical Usage Guidance:**\n- Developers can create custom tasks by inheriting from the `Task` class and implementing the required methods such as `run()` and `getStatus()`. \n- Memory allocation and deallocation are handled through static operator overloads that use an allocator instance. The allocator must be set using `setAllocator()`.\n\n**Data Fields:**\n- `m_scheduledThread`: Indicates the thread in which this task is scheduled to run.\n- `m_id`: Unique identifier for the task.",
  "maths": "The `Task` class in the SOFA framework is an abstract interface for representing tasks within the simulation engine. It does not directly contribute to any specific mathematical or physical operators used in the Finite Element Method (FEM) pipeline, such as mass matrix \\(M\\), stiffness matrix \\(K\\), internal force \\(f_{int}\\), residual \\(R\\), etc. Instead, it provides a framework for defining and managing tasks that may be involved in various stages of the simulation process.\n\n### Role in FEM Pipeline:\n- **Assembly**: While `Task` itself does not perform assembly operations directly, derived classes could implement methods to assemble global matrices or vectors.\n- **Time Integration**: Derived task types can include time integration schemes such as implicit Euler or Newmark-type methods.\n- **Nonlinear Solve**: Tasks might encompass the nonlinear solve step by providing custom Newton-Raphson iteration implementations.\n- **Linear Solve**: Similarly, tasks could be responsible for linear system solutions using iterative solvers like Conjugate Gradient (CG).\n- **Constraint Handling and Mapping**: Custom task implementations may include methods to handle constraints or mappings between different parts of the simulation graph.\n\n### Numerical Methods:\n- The `Task` class does not encode specific numerical discretization choices. However, derived classes can implement particular methods for spatial discretization (e.g., FEM shape functions), time integration schemes, and nonlinear solution strategies.\n\n### Variational/Lagrangian Mechanics Framework:\n- The `Task` class is more of a structural component that helps organize the simulation workflow rather than directly contributing to variational formulations or Lagrangian mechanics. Derived classes might implement specific physics through methods like `run()`, but this would be application-specific and not inherent to the `Task` interface itself.\n\n### Summary:\n- The `Task` class provides a generic framework for task execution, synchronization, and memory management within SOFA simulations.\n- It does not directly contribute mathematical operators or constitutive laws. Instead, it facilitates the organization and execution of tasks that can be involved in various stages of FEM simulation.",
  "abstract": "The `Task` class in SOFA provides an abstract interface for defining and managing simulation tasks, including execution, memory management, and synchronization.",
  "sheet": "# Task\n\n## Overview\n\nThe `Task` class is an abstract interface within the SOFA framework that defines a consistent structure for task execution, memory allocation/deallocation, and status tracking. It serves as a base for custom task types that can be scheduled by the simulation engine's scheduler.\n\n## Parameters and Data\n\n- **m_scheduledThread**: Indicates the thread in which this task is scheduled to run (type: `int`).\n- **m_id**: Unique identifier for the task (type: unspecified).\n"
}