Substance-constructor: Constructor of the S4 class 'Substance'

Description Usage Arguments Value

Description

The constructor to get a new object of class Substance

Usage

1
2
3
Substance(n, m, smax, gridgeometry, difspeed = 6.7e-06, 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/s). For more complex setup define Dgrid.

advspeed

A number indicating the advection speed in x direction (given by cm/s). 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/s).

Vgrid

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

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


BacArena documentation built on May 29, 2017, 6:06 p.m.

Search within the BacArena package
Search all R packages, documentation and source code