Version 1.2 (June 2013)
 All Classes Namespaces Files Functions Variables Pages
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12345678]
oCsimulator.AgentContainerClass to store all the agents, call them, and manage shoving/erosion of located agents
oCsimulator.geometry.boundaryConditions.AllBCGroup all methods expected by the interface but common to most of the boundary classes
|oCsimulator.geometry.boundaryConditions.BoundaryBulkDefines the bulk boundary: the concentration on the boundary is fixed by a dynamical bulk, the agents crossing this line die
|oCsimulator.geometry.boundaryConditions.BoundaryConstantBoundaryConstant : the concentration on the boundary is fixed by a constant bulk, the agents crossing this line die
|oCsimulator.geometry.boundaryConditions.BoundaryCyclicBoundaryCyclic : close the system along a dimension
|oCsimulator.geometry.boundaryConditions.BoundaryGasMembraneBoundaryMembrane : defines a boundary impermeable to everything except to gas
|\Csimulator.geometry.boundaryConditions.BoundaryZeroFluxDefines an impermeable boundary to solutes and agents
oCsimulator.geometry.BulkDefine the bulk: an object used to define the environment connected to the simulated system
|\Csimulator.geometry.FluctEnv
oCsoft_update.Check_Release_StatusChecks if a new release of iDynomics is available
oCCloneable
|oCsimulator.agent.AgentMajor class of iDynoMiCS - defines the agents that are involved in an iDynoMiCS simulation. Extended by a number of agent types
|oCsimulator.agent.LocatedAgentExtends ActiveAgent by adding functionality to control agent grid location, agent shoving, agent death and division, and agent movement
|oCsimulator.agent.SpecialisedAgentExtension of Agent class, adds location and parameter information for an object of a particular species in the simulation
|oCsimulator.agent.zoo.BacteriumCreates an object of the Bacterium Species. Acts as a superclass for all current species with the exception of ParticulateEPS
|oCsimulator.geometry.ContinuousVectorImplements 3D vector of continuous spatial coordinates. Can be used to store Continuous coordinates or Movement vectors
|\Csimulator.geometry.DiscreteVectorImplements 3D vector of discrete spatial coordinates
oCutils.ComplexClass for storing complex numbers as two doubles representing real and imaginary part, respectively
oCutils.ComplexArrayClass for storing an 1- to 3-dimensional array of complex numbers as an 1D array of alternating real and imaginary parts in double precision
oCsimulator.detachment.ConnectedVolumeImplements connected volume filtration operation. Provides a base class for geometry specific connected volume filtrators
oCsimulator.diffusionSolver.DiffusionSolverAn abstract class used as a parent for all diffusion solvers that could be defined
|oCsimulator.diffusionSolver.Solver_chemostat
|oCsimulator.diffusionSolver.Solver_multigrid
|\Csimulator.diffusionSolver.Solver_pressureInitialises and calculates pressure affect on the simulation domain
oCutils.ExtraMathAbstract class with some extra useful math functions
oCutils.FftOperationsTool for performing fast fourier transform (FFT) on grids of Complex and real numbers
oCFilenameFilter
|\Cutils.JfilterUsed in simulation initialisation to ensure onky XML files are read as protocol files and previous results files are excluded
oCsimulator.geometry.GridElementFloatImplements a reference to a grid element
oCutils.GridOperationsCollection of static methods to deal with spatial grids that are used in the MicroCoSm model
oCsimulator.agent.HasReactionInterface of methods that should be implemented for agent classes that are involved in solute reactions
|\Csimulator.agent.ActiveAgentExtension of Agent and SpecialisedAgent - adds reaction information to model agent involvement in reactions
oCsimulator.agent.HasSpeciesInterface for species classes, stating the methods that these classes should include
|oCsimulator.agent.InfoAgentAbstract class used for declaring Episome and MultiEpisome objects
|\Csimulator.agent.SpecialisedAgentExtension of Agent class, adds location and parameter information for an object of a particular species in the simulation
oCidyno.IdynomicsMain class to run to launch the iDynoMiCS tool
oCutils.InitialisationErrorLogCreates and updates a simulation initialisation error log file for the initialising simulation
oCsimulator.geometry.boundaryConditions.IsBCInterface for the boundary conditions on the system's margins. To be used in solvers and agent move
oCsimulator.geometry.IsComputationDomainInterface describing mandatory methods for a computation domain object. The default class is "ComputationDomain" but other can be defined
|\Csimulator.geometry.DomainDefine the computation domain: an evenly spaced rectilinear grid described by its dimensionality (2D or 3D)
oCsimulator.geometry.shape.IsShapeInterface class used by boundary condition classes. Defines the methods used to monitor the boundaries of the computation domain
|\Csimulator.geometry.shape.PlanarCreate a planar shaped boundary
oCsimulator.detachment.LevelSetSolver used for modelling detachment
|oCsimulator.detachment.DS_BiomassBiomass detachment method. Function: kDet*L^2/X, where L is the local biomass thickness and X the local biomass concentration
|oCsimulator.detachment.DS_ProportionalProportional detachment method. Function: kDet*L, where L is the local biomass thickness
|oCsimulator.detachment.DS_QuadraticQuadratic detachment method. Function: kDet*L^2, where L is the local biomass thickness
|\Csimulator.detachment.DS_SolGradSolGrad detachment method. Loop through solutes to find the maximum gradient and use this as a multiplier to calculate detachment rate
oCsimulator.agent.LocatedGroupObject to hold a group of agents in one location on the agent grid
oCutils.LogFileCreates and updates a log file for the running simulation
oCutils.MatrixOperationsImplements static utility functions for used in multigrid method
oCsimulator.diffusionSolver.multigrid.MultigridSoluteImplements static utility functions for used in multigrid method
oCsimulator.diffusionSolver.multigrid.MultigridUtils
oCutils.ResultFileClass used to create auto-zipping result files. At each iteration, the file is added to an archive
oCRuntimeException
|\Cexceptions.ModelRuntimeExceptionCreates the runtime exceptions that are generated by iDynoMiCS when an error is encountered
oCidyno.SimTimerClass to create and keep track of the timestep and simulation time course
oCsimulator.SimulatorTop-level class of the simulation core. Used to create and run a simulation
oCsimulator.diffusionSolver.multigrid.SinglegridPressure
oCsimulator.agent.SpeciesParamClass used to store and set parameters specific for a species. Can be extended to add additional parameters
|\Csimulator.agent.ActiveParamExtends SpeciesParam, adding parameters used to simulate an agents involvement in a reaction
oCtest.TestUtils
oCutils.UnitConverterStatic class used to convert units (mass, length, time)
oCutils.VectorizedArrayCreates a 2D or 3D Vectorized array of a set size, and provides utilities to set and get values from this array
oCsimulator.WorldClass containing methods to create and query the simulation world (bulk and computational domains)
oCutils.ZipArchiveClass to create and update zip archives that contain simulation result files
oCApplicationFrame
|\Cutils.ChartClass used to represent simulation output on a graph. Assumed deprecated as never called in iDynoMiCS 1.2
oCJFrame
|\Csoft_update.Update_IDynomicsPerforms an update to the iDynomics tool if a new version has been detected
oCRandom
|\Cutils.MTRandomAn implementation of the original java mersenne twister class by Makoto Matsumoto and Takuji Nishimura
\CSerializable
 oCpovray.BackgroundSpecifies the background that will be used in the POV-Ray images
 oCpovray.Biofilm3DCreates a union with a box (the biofilm carrier) and spheres (the bacteria), creating a 3D scene for the PovRay rendering engine
 oCpovray.BoxClass used to set the properties of the box used in POV-Ray output
 oCpovray.CameraCreates the 'camera' settings required to produce POV-Ray output
 oCpovray.ColorMapsClass containing methods to adjust POV-Ray display colours if necessary
 oCpovray.LightSourceClass used to specify the light source information for POV-Ray images
 oCpovray.ParticleWithCapsuleUsed by Povray3DScene to create a capsule object in a format that can be displayed graphically in POV-Ray output
 oCpovray.Povray3DSceneCreate a POV-Ray 3D scene object for use in visualising 3D Biofilms (with class Biofilm3D)
 oCpovray.PovRayWriterClass that writes POV-Ray files that can be used to visualise simulation results
 oCpovray.VectorPropertyClass used by the majority of POV-Ray scripts to represent coordinates and colours as vector properties for use in POV-Ray
 oCsimulator.agent.SpeciesCreates and manages the species that are to be included in an iDynoMiCS simulation
 oCsimulator.geometry.ContinuousVectorImplements 3D vector of continuous spatial coordinates. Can be used to store Continuous coordinates or Movement vectors
 oCsimulator.geometry.DiscreteVectorImplements 3D vector of discrete spatial coordinates
 oCsimulator.geometry.shape.PlanarCreate a planar shaped boundary
 oCsimulator.reaction.kinetic.IsKineticFactorInterface for all kinetic reactions that can be defined in iDynoMiCS
 oCsimulator.reaction.ReactionClass containing methods to create and query reactions that occur in the simulation
 oCsimulator.SpatialGridClass defining a spatial grid, i.e. a matrix of double. The grid is padded, 3D grid
 \Cutils.XMLParserClass providing methods of parsing the XML simulation protocol file