Lattice Microbes 2.5
This is for whole cell modeling
Loading...
Searching...
No Matches
pySTDLM.CellArranger.RandomArranger Class Reference
Inheritance diagram for pySTDLM.CellArranger.RandomArranger:
[legend]
Collaboration diagram for pySTDLM.CellArranger.RandomArranger:
[legend]

Public Member Functions

 __init__ (self, cellType, cellAttributes, arrangerAttributes)
 newBBox (self, bbox, padding)
 doesIntersect (self, b1, b2)
 outsideDomain (self, b1, mins, maxs)
 intPackVolume (self, sim, mins, maxs)
Public Member Functions inherited from pySTDLM.CellArranger.CellArranger
 __init__ (self, cellType=None, cellAttributes=None, arrangerAttributes=None, name='Unknown')
 cellFactory (self)
 packVolume (self, sim, volume=None)
 addToSimulation (self, sim)
 Add packed volume to RDME simulation.

Additional Inherited Members

Public Attributes inherited from pySTDLM.CellArranger.CellArranger
list allowedCellTypes = ["Sphere", "Capsule", "Box", "CapsuleShell"]
list allowedForms = ["Random", "RandomSpherical", "TightGrid", "LooseGrid", "SkewedGrid"]
str cellType = cellType
 cellAttributes = cellAttributes
list cells = []
 packerName = name
 arrangerAttributes = arrangerAttributes

Detailed Description

An arranger that randomly orients a number of cells in a regin until either a count or a volume fraction target is met.

This class requires either "fraction" or "number" attributes specified in the arrangerAttributes.  It also has an optional
parameter "padding" which maintains that much padding between the cells and their neighbors.

Constructor & Destructor Documentation

◆ __init__()

pySTDLM.CellArranger.RandomArranger.__init__ ( self,
cellType,
cellAttributes,
arrangerAttributes )

Member Function Documentation

◆ doesIntersect()

pySTDLM.CellArranger.RandomArranger.doesIntersect ( self,
b1,
b2 )

◆ intPackVolume()

pySTDLM.CellArranger.RandomArranger.intPackVolume ( self,
sim,
mins,
maxs )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ newBBox()

pySTDLM.CellArranger.RandomArranger.newBBox ( self,
bbox,
padding )

◆ outsideDomain()

pySTDLM.CellArranger.RandomArranger.outsideDomain ( self,
b1,
mins,
maxs )

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