bbm_sim_class: The 'bbm_sim' class.

In rorynolan/brownded: Simulate bounded Brownian motion

Description

An object of class bbm_sim is a tibble with d + 2 columns, where d is the number of dimensions in the space of the simulation. One column for time, one for the particle ID number and the other d for the positions of the particles in d-dimensional space.

• Column 1 has name t and is of type <dbl>.

• Column 2 has name id and is of type <int>.

• The rest of the columns are named x1, x2, x3 and so on and are of type <dbl>.

There are three necessary attributes sim_D, sim_dim and bleach_rate which tell you the diffusivity constant, the dimensions of the space used during the simulation and the bleaching rate (see bbm_bleach_simulation()).

Usage

bbm_sim_class(tbl, sim_D, sim_dim, bleach_rate = 0)

Arguments

tbl	An appropriate tibble.
sim_D	The diffusivity constant used during the simulation which created tbl.
sim_dim	The dimensions of the space used during the simulation which created tbl.
bleach_rate	The bleaching rate (see bbm_bleach_simulation()).

Value

An object of class bbm_sim.

Examples

tbl <- tibble::tibble(t = 0, id = 1L, x1 = 0.5)
str(bbm_sim_class(tbl, sim_D = 1, sim_dim = 99.9))

rorynolan/brownded documentation built on May 5, 2019, 9:20 a.m.