Allows creation of a Reaction object whose the reaction rate can be decomposed in several kinetic factor (one factor by solute), but adds a constant factor to the calculation. More...

Inheritance diagram for simulator.reaction.ReactionFactorWithConstant:

Public Member Functions
void	init (Simulator aSim, XMLParser xmlRoot)
	Initialises the reaction by setting relevant parameters to values contained in the simulation protocol file. More...

void	initFromAgent (ActiveAgent anAgent, Simulator aSim, XMLParser aReactionRoot)
	Use the reaction class to fill the parameters fields of the agent. More...

int	getTotalParam ()
	Return the total number of parameters needed to describe the kinetic of this reaction (muMax included) More...

void	computeUptakeRate (double[] s, double mass, double tdel)
	Update the array of uptake rates and the array of its derivative. Based on default values of parameters. Unit is fg.h-1. More...

void	computeSpecificGrowthRate (ActiveAgent anAgent)
	Return the specific reaction rate for a given agent. More...

void	computeSpecificGrowthRate (double[] s)
	Compute specific growth rate in function of concentrations sent Parameters used are those defined for the reaction. More...

void	computeSpecificGrowthRate (double[] s, ActiveAgent anAgent)
	Compute specific growth rate in function to concentrations sent. More...

Matrix	calcdMUdS (Matrix S, double biomass)
	Calculate the rate of change of each uptake rate with respect to each solute. Returned as a matrix. More...

Matrix	calcdMUdT (Matrix S, double biomass)
	Calculate the rate of change of each uptake rate with respect to time. More...

double[]	computeMarginalDiffMu (double[] s)
	Compute the marginal difference array. More...

double	computeSpecRate (double[] s)
	Compute the specific growth rate. More...

void	updateMarginalMu (double[] s)
	Update the Marginal Mu data matrix. More...

double	computeMassGrowthRate (ActiveAgent anAgent)
	Compute the marginal growth rate (i.e the specific growth rate times the mass of the particle which is mediating this reaction) More...

double	computeSpecGrowthRate (ActiveAgent anAgent)
	Compute the specific growth rate. More...

Public Member Functions inherited from simulator.reaction.Reaction
void	init (Simulator aSim, XMLParser aReactionRoot)
	Initialises a reaction object, giving the object the properties stated in the protocol file. More...

void	initFromAgent (ActiveAgent anAgent, Simulator aSim, XMLParser xmlRoot)
	Use the reaction class to fill the parameters fields of the agent. Populate only the yield vector, the kinetic vector will be filled by the subdefined method in the child classes. More...

void	register (String aReactionName, Simulator aSimulator)
	End of the initialization procedure. Store the name and simulation dictionary index for this reaction. More...

LinkedList< String >	declareSolutes ()
	Utilised by a solver instance to know the solutes affected by this reaction. More...

void	fillParameters (Simulator aSim, XMLParser xmlRoot)
	Reads the reaction information (name, solute yield, particle yield etc) from the XML file and initialises this reaction. More...

void	addAgent (ActiveAgent anAgent)
	Register an agent among the guild of this pathway. More...

void	removeAgent (ActiveAgent anAgent)
	Remove an agent among the guild of this pathway. More...

void	applyReaction (SpatialGrid[] concGrid, SpatialGrid[] reacGrid, SpatialGrid[] diffReacGrid, SpatialGrid biomassGrid)
	Compute reaction rate on each concerned solute grids Assumes same parameters for all the agents of a same guild. More...

void	fitAgentMassOnGrid (SpatialGrid aSpG)
	Add the mass of all the agents of the guild on a received grid. The stored value is a CONCENTRATION. More...

double[]	readConcentrationSeen (ActiveAgent anAgent, SoluteGrid[] concGrid)
	Return a double array with all concentration seen by an agent on the default solute grid. More...

void	writeReport (ResultFile bufferState, ResultFile bufferSum) throws Exception
	Write reaction information to the result file stream. More...

void	fitGuildOnGrid ()
	Build a grid with mass and mass-growth-rate of all agents of the guild. More...

double[]	getSoluteYield ()
	Return the solute yield. More...

int[]	getSoluteIndex ()
	Return the solute index. More...

double[]	getParticulateYield ()
	Return the particulate yield. More...

double[]	getKinetic ()
	Return the kinetic parameters used in this reaction. More...

LinkedList< ActiveAgent >	getGuild ()
	Return the guild of this pathway. More...

Additional Inherited Members
Public Attributes inherited from simulator.reaction.Reaction
String	reactionName

int	reactionIndex

int	_catalystIndex

int[]	_mySoluteIndex

boolean	autocatalytic

double[]	totalUptake

double	Dil

Protected Attributes inherited from simulator.reaction.Reaction
LinkedList< ActiveAgent >	_guild = new LinkedList<ActiveAgent>()

SoluteGrid[]	_soluteList

SoluteGrid	_reacGrid

SoluteGrid	_guildGrid

double	_specRate

double[]	_diffUptakeRate

double[]	_uptakeRate

double[]	_soluteYield

double[]	_kineticParam

double[]	_particleYield

String[]	_particleNameYield

Detailed Description

Allows creation of a Reaction object whose the reaction rate can be decomposed in several kinetic factor (one factor by solute), but adds a constant factor to the calculation.

Allows creation of a Reaction object whose the reaction rate can be decomposed in several kinetic factor (one factor by solute), but adds a constant factor to the calculation

Author: Laurent Lardon (lardo.nosp@m.nl@s.nosp@m.upagr.nosp@m.o.in.nosp@m.ra.fr), INRA, France

Member Function Documentation

Matrix simulator.reaction.ReactionFactorWithConstant.calcdMUdS	(	Matrix	S,
		double	biomass
	)

