libOpenCOR

https://opencor.ws/libopencor/
Admin
libOpenCOR is the backend library to OpenCOR, an open source cross-platform modelling environment.
Tokens:110,514
Snippets:942
Trust Score:7.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install libOpenCOR using pip

Source: https://opencor.ws/libopencor/user/installation/fromPypi.html

Use this command to install the libOpenCOR library from PyPI. Ensure you have pip installed and configured.

```bash
pip install libopencor

```

--------------------------------

### Install libOpenCOR from Source (Python local clone)

Source: https://opencor.ws/libopencor/user/installation/fromSource.html

Clone the libOpenCOR repository and then install the Python package locally using pip.

```bash
git clone --depth 1 https://github.com/opencor/libopencor.git libOpenCOR
cd libOpenCOR
pip install .

```

--------------------------------

### Build and Install libOpenCOR (C++ on Windows)

Source: https://opencor.ws/libopencor/user/installation/fromSource.html

Use these commands to clone the repository, configure the build with CMake, compile the release version, and install the library on Windows.

```bash
git clone --depth 1 https://github.com/opencor/libopencor.git libOpenCOR
cd libOpenCOR
cmake -S . -B build
cmake --build build --config Release
cmake --install build

```

--------------------------------

### Build and Install libOpenCOR (C++ on Linux/macOS)

Source: https://opencor.ws/libopencor/user/installation/fromSource.html

Use these commands to clone the repository, configure the build with CMake, compile, and install the library on Linux or macOS.

```bash
git clone --depth 1 https://github.com/opencor/libopencor.git libOpenCOR
cd libOpenCOR
cmake -S . -B build
cmake --build build
cmake --install build

```

--------------------------------

### Test JavaScript Installation on Windows

Source: https://opencor.ws/libopencor/user/installation/fromSource.html

Install the built libOpenCOR JavaScript bindings using npm and run the test script on Windows.

```bash
cd javascripttest
npm install ..\libOpenCOR\build\libopencor-*.tgz
node index.js

```

--------------------------------

### Install libOpenCOR from Source (Python via pip)

Source: https://opencor.ws/libopencor/user/installation/fromSource.html

Install the Python version of libOpenCOR directly from its GitHub repository using pip.

```bash
pip install git+https://github.com/opencor/libopencor.git

```

--------------------------------

### outputStartTime()

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_sed_uniform_time_course.html

Retrieves the output start time for the simulation.

```APIDOC
## outputStartTime()

### Description
Return the output start time used by this simulation.

### Returns
- The output start time used by this simulation.
```

--------------------------------

### Test Python Installation

Source: https://opencor.ws/libopencor/user/installation/fromSource.html

Run the provided Python script to verify the libOpenCOR installation.

```bash
python test_install.py

```

--------------------------------

### Test C++ Installation on Linux/macOS

Source: https://opencor.ws/libopencor/user/installation/fromSource.html

Build and run a test application after installing libOpenCOR on Linux or macOS. Navigate to the test directory and compile.

```bash
cd cpptest
cmake -S . -B build
cmake --build build

```

--------------------------------

### Test JavaScript Installation on Linux/macOS

Source: https://opencor.ws/libopencor/user/installation/fromSource.html

Install the built libOpenCOR JavaScript bindings using npm and run the test script on Linux or macOS.

```bash
cd javascripttest
npm install ../libOpenCOR/build/libopencor-*.tgz
node index.js

```

--------------------------------

### Output Start Time

Source: https://opencor.ws/libopencor/api/seduniformtimecourse_8h_source.html

Manages the start time for the simulation's output.

```APIDOC
## SedUniformTimeCourse::outputStartTime

### Description
Gets the output start time used by this simulation.

### Method
double outputStartTime() const

## SedUniformTimeCourse::setOutputStartTime

### Description
Sets the output start time to be used by this simulation.

### Method
void setOutputStartTime(double pOutputStartTime)

### Parameters
- **pOutputStartTime** (double) - The output start time for the simulation.
```

--------------------------------

### Test C++ Installation on Windows

Source: https://opencor.ws/libopencor/user/installation/fromSource.html

Build and run a test application after installing libOpenCOR on Windows. Ensure the CMake prefix path is correctly set.

```bash
cd cpptest
cmake -S . -B build -DCMAKE_PREFIX_PATH="C:\Program Files\libOpenCOR\cmake"
cmake --build build --config Release

```

--------------------------------

### setOutputStartTime()

Source: https://opencor.ws/libopencor/api/functions.html

