Expand description
This crate encapsulates concepts which govern an agent-based model specified by cellular_raza. To learn more about the math and philosophy behind these concepts please refer to cellular-raza.com.
Modules§
- Traits and types which will eventually replace the old Domain definition.
- Contains traits and types which specify cellular reactions specific to the [cpu_os_threads] backend.
Structs§
- Can occur during boundary calculation
- General Calculation Error
- A container struct containing meta-information of a given Cell Some variables such as id are not required and not desired to be initialized by the user. This CellAgentBox acts as a container around the cell to hold these variables.
- Error which occurs during sending, receiving or transmitting information between threads
- Occurs when incorrectly applying a controller effect
- Errors occurring during the final death step of a cell
- Generated by the decompose method. The backend will know how to deal with this type and crate a working simulation from it.
- Errors related to a cell dividing process
- Used to catch errors related to plotting
- Can occur internally when information is not present at expected place
- Ask the wrong object for information and receive this error
- Can occur when generating distributions or drawing samples from them.
- Occurs during setup of a new simulation
- Error related to advancing the simulation time or displaying its progress
Enums§
- Contains all events which can arise during the cell cycle and need to be communciated to the simulation engine (see also Cycle).
- Error during decomposition of a SimulationDomain into multiple subdomains
Traits§
- Creates a new plotting root which can then be drawn upon.
- This trait represents all cycles of a cell and works in tandem with the CycleEvent enum.
- Provides an abstraction of the physical total simulation domain.
- Generate SubDomains from an existing Domain
- Manage the current rng seed of a Domain
- Specifies how to retrieve a unique identifier of an object.
- Trait describing force-interactions between cellular agents.
- Setter and Getter for intracellular values of a cellagent.
- Describes the position of a cell-agent and allows to calculate increments and set/get information of the agent.
- Allows elements of the simulation such as cells and voxels to draw themselves onto a plotting root. Typically, voxels will draw first and cells afterwards.
- Methods for accessing the position of an agent.
- Describes purely intracellular reactions of a cellagent.
- TODO add description
- TODO add description
- Assign an VoxelIndex to a given cell.
- Subdomains are produced by decomposing a Domain into multiple physical regions.
- Apply a force on a cell depending on its position and velocity.
- Apply boundary conditions to a cells position and velocity.
- Describes extracellular reactions and fluid dynamics
- Methods for accessing the velocity of an agent
- Mathematical abstraction similar to the well-known
axpy
method.
Type Aliases§
- This is a unique identifier which is deterministic even in multi-threading situations. Its components are
Derive Macros§
- Derive cellular concepts
- This trait derives the different aspects of a SubDomain.