OdeControl R6 Class

R6 wrapper for ODE solver control settings

Public fields

ptr

External pointer to the underlying C++ OdeControl object.

Methods

Public methods

• OdeControl$new()

• OdeControl$get_controls()

• OdeControl$set_controls()

• OdeControl$set_tol_abs()

• OdeControl$set_tol_rel()

• OdeControl$set_a_y()

• OdeControl$set_a_dydt()

• OdeControl$set_step_size_min()

• OdeControl$set_step_size_max()

• OdeControl$set_step_size_initial()

• OdeControl$clone()

---

Method new()

Initialize an `OdeControl` instance.

Usage

OdeControl$new()

---

Method get_controls()

Get current solver control settings.

Usage

OdeControl$get_controls()

---

Method set_controls()

Set all solver control settings at once.

Usage

OdeControl$set_controls(
  tol_abs,
  tol_rel,
  a_y,
  a_dydt,
  step_size_min,
  step_size_max,
  step_size_initial
)

Arguments

tol_abs

Absolute tolerance.

tol_rel

Relative tolerance.

a_y

State scaling coefficient.

a_dydt

Derivative scaling coefficient.

step_size_min

Minimum allowed step size.

step_size_max

Maximum allowed step size.

step_size_initial

Initial step size.

---

Method set_tol_abs()

Set absolute tolerance.

Usage

OdeControl$set_tol_abs(tol_abs)

Arguments

tol_abs

Absolute tolerance.

---

Method set_tol_rel()

Set relative tolerance.

Usage

OdeControl$set_tol_rel(tol_rel)

Arguments

tol_rel

Relative tolerance.

---

Method set_a_y()

Set state scaling coefficient.

Usage

OdeControl$set_a_y(a_y)

Arguments

a_y

State scaling coefficient.

---

Method set_a_dydt()

Set derivative scaling coefficient.

Usage

OdeControl$set_a_dydt(a_dydt)

Arguments

a_dydt

Derivative scaling coefficient.

---

Method set_step_size_min()

Set minimum step size.

Usage

OdeControl$set_step_size_min(step_size_min)

Arguments

step_size_min

Minimum allowed step size.

---

Method set_step_size_max()

Set maximum step size.

Usage

OdeControl$set_step_size_max(step_size_max)

Arguments

step_size_max

Maximum allowed step size.

---

Method set_step_size_initial()

Set initial step size.

Usage

OdeControl$set_step_size_initial(step_size_initial)

Arguments

step_size_initial

Initial step size.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

OdeControl$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.