Sets the simulation output start time.

```APIDOC
## setOutputStartTime()

### Description
Sets the start time for the simulation output.

### Method
libOpenCOR::SedUniformTimeCourse.setOutputStartTime()

### Parameters
#### Path Parameters
- **outputStartTime**: Double - The desired start time.

### Returns
- None
```

--------------------------------

### SedOneStep::step

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_sed_one_step.html

Get and set the step size for the simulation.

```APIDOC
## SedOneStep::step and SedOneStep::setStep

### Description
These methods are used to get and set the step size for the one-step simulation.

### `step()` Method
#### Description
Get the step used by this simulation.

#### Method Signature
`double step() const`

#### Returns
The step used by this simulation.

### `setStep()` Method
#### Description
Set the step to be used by this simulation.

#### Method Signature
`void setStep(double pStep)`

#### Parameters
*   **pStep** (double) - The step to be used by this simulation.

### Example
```cpp
// Get the step
double currentStep = simulation->step();

// Set a new step
simulation->setStep(0.1);
```
```

--------------------------------

### SedOneStep::odeSolver

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_sed_one_step.html

Get and set the ODE solver for the simulation.

```APIDOC
## SedOneStep::odeSolver and SedOneStep::setOdeSolver

### Description
These methods are used to get and set the ODE solver for the one-step simulation.

### `odeSolver()` Method
#### Description
Get the ODE solver for this simulation.

#### Method Signature
`SolverOdePtr odeSolver() const`

#### Returns
The ODE solver for this simulation.

### `setOdeSolver()` Method
#### Description
Set the ODE solver for this simulation.

#### Method Signature
`void setOdeSolver(const SolverOdePtr &pOdeSolver)`

#### Parameters
*   **pOdeSolver** (const SolverOdePtr &) - The ODE solver to be used for this simulation.

### Example
```cpp
// Get the ODE solver
SolverOdePtr odeSolver = simulation->odeSolver();

// Set a new ODE solver (assuming 'newSolver' is a valid SolverOdePtr)
// simulation->setOdeSolver(newSolver);
```
```

--------------------------------

### SedOneStep::nlaSolver

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_sed_one_step.html

Get and set the NLA solver for the simulation.

```APIDOC
## SedOneStep::nlaSolver and SedOneStep::setNlaSolver

### Description
These methods are used to get and set the NLA solver for the one-step simulation.

### `nlaSolver()` Method
#### Description
Get the NLA solver for this simulation.

#### Method Signature
`SolverNlaPtr nlaSolver() const`

#### Returns
The NLA solver for this simulation.

### `setNlaSolver()` Method
#### Description
Set the NLA solver for this simulation.

#### Method Signature
`void setNlaSolver(const SolverNlaPtr &pNlaSolver)`

#### Parameters
*   **pNlaSolver** (const SolverNlaPtr &) - The NLA solver to be used for this simulation.

### Example
```cpp
// Get the NLA solver
SolverNlaPtr nlaSolver = simulation->nlaSolver();

// Set a new NLA solver (assuming 'newSolver' is a valid SolverNlaPtr)
// simulation->setNlaSolver(newSolver);
```
```

--------------------------------

### Preconditioner Configuration

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_solver_cvode.html

Methods to get and set the preconditioner used by the CVODE solver.

```APIDOC
## preconditioner

### Description
Get the preconditioner used by the solver.

### Method
const

### Return Value
Preconditioner

## setPreconditioner

### Description
Set the preconditioner to be used by the solver.

### Method
void

### Parameters
- **pPreconditioner** (Preconditioner) - The preconditioner to set.
```

--------------------------------

### Get SedTask Simulation

Source: https://opencor.ws/libopencor/api/sedtask_8h_source.html

Retrieves the SedSimulation associated with this SedTask.

```cpp
SedSimulationPtr SedTask::simulation() const
{
    return pimpl()->mSimulation;
}
```

--------------------------------

### Functions starting with 'w'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section covers functions for retrieving warnings from the Logger.

```APIDOC
## warning()
### Description
Retrieves a specific warning from the Logger.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **index** (int) - The index of the warning to retrieve.
### Request Example
N/A
### Response
#### Success Response
- **return value** (string) - The requested warning.

## warningCount()
### Description
Retrieves the number of warnings in the Logger.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (int) - The number of warnings.

## warnings()
### Description
Retrieves all warnings from the Logger.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (list of string) - A list of all warnings.
```

--------------------------------

