Class MembraneDiffusion
- java.lang.Object
-
- bio.singa.simulation.model.modules.AbstractUpdateModule
-
- bio.singa.simulation.model.modules.concentration.ConcentrationBasedModule<UpdatableDeltaFunction>
-
- bio.singa.simulation.model.modules.concentration.imlementations.transport.MembraneDiffusion
-
- All Implemented Interfaces:
UpdateModule,Runnable
public class MembraneDiffusion extends ConcentrationBasedModule<UpdatableDeltaFunction>
The membrane diffusion module describes the movement of chemical entities acrossMembranes driven by theMembranePermeabilityof the cargo. The cargo molecules are crossing a membrane from one side to the other side. The flux of concentration is determined by terms ofJM = Pd * A * (c1 - c2)
where Pd is theMembranePermeability, A is the area of the membrane, and c1 and c2 are the concentrations on both sides of the membrane; as in:Stein, Wilfred. Transport and diffusion across cell membranes. Elsevier, 2012.
This concentration based module appliesSemiDependentUpdates and isUpdatableSpecific.// define the feature to parametrize the diffusion MembranePermeability membranePermeability = new MembranePermeability(Quantities.getValue(3.5E-03, CENTIMETRE_PER_SECOND), Evidence.MANUALLY_ANNOTATED); // assign it to the chemical entity SmallMolecule water = new SmallMolecule.Builder("water") .assignFeature(membranePermeability) .build(); // create the module MembraneDiffusion.inSimulation(simulation) .cargo(water) .build();- Author:
- cl
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceMembraneDiffusion.BuildStepstatic interfaceMembraneDiffusion.CargoStepstatic classMembraneDiffusion.MembraneDiffusionBuilder
-
Field Summary
-
Fields inherited from class bio.singa.simulation.model.modules.concentration.ConcentrationBasedModule
supplier
-
-
Constructor Summary
Constructors Constructor Description MembraneDiffusion()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ModuleBuildergetBuilder(Simulation simulation)static MembraneDiffusion.CargoStepinSimulation(Simulation simulation)StringtoString()-
Methods inherited from class bio.singa.simulation.model.modules.concentration.ConcentrationBasedModule
addDeltaFunction, calculateUpdates, deltaIsValid, determineLargestLocalError, getApplicationCondition, getRestrictedSubsection, getScaledFeature, getScaledFeature, getScope, getSpecificity, getSupplier, handleDelta, inBetweenHalfSteps, initialize, onCompletion, onReset, optimizeTimeStep, restrictApplication, setApplicationCondition, setRestrictedSubsection
-
Methods inherited from class bio.singa.simulation.model.modules.AbstractUpdateModule
addEvidence, addReferencedEntities, addReferencedEntity, checkFeatures, equals, getEvidence, getFeature, getFeatureManager, getFeatures, getIdentifier, getReferencedChemicalEntities, getRequiredFeatures, getSimulation, getState, hashCode, reset, run, setEvidence, setFeature, setFeatureManager, setIdentifier, setSimulation, setState
-
-
-
-
Method Detail
-
inSimulation
public static MembraneDiffusion.CargoStep inSimulation(Simulation simulation)
-
getBuilder
public static ModuleBuilder getBuilder(Simulation simulation)
-
toString
public String toString()
- Overrides:
toStringin classAbstractUpdateModule
-
-