lm::reaction::ReactionQueue Class Reference

A queue that contains information on reaction events. More...

#include <ReactionQueue.h>

Collaboration diagram for lm::reaction::ReactionQueue:

Classes
struct	ReactionEvent
	Definition of a reaction event with the time to reaction and the propensity for the reaction to occur. More...

Public Member Functions
	ReactionQueue (uint numberReactions)
	Initialize the reaction queue.
	~ReactionQueue ()
	Destroy the reaction queue.
uint	getNextReaction ()
	get the next reaction
ReactionEvent	getReactionEvent (uint reactionIndex)
	Get the next reaction event.
void	updateReactionEvent (uint reactionIndex, double newTime, double newPropensity)
	Update the reaction event queue.

Protected Attributes
uint	numberReactions
ReactionEvent *	reactionEvents
uint *	reactionQueue
uint *	reactionPositions

Detailed Description

A queue that contains information on reaction events.

Constructor & Destructor Documentation

ReactionQueue()

lm::reaction::ReactionQueue::ReactionQueue ( uint numberReactions )

inline

Initialize the reaction queue.

Parameters

numberReactions

The number of reactions that the queue should be able to hold

~ReactionQueue()

lm::reaction::ReactionQueue::~ReactionQueue ( )

inline

Destroy the reaction queue.

Member Function Documentation

getNextReaction()

uint lm::reaction::ReactionQueue::getNextReaction ( )

inline

get the next reaction

Returns

reaction Number of the next reaction

getReactionEvent()

ReactionEvent lm::reaction::ReactionQueue::getReactionEvent ( uint reactionIndex )

inline

Get the next reaction event.

Parameters

reactionIndex

The index of the reaction event

reactionEvent The specified reaction event

updateReactionEvent()

void lm::reaction::ReactionQueue::updateReactionEvent ( uint reactionIndex, double newTime, double newPropensity )

inline

Update the reaction event queue.

Parameters

reactionIndex	Index of the reaction to update
newTime	The new time at which the reaction will occur
newPropensity	The new propensity for the reaction to occur

Member Data Documentation

numberReactions

uint lm::reaction::ReactionQueue::numberReactions

protected

reactionEvents

ReactionEvent* lm::reaction::ReactionQueue::reactionEvents

protected

reactionPositions

uint* lm::reaction::ReactionQueue::reactionPositions

protected

reactionQueue

uint* lm::reaction::ReactionQueue::reactionQueue

protected

---

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

• /data2/LM_zls_github/Lattice-Microbes/src/reaction/ReactionQueue.h