### Functions starting with 'o'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'o'.

```APIDOC
## odeSolver()

### Description
Gets the ordinary differential equation solver used in the simulation.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **solver** (string) - The name of the ODE solver.

## outputEndTime()

### Description
Gets the output end time for the uniform time course simulation.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **time** (double) - The output end time.

## outputStartTime()

### Description
Gets the output start time for the uniform time course simulation.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **time** (double) - The output start time.

```

--------------------------------

### Functions starting with 's'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section covers functions for serialization, setting parameters, and simulations.

```APIDOC
## serialise()
### Description
Serialises the SedDocument.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedDocument) - The serialised SedDocument.

## setAbsoluteTolerance()
### Description
Sets the absolute tolerance for the CVODE solver.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **absoluteTolerance** (double) - The absolute tolerance value.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode) - The modified SolverCvode.

## setComponentName()
### Description
Sets the component name for a SedChangeAttribute.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **componentName** (string) - The name of the component.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedChangeAttribute) - The modified SedChangeAttribute.

## setContents()
### Description
Sets the contents of a File.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **contents** (string) - The content to set.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::File) - The modified File.

## setId()
### Description
Sets the ID for a SedBase object.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **id** (string) - The ID to set.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedBase) - The modified SedBase.

## setInitialTime()
### Description
Sets the initial time for a SedUniformTimeCourse.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **initialTime** (double) - The initial time value.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedUniformTimeCourse) - The modified SedUniformTimeCourse.

## setIntegrationMethod()
### Description
Sets the integration method for the CVODE solver.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **integrationMethod** (string) - The integration method.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode) - The modified SolverCvode.

## setInterpolateSolution()
### Description
Sets whether to interpolate the solution for the CVODE solver.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **interpolateSolution** (bool) - True to interpolate, false otherwise.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode) - The modified SolverCvode.

## setIterationType()
### Description
Sets the iteration type for the CVODE solver.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **iterationType** (string) - The iteration type.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode) - The modified SolverCvode.

## setLinearSolver()
### Description
Sets the linear solver for CVODE or KINSOL.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **linearSolver** (string) - The linear solver to use.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode or libOpenCOR::SolverKinsol) - The modified solver.

## setLowerHalfBandwidth()
### Description
Sets the lower half bandwidth for CVODE or KINSOL solvers.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **lowerHalfBandwidth** (int) - The lower half bandwidth.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode or libOpenCOR::SolverKinsol) - The modified solver.

## setMaximumNumberOfIterations()
### Description
Sets the maximum number of iterations for the KINSOL solver.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **maximumNumberOfIterations** (int) - The maximum number of iterations.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverKinsol) - The modified SolverKinsol.

## setMaximumNumberOfSteps()
### Description
Sets the maximum number of steps for the CVODE solver.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **maximumNumberOfSteps** (int) - The maximum number of steps.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode) - The modified SolverCvode.

## setMaximumStep()
### Description
Sets the maximum step size for the CVODE solver.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **maximumStep** (double) - The maximum step size.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode) - The modified SolverCvode.

## setModel()
### Description
Sets the model for a SedTask.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **model** (libOpenCOR::SedModel) - The model to set.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedTask) - The modified SedTask.

## setNewValue()
### Description
Sets the new value for a SedChangeAttribute.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **newValue** (string) - The new value.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedChangeAttribute) - The modified SedChangeAttribute.

## setNlaSolver()
### Description
Sets the non-linear algebraic solver for a SedSimulation.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **nlaSolver** (string) - The name of the NLA solver.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedSimulation) - The modified SedSimulation.

## setNumberOfSteps()
### Description
Sets the number of steps for a SedUniformTimeCourse.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **numberOfSteps** (int) - The number of steps.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedUniformTimeCourse) - The modified SedUniformTimeCourse.

## setOdeSolver()
### Description
Sets the ordinary differential equation solver for a SedSimulation.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **odeSolver** (string) - The name of the ODE solver.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedSimulation) - The modified SedSimulation.

## setOutputEndTime()
### Description
Sets the output end time for a SedUniformTimeCourse.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **outputEndTime** (double) - The output end time.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedUniformTimeCourse) - The modified SedUniformTimeCourse.

## setOutputStartTime()
### Description
Sets the output start time for a SedUniformTimeCourse.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **outputStartTime** (double) - The output start time.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedUniformTimeCourse) - The modified SedUniformTimeCourse.

## setPreconditioner()
### Description
Sets the preconditioner for the CVODE solver.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **preconditioner** (string) - The preconditioner to use.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode) - The modified SolverCvode.

## setRelativeTolerance()
### Description
Sets the relative tolerance for the CVODE solver.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **relativeTolerance** (double) - The relative tolerance value.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode) - The modified SolverCvode.

## setSimulation()
### Description
Sets the simulation for a SedTask.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **simulation** (libOpenCOR::SedSimulation) - The simulation to set.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedTask) - The modified SedTask.

## setStep()
### Description
Sets the step size for SedOneStep or SolverOdeFixedStep.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **step** (double) - The step size.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedOneStep or libOpenCOR::SolverOdeFixedStep) - The modified solver.

## setUpperHalfBandwidth()
### Description
Sets the upper half bandwidth for CVODE or KINSOL solvers.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **upperHalfBandwidth** (int) - The upper half bandwidth.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverCvode or libOpenCOR::SolverKinsol) - The modified solver.

## setVariableName()
### Description
Sets the variable name for a SedChangeAttribute.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **variableName** (string) - The name of the variable.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedChangeAttribute) - The modified SedChangeAttribute.

## simulation()
### Description
Retrieves a simulation from a SedDocument or SedTask.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
- **index** (int) - The index of the simulation to retrieve.
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedSimulation) - The requested simulation.

## simulationCount()
### Description
Retrieves the number of simulations in a SedDocument.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (int) - The number of simulations.

## simulations()
### Description
Retrieves all simulations from a SedDocument.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (list of libOpenCOR::SedSimulation) - A list of all simulations.

## solve()
### Description
Solves the non-linear algebraic system.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SolverNla) - The result of the solve operation.

## state()
### Description
Retrieves the state information from a SedInstanceTask.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedInstanceTask) - The state information.

## stateCount()
### Description
Retrieves the count of states.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedInstanceTask) - The number of states.

## stateName()
### Description
Retrieves the name of the state.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedInstanceTask) - The name of the state.

## stateUnit()
### Description
Retrieves the unit of the state.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedInstanceTask) - The unit of the state.

## step()
### Description
Performs a single step for SedOneStep or SolverOdeFixedStep.
### Method
N/A (Function Call)
### Endpoint
N/A
### Parameters
None
### Request Example
N/A
### Response
#### Success Response
- **return value** (libOpenCOR::SedOneStep or libOpenCOR::SolverOdeFixedStep) - The result of the step operation.
```

