solver: Calls ODE solver for a particular model

solverR Documentation

Calls ODE solver for a particular model

Description

Please refer to the Modeling Howto vignette on how to implement custom models by overloading the solver function.

Usage

solver(scenario, ...)

## S4 method for signature 'ANY'
solver(scenario, ...)

## S4 method for signature 'LemnaSetac'
solver(scenario, ...)

## S4 method for signature 'Magma'
solver(scenario, ...)

## S4 method for signature 'LemnaSchmitt'
solver(scenario, ...)

## S4 method for signature 'AlgaeWeber'
solver(scenario, method = "lsoda", hmax = 0.1, nout = 1, ...)

## S4 method for signature 'AlgaeTKTD'
solver(scenario, method = "lsoda", hmax = 0.1, ...)

## S4 method for signature 'AlgaeSimple'
solver(scenario, method = "lsoda", hmax = 0.1, ...)

## S4 method for signature 'DebAbj'
solver(scenario, ...)

## S4 method for signature 'DebTox'
solver(scenario, method = "ode45", ...)

## S4 method for signature 'DebDaphnia'
solver(scenario, ...)

## S4 method for signature 'GutsSd'
solver(scenario, ...)

## S4 method for signature 'GutsIt'
solver(scenario, ...)

## S4 method for signature 'GutsRedSd'
solver(scenario, ...)

## S4 method for signature 'GutsRedIt'
solver(scenario, ...)

Arguments

scenario

scenario object

...

additional parameters passed on to deSolve::ode()

method

string, selects the numerical solver used by deSolve::ode()

hmax

numeric, sets the maximum step length in time, see deSolve::ode()

nout

numeric, the number of additional output variables returned by the model, see vignette("compiledCode", "deSolve") for details. If and which output variables are available depends on the scenario type, please refer to the documentation of the model in question.

Details

Some solvers may set reasonable default values for e.g. maximum step length in time (hmax), but not all do. Please check the model documentation for details.

Value

data.frame with simulation results

Methods (by class)

  • solver(ANY): Default solver, raises an error

  • solver(LemnaSetac): Numerically integrates Lemna_SETAC scenarios

  • solver(Magma): Numerically integrates Magma scenarios

  • solver(LemnaSchmitt): Numerically integrates Lemna_Schmitt scenarios

  • solver(AlgaeWeber): numerically integrates Algae_Weber scenarios

  • solver(AlgaeTKTD): numerically integrates Algae_TKTD scenarios

  • solver(AlgaeSimple): numerically integrates Algae_Simple scenarios

  • solver(DebAbj): Numerically integrates DEB_abj scenarios

  • solver(DebTox): Numerically integrates DEBtox scenarios

  • solver(DebDaphnia): (deprecated) Numerically integrates DEBtox_Daphnia scenarios

  • solver(GutsSd): Numerically integrates GUTS-SD scenarios

  • solver(GutsIt): Numerically integrates GUTS-IT scenarios

  • solver(GutsRedSd): Numerically integrates GUTS-RED-SD scenarios

  • solver(GutsRedIt): Numerically integrates GUTS-RED-IT scenarios


cvasi documentation built on Sept. 11, 2025, 5:11 p.m.