Lattice Microbes 2.5
This is for whole cell modeling
Loading...
Searching...
No Matches
lm::builder::LatticeBuilder::ParticlePlacement Struct Reference

A representation of a placement operation that needs to occur (i.e. where to place (siteType), what to place (particleType) and how many (count)) More...

#include <LatticeBuilder.h>

Public Member Functions

 ParticlePlacement (particle_t particleType, site_t siteType, uint count)
 Create a ParticlePlacement placement operation.

Public Attributes

particle_t particleType
site_t siteType
uint count

Detailed Description

A representation of a placement operation that needs to occur (i.e. where to place (siteType), what to place (particleType) and how many (count))

Constructor & Destructor Documentation

◆ ParticlePlacement()

lm::builder::LatticeBuilder::ParticlePlacement::ParticlePlacement ( particle_t particleType,
site_t siteType,
uint count )
inline

Create a ParticlePlacement placement operation.

Parameters
particleTypeThe type of particle to place
siteTypeThe type of site in which to place the particles
countThe number of particles to place in that site type

Member Data Documentation

◆ count

uint lm::builder::LatticeBuilder::ParticlePlacement::count

◆ particleType

particle_t lm::builder::LatticeBuilder::ParticlePlacement::particleType

◆ siteType

site_t lm::builder::LatticeBuilder::ParticlePlacement::siteType

The documentation for this struct was generated from the following file: