Substance-constructor {BacArena}R Documentation

Constructor of the S4 class Substance

Description

The constructor to get a new object of class Substance

Usage

Substance(
  n,
  m,
  smax,
  gridgeometry,
  difspeed = 0.02412,
  advspeed = 0,
  occupyM,
  Dgrid = NULL,
  Vgrid = NULL,
  diffmat = NULL,
  template = FALSE,
  ...
)

Arguments

n

A number giving the horizontal size of the environment.

m

A number giving the vertical size of the environment.

smax

A number representing the start concentration of the substance for each grid cell in the environment.

gridgeometry

A list containing grid geometry parameter

difspeed

A number indicating the diffusion speed in x and y direction (given by cm^2/h). For more complex setup define Dgrid.

advspeed

A number indicating the advection speed in x direction (given by cm/h). For more complex setup define Vgrid.

occupyM

A matrix indicating grid cells that are obstacles

Dgrid

A matrix indicating the diffusion speed in x and y direction (given by cm^2/h).

Vgrid

A number indicating the advection speed in x direction (given by cm/h).

diffmat

A matrix with spatial distributed initial concentrations (unit in fmol) (if not set, a homogenous matrix using smax is created)

template

True if diffmat matrix should be used as tempalte only (will be multiplied with smax to obtain cocentrations)

...

Arguments of Substance-class

Value

Object of class Substance


[Package BacArena version 1.8.2 Index]