--------------------------------

### instantiate()

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_sed_document.html

Creates an instance of the simulation experiment description.

```APIDOC
## instantiate()

### Description
Create an instance of this simulation experiment description.

### Returns
A smart pointer to a SedInstance object.
```

--------------------------------

### Functions starting with 'i'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'i'.

```APIDOC
## id()

### Description
Gets the unique identifier of the object.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **id** (string) - The unique identifier.

## initialTime()

### Description
Gets the initial time for the uniform time course simulation.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **time** (double) - The initial time.

## instance()

### Description
Gets the file instance managed by the file manager.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **file** (libOpenCOR::File) - The file instance.

## instantiate()

### Description
Instantiates the document, preparing it for simulation.

### Method
(Not specified, likely a mutator method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
None

## integrationMethod()

### Description
Gets the integration method used by the CVODE solver.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **method** (string) - The integration method.

## interpolateSolution()

### Description
Interpolates the solution at a given time point using the CVODE solver.

### Method
(Not specified, likely a computation method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **time** (double) - The time point at which to interpolate.

### Request Example
None

### Response
None (modifies internal state or returns interpolated values)

## issue()

### Description
Gets a specific issue from the logger.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **index** (integer) - The index of the issue to retrieve.

### Request Example
None

### Response
- **issue** (string) - The requested issue message.

## issueCount()

### Description
Gets the number of issues logged.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **count** (integer) - The number of issues.

## issues()

### Description
Gets all the logged issues.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **issues** (Array<string>) - An array of issue messages.

## iterationType()

### Description
Gets the iteration type used by the CVODE solver.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **type** (string) - The iteration type.

```

--------------------------------

### Functions starting with 'a'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'a'.