virtual

Calculate the rate of change of each uptake rate with respect to each solute. Returned as a matrix.

Calculate the rate of change of each uptake rate with respect to each solute. Returned as a matrix

Parameters

S	Temporary container for solute concentration
biomass	Total particle mass in the system which catalyses this reaction

Returns: Matrix containing rate of change of each uptake rate with respect to each solute

Implements simulator.reaction.Reaction.

Matrix simulator.reaction.ReactionFactorWithConstant.calcdMUdT	(	Matrix	S,
		double	biomass
	)

virtual

Calculate the rate of change of each uptake rate with respect to time.

Calculate the rate of change of each uptake rate with respect to time. dMUdT = catalyticBiomass*specificGrowthRate*soluteYield. Returned as a matrix

Parameters

S	Temporary container for solute concentration
biomass	Total particle mass in the system which catalyses this reaction

Returns: Matrix containing rate of change of each uptake rate with respect to time

Implements simulator.reaction.Reaction.

double [] simulator.reaction.ReactionFactorWithConstant.computeMarginalDiffMu ( double[] s )

virtual

Compute the marginal difference array.

Compute the marginal difference array. Don't forget to update marginalMu before calling this!

Parameters

s	Temporary container for solute concentration

Returns: Marginal diff array

Implements simulator.reaction.Reaction.

double simulator.reaction.ReactionFactorWithConstant.computeMassGrowthRate ( ActiveAgent anAgent )

virtual

Compute the marginal growth rate (i.e the specific growth rate times the mass of the particle which is mediating this reaction)

Parameters

anAgent Specific growth rate for this ActiveAgent

Returns: The marginal growth rate

Implements simulator.reaction.Reaction.

double simulator.reaction.ReactionFactorWithConstant.computeSpecGrowthRate ( ActiveAgent anAgent )

virtual

Compute the specific growth rate.

Compute the specific growth rate

Parameters

anAgent Specific growth rate for this ActiveAgent

Returns: The specific growth rate

Implements simulator.reaction.Reaction.

void simulator.reaction.ReactionFactorWithConstant.computeSpecificGrowthRate ( ActiveAgent anAgent )

virtual

Return the specific reaction rate for a given agent.

Return the specific reaction rate for a given agent

Parameters

anAgent Agent to use to determine solute concentration and calculate reaction rate

See Also: ActiveAgent.grow(); Episome.computeRate(EpiBac)

Implements simulator.reaction.Reaction.

void simulator.reaction.ReactionFactorWithConstant.computeSpecificGrowthRate ( double[] s )

virtual

Compute specific growth rate in function of concentrations sent Parameters used are those defined for the reaction.

Parameters

s	Array of solute concentration

Implements simulator.reaction.Reaction.

void simulator.reaction.ReactionFactorWithConstant.computeSpecificGrowthRate	(	double[]	s,
		ActiveAgent	anAgent
	)

virtual

Compute specific growth rate in function to concentrations sent.

Compute specific growth rate in function to concentrations sent

Parameters

s	Array of solute concentration
anAgent	Parameters used are those defined for THIS agent

Implements simulator.reaction.Reaction.

double simulator.reaction.ReactionFactorWithConstant.computeSpecRate ( double[] s )

virtual

Compute the specific growth rate.

Compute the specific growth rate. Don't forget to update marginalMu before calling this!

Parameters

s	Temporary container for solute concentration

Returns: The specific growth rate

Implements simulator.reaction.Reaction.

void simulator.reaction.ReactionFactorWithConstant.computeUptakeRate	(	double[]	s,
		double	mass,
		double	tdel
	)

virtual

Update the array of uptake rates and the array of its derivative. Based on default values of parameters. Unit is fg.h-1.

Update the array of uptake rates and the array of its derivative. Based on default values of parameters. Unit is fg.h-1

Parameters

s	The concentration of solute locally observed
mass	Mass of the catalyst (cell...)
tdel	Time

Implements simulator.reaction.Reaction.

int simulator.reaction.ReactionFactorWithConstant.getTotalParam ( )

Return the total number of parameters needed to describe the kinetic of this reaction (muMax included)

Returns: Integer stating the total number of parameters needed to describe the kinetic

void simulator.reaction.ReactionFactorWithConstant.init	(	Simulator	aSim,
		XMLParser	xmlRoot
	)

Initialises the reaction by setting relevant parameters to values contained in the simulation protocol file.

Initialises the reaction by setting relevant parameters to values contained in the simulation protocol file

Parameters

aSim	The simulation object used to simulate the conditions specified in the protocol file
xmlRoot	The XML object containing the definition of one reaction in the protocol file

See Also: Simulator.createReaction()

void simulator.reaction.ReactionFactorWithConstant.initFromAgent	(	ActiveAgent	anAgent,
		Simulator	aSim,
		XMLParser	aReactionRoot
	)

Use the reaction class to fill the parameters fields of the agent.

Use the reaction class to fill the parameters fields of the agent. Uses information in the agent and protocol file to achieve this

Parameters

anAgent	The ActiveAgent which parameters are being populated
aSim	The simulation object used to simulate the conditions specified in the protocol file
aReactionRoot	The XML object containing the definition of one reaction in the protocol file

See Also: Simulator.createReaction()

void simulator.reaction.ReactionFactorWithConstant.updateMarginalMu ( double[] s )

virtual

Update the Marginal Mu data matrix.

Update the Marginal Mu data matrix

Parameters

s	Temporary container for solute concentration

Implements simulator.reaction.Reaction.

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

/home/kieran/Dropbox/workspace/iDynoMiCS/src/simulator/reaction/ReactionFactorWithConstant.java

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation