Struct Model 

pub struct Model {
    pub species: Vec<Species>,
    pub exchange: Vec<Exchange>,
    pub chemotaxis: Vec<Vec<f64>>,
    pub width: usize,
    pub height: usize,
    pub depth: usize,
    pub contact: Vec<f64>,
    pub types: Vec<CellType>,
    pub temperature: f64,
    pub neighbour_order: u8,
    pub seed: u64,
}

The whole model: what a Blueprint would state, in one struct.

Fields

species: Vec<Species>

Diffusing species, in the order a description lists them.

exchange: Vec<Exchange>

Secretion and uptake per cell type, index 0 the medium.

chemotaxis: Vec<Vec<f64>>

Chemotactic sensitivity per cell type and species, index 0 the medium. Positive climbs a gradient.

width: usize

Lattice width in sites.

height: usize

Lattice height in sites.

depth: usize

Lattice depth in sites. One is a plane, and every neighbourhood then drops its out-of-plane offsets.

contact: Vec<f64>

Contact energies, row-major over (type_a, type_b), symmetric.

types: Vec<CellType>

One entry per type, index 0 the medium.

temperature: f64

Metropolis fluctuation amplitude, the Potts temperature.

neighbour_order: u8

1 for the four von Neumann neighbours, 2 for the eight Moore ones.

seed: u64

Random seed.

Implementations

impl Model

pub fn n_types(&self) -> usize

Number of cell types, counting the medium.

pub fn dimensions(&self) -> usize

How many dimensions the lattice spans.

pub fn has_motility(&self) -> bool

Whether any type keeps a memory of where it has been.

pub fn has_external_potential(&self) -> bool

Whether any type drifts.

pub fn has_connectivity(&self) -> bool

Whether any type refuses a copy that would pinch it.

pub fn has_length_constraint(&self) -> bool

Whether any type constrains its length, so a run without one skips the moment bookkeeping.

pub fn has_chemotaxis(&self) -> bool

Whether any type follows a gradient.

pub fn has_population_events(&self) -> bool

Whether any type divides or dies, so a run without either skips the per-step scan over labels.

pub fn contact_energy(&self, a: u8, b: u8) -> f64

Contact energy between two types.

pub fn validate(&self) -> Result<(), String>

Check the shapes agree before a run starts.

Errors

A message naming the first inconsistency found.

Trait Implementations

impl Clone for Model

fn clone(&self) -> Model

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Model

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Model

fn default() -> Model

A one-site medium-only lattice at a temperature that runs. It exists so a caller states the terms it cares about and leaves the rest, which is what keeps a new energy term from touching every call site.