```APIDOC
## absoluteTolerance()

### Description
Gets the absolute tolerance for the solver.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **tolerance** (double) - The absolute tolerance value.

## addChange()

### Description
Adds a change to the model.

### Method
(Not specified, likely a mutator method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **change** (libOpenCOR::SedChangeAttribute) - The change to add.

### Request Example
None

### Response
None

## addModel()

### Description
Adds a model to the document.

### Method
(Not specified, likely a mutator method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **model** (libOpenCOR::SedModel) - The model to add.

### Request Example
None

### Response
None

## addSimulation()

### Description
Adds a simulation to the document.

### Method
(Not specified, likely a mutator method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **simulation** (libOpenCOR::SedSimulation) - The simulation to add.

### Request Example
None

### Response
None

## addTask()

### Description
Adds a task to the document.

### Method
(Not specified, likely a mutator method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **task** (libOpenCOR::SedTask) - The task to add.

### Request Example
None

### Response
None

## algebraic()

### Description
Gets the algebraic component of the task instance.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **algebraic** (string) - The name of the algebraic component.

## algebraicCount()

### Description
Gets the number of algebraic components in the task instance.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **count** (integer) - The number of algebraic components.

## algebraicName()

### Description
Gets the name of the specified algebraic component.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **index** (integer) - The index of the algebraic component.

### Request Example
None

### Response
- **name** (string) - The name of the algebraic component.

## algebraicUnit()

### Description
Gets the unit of the specified algebraic component.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **index** (integer) - The index of the algebraic component.

### Request Example
None

### Response
- **unit** (string) - The unit of the algebraic component.

```

--------------------------------

### Upper Half-Bandwidth Configuration

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_solver_cvode.html

Methods to get and set the upper half-bandwidth for the CVODE solver.

```APIDOC
## upperHalfBandwidth

### Description
Get the upper half-bandwidth used by the solver.

### Method
const

### Return Value
int

## setUpperHalfBandwidth

### Description
Set the upper half-bandwidth to be used by the solver.

### Method
void

### Parameters
- **pUpperHalfBandwidth** (int) - The upper half-bandwidth to set.
```

--------------------------------

### Functions starting with 'p'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'p'.

```APIDOC
## path()

### Description
Gets the path of the file.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **path** (string) - The path of the file.

## preconditioner()

### Description
Gets the preconditioner used by the CVODE solver.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **preconditioner** (string) - The name of the preconditioner.

```

--------------------------------

### Functions starting with 'n'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'n'.

```APIDOC
## name()

### Description
Gets the name of the solver.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **name** (string) - The name of the solver.

## newValue()

### Description
Gets the new value of a change attribute.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **value** (string) - The new value.

## nlaSolver()

### Description
Gets the nonlinear algebraic solver used in the simulation.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **solver** (string) - The name of the NLA solver.

## numberOfSteps()

### Description
Gets the number of steps for the uniform time course simulation.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **steps** (integer) - The number of steps.

```

--------------------------------

### setUpperHalfBandwidth()

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_solver_kinsol.html

Sets the upper half-bandwidth for the KINSOL solver.

```APIDOC
## setUpperHalfBandwidth()

### Description
Set the upper half-bandwidth to be used by the solver.

### Method
void

### Parameters
#### Path Parameters
- **pUpperHalfBandwidth** (int) - Required - The upper half-bandwidth to be used by the solver.
```

--------------------------------

### Get All Issues

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_sed_one_step.html

Retrieve a collection of all issues (errors and warnings) associated with the SedOneStep simulation.

```cpp
IssuePtrs issues() const;
```

--------------------------------

### Functions starting with 'm'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'm'.

```APIDOC
## manage()

### Description
Manages a file, likely adding it to the file manager.

### Method
(Not specified, likely a mutator method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **file** (libOpenCOR::File) - The file to manage.

### Request Example
None

### Response
None

## maximumNumberOfIterations()

### Description
Gets the maximum number of iterations for the KINSOL solver.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **maxIterations** (integer) - The maximum number of iterations.

## maximumNumberOfSteps()

### Description
Gets the maximum number of steps for the CVODE solver.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **maxSteps** (integer) - The maximum number of steps.

## maximumStep()

### Description
Gets the maximum step size for the CVODE solver.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **maxStep** (double) - The maximum step size.

## model()

### Description
Gets a specific model from the document or a model associated with a task.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **indexOrName** (integer or string) - The index or name of the model to retrieve.

### Request Example
None

### Response
- **model** (libOpenCOR::SedModel) - The requested model.

## modelCount()

### Description
Gets the number of models in the document.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **count** (integer) - The number of models.

## models()

### Description
Gets all the models in the document.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **models** (Array<libOpenCOR::SedModel>) - An array of all models.

```

--------------------------------

### Functions starting with 'l'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'l'.

```APIDOC
## linearSolver()

### Description
Gets the linear solver used by the CVODE or KINSOL solver.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **solver** (string) - The name of the linear solver.

## lowerHalfBandwidth()

### Description
Gets the lower half bandwidth for the CVODE or KINSOL solver.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **bandwidth** (integer) - The lower half bandwidth.

```

--------------------------------

### Functions starting with 'h'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'h'.

```APIDOC
## hasChanges()

### Description
Checks if the model has any changes.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **hasChanges** (boolean) - True if the model has changes, false otherwise.

## hasChildFiles()

### Description
Checks if the file has any child files.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **hasChildFiles** (boolean) - True if the file has child files, false otherwise.

## hasErrors()

### Description
Checks if the logger has any errors.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **hasErrors** (boolean) - True if there are errors, false otherwise.

## hasFiles()

### Description
Checks if the file manager is managing any files.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **hasFiles** (boolean) - True if the file manager has files, false otherwise.

## hasIssues()

### Description
Checks if the logger has any issues.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **hasIssues** (boolean) - True if there are issues, false otherwise.

## hasModels()

### Description
Checks if the document contains any models.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **hasModels** (boolean) - True if the document has models, false otherwise.

## hasSimulations()

### Description
Checks if the document contains any simulations.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **hasSimulations** (boolean) - True if the document has simulations, false otherwise.

## hasTasks()

### Description
Checks if the document or instance contains any tasks.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **hasTasks** (boolean) - True if there are tasks, false otherwise.

## hasWarnings()

### Description
Checks if the logger has any warnings.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **hasWarnings** (boolean) - True if there are warnings, false otherwise.

```

--------------------------------

### run()

Source: https://opencor.ws/libopencor/api/functions.html

Executes a simulation instance.

```APIDOC
## run()

### Description
Executes the simulation instance.

### Method
libOpenCOR::SedInstance.run()

### Returns
- None
```

--------------------------------

### Functions starting with 'f'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'f'.

```APIDOC
## file()

### Description
Gets a specific file managed by the file manager or a file within a model.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **indexOrName** (integer or string) - The index or name of the file to retrieve.

### Request Example
None

### Response
- **file** (libOpenCOR::File) - The requested file.

## fileCount()

### Description
Gets the number of files managed by the file manager.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **count** (integer) - The number of files.

## fileName()

### Description
Gets the name of the file.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **name** (string) - The name of the file.

## files()

### Description
Gets all the files managed by the file manager.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **files** (Array<libOpenCOR::File>) - An array of all managed files.

```

--------------------------------

### Lower Half-Bandwidth Configuration

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_solver_cvode.html

Methods to get and set the lower half-bandwidth for the CVODE solver.

```APIDOC
## lowerHalfBandwidth

### Description
Get the lower half-bandwidth used by the solver.

### Method
const

### Return Value
int

## setLowerHalfBandwidth

### Description
Set the lower half-bandwidth to be used by the solver.

### Method
void

### Parameters
- **pLowerHalfBandwidth** (int) - The lower half-bandwidth to set.
```

--------------------------------

### Functions starting with 'e'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'e'.

```APIDOC
## error()

### Description
Gets a specific error from the logger.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **index** (integer) - The index of the error to retrieve.

### Request Example
None

### Response
- **error** (string) - The requested error message.

## errorCount()

### Description
Gets the number of errors logged.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **count** (integer) - The number of errors.

## errors()

### Description
Gets all the logged errors.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **errors** (Array<string>) - An array of error messages.

```

--------------------------------

### Functions starting with 'd'

Source: https://opencor.ws/libopencor/api/functions_func.html

This section details functions that start with the letter 'd'.

```APIDOC
## description()

### Description
Gets the description of the issue.

### Method
(Not specified, likely a getter method)

### Endpoint
(Not applicable for SDK functions)

### Parameters
None

### Request Example
None

### Response
- **description** (string) - The description of the issue.

```

--------------------------------

### create()

Source: https://opencor.ws/libopencor/api/classlib_open_c_o_r_1_1_solver_second_order_runge_kutta-members.html

Creates a new instance of libOpenCOR::SolverSecondOrderRungeKutta. This is a static method.

```APIDOC
## create()

### Description
Creates a new instance of libOpenCOR::SolverSecondOrderRungeKutta.

### Method
static

### Endpoint
N/A (Static method)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **instance** (libOpenCOR::SolverSecondOrderRungeKutta) - A new instance of the solver.
```
Tokens:
Raw