bio.singa.simulation.model.modules.concentration.imlementations

Class NthOrderReaction

java.lang.Object

bio.singa.simulation.model.modules.concentration.ConcentrationBasedModule<SectionDeltaFunction>

bio.singa.simulation.model.modules.concentration.imlementations.Reaction

bio.singa.simulation.model.modules.concentration.imlementations.NthOrderReaction

All Implemented Interfaces:

UpdateModule

public class NthOrderReaction
extends Reaction

Author:

cl

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NthOrderReaction.Builder

Field Summary

Fields inherited from class bio.singa.simulation.model.modules.concentration.imlementations.Reaction

stoichiometricReactants

Fields inherited from class bio.singa.simulation.model.modules.concentration.ConcentrationBasedModule

supplier

Constructor Summary

Constructors

Constructor and Description
NthOrderReaction()

Method Summary

Modifier and Type	Method and Description
double	calculateVelocity(ConcentrationContainer concentrationContainer) Calculates the reaction velocity, depending on the kinetic law.
void	checkFeatures()
void	initialize()
static NthOrderReaction.Builder	inSimulation(Simulation simulation)

Methods inherited from class bio.singa.simulation.model.modules.concentration.imlementations.Reaction

addStochiometricReactant, calculateDeltas, collectProductsString, collectSubstrateString, determineEffectiveConcentration, getProducts, getReactionString, getStoichiometricReactants, getStringForProtocol, getSubstrates, isElementary, setElementary, setStoichiometricReactants, substratesAvailable, toString

Methods inherited from class bio.singa.simulation.model.modules.concentration.ConcentrationBasedModule

addDeltaFunction, addModuleToSimulation, addReferencedEntities, addReferencedEntity, calculateUpdates, deltaIsValid, determineLargestLocalError, getApplicationCondition, getDeltaCutoff, getErrorCutoff, getFeature, getFeatures, getIdentifier, getReferencedEntities, getRequiredFeatures, getScaledFeature, getScaledFeature, getScope, getSimulation, getSpecificity, getState, getSupplier, handleDelta, listFeatures, optimizeTimeStep, resetState, scaleScalableFeatures, setApplicationCondition, setDeltaCutoff, setErrorCutoff, setFeature, setIdentifier, setSimulation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NthOrderReaction

public NthOrderReaction()

Method Detail

inSimulation

public static NthOrderReaction.Builder inSimulation(Simulation simulation)

initialize

public void initialize()

Specified by:

initialize in class Reaction

calculateVelocity

public double calculateVelocity(ConcentrationContainer concentrationContainer)

Description copied from class: Reaction

Calculates the reaction velocity, depending on the kinetic law.

Specified by:

calculateVelocity in class Reaction

Parameters:

concentrationContainer - The concentration container to calculate the deltas for.

Returns:

The reaction velocity.

checkFeatures

public void checkFeatures()

Specified by:

checkFeatures in interface UpdateModule

Overrides:

checkFeatures in class ConcentrationBasedModule<SectionDeltaFunction>