getVars

Query values of state variables of a <code>rodeo</code>-based model.

Provides an R6 class and several utility methods to
facilitate the implementation of models based on ordinary
differential equations. The heart of the package is a code generator
that creates compiled 'Fortran' (or 'R') code which can be passed to
a numerical solver. There is direct support for solvers contained
in packages 'deSolve' and 'rootSolve'.

David Kneis

rodeo

A Code Generator for ODE-Based Models

getVars function

<dl><dt>asArray</dt>
<dd>Logical. If <code>FALSE</code>, the values of variables are returned
as vector irrespective of the model's spatial resolution. If <code>TRUE</code>,
the values are returned as an <code><a href="/link/array?package=rodeo&version=0.8.2" data-mini-rdoc="rodeo::array">array</a></code> with properly named
dimensions. The array's last dimension represents the variables and its
first (fastest cycling) dimension, if any, refers to the model's highest
spatial dimension.</dd>
<dt>useNames</dt>
<dd>Logical. Used to enable/disable element names for the return
vector when <code>asArray</code> is <code>FALSE</code>. The names follow the pattern
'x.i.j' where 'x' is the variable name and 'i', 'j' are indices of the
sub-units in the first and second spatial dimension. The actual suffix is
controlled by the number of dimensions and in the 0-dimensional case, no
suffix is applied at all, i.e. the pure variable names are used to label the
elements of the vector.
If <code>isArray</code> is <code>TRUE</code>, this argument is simply ignored, hence
the dimensions of a returned array are always named.</dd></dl>

Arguments

<a href="/link/david.kneis%40tu-dresden.de?package=rodeo&version=0.8.2" data-mini-rdoc="rodeo::david.kneis@tu-dresden.de">david.kneis@tu-dresden.de</a>

Author

Query Values of State Variables — getVars

<dl>

<dt>asArray</dt>
<dd>Logical. If <code>FALSE</code>, the values of variables are returned
as vector irrespective of the model's spatial resolution. If <code>TRUE</code>,
the values are returned as an <code><a href='https://rdrr.io/r/base/array.html'>array</a></code> with properly named
dimensions. The array's last dimension represents the variables and its
first (fastest cycling) dimension, if any, refers to the model's highest
spatial dimension.</dd>


<dt>useNames</dt>
<dd>Logical. Used to enable/disable element names for the return
vector when <code>asArray</code> is <code>FALSE</code>. The names follow the pattern
'x.i.j' where 'x' is the variable name and 'i', 'j' are indices of the
sub-units in the first and second spatial dimension. The actual suffix is
controlled by the number of dimensions and in the 0-dimensional case, no
suffix is applied at all, i.e. the pure variable names are used to label the
elements of the vector.
If <code>isArray</code> is <code>TRUE</code>, this argument is simply ignored, hence
the dimensions of a returned array are always named.</dd>

</dl>

<a href='mailto:david.kneis@tu-dresden.de'>david.kneis@tu-dresden.de</a>

getVars: Query Values of State Variables

Description

Value

Arguments

Author

See Also