Class Hierarchy

esys.lsm.vis.core.Box'.Box: A rectangular box.
- esys.lsm.vis.vtk.Box'.Box
  - esys.lsm.vis.vtk.Box'.Cube: Box with all sides the same length.
esys.lsm.vis.core.Capsule'.CapsuleDisk: Objects of this class represent 2-dimensional capsules.
esys.lsm.vis.core.Color.Colors: Defines class-scope variables representing particular color instances.
esys.lsm.vis.vtk.Color'.Colors
esys.lsm.examples.DisplacementPlotter.Data: Objects store position and displacement vectors.
esys.lsm.vis.vtk.GlyphExtractor.FieldMap
esys.lsm.vis.vtk.GlyphExtractor.GlyphExtractor
optparse.Option: Instance attributes: _short_opts : [string] _long_opts : [string]
- esys.lsm.examples.waveprop.OptionParser.ImprovedOption: Extends optparse.Option class by adding 'int_list' and 'float_list' types
- esys.lsm.util.OptParse.ListOption: Extends optparse.Option class by adding 'string_list', 'int_list' and 'float_list' types
optparse.OptionContainer: Abstract base class.
- optparse.OptionParser: Class attributes: standard_option_list : [Option] list of standard options that will be accepted by all instances of this parser class (intended to be overridden by subclasses).
  - esys.lsm.util.OptParse.OptionParser: Command line option parser which extends optparse.OptionParser by adding "int_list", "float_list" and "string_list" types.
    - esys.lsm.util.OptParse.LogOptionParser: Command line option parser which extends OptionParser by adding a default logging option.
  - esys.lsm.examples.waveprop.OptionParser.OptionParser: Command line option parser for use in conjunction with simple wave propagation simulations.
esys.lsm.examples.Wave2d.PVisitor: Objects of this class are used in conjunction with the waveProp.visitParticlesWithId method to collect model particle data.
esys.lsm.sim.WavePropagation.PVisitor: Objects of this class are used in conjunction with the WavePropagation.visitParticlesWithId method to collect model particle data.
esys.lsm.sim.WavePropagation.ParticleDataVisitor: Helper class whose objects are used to collect seismograph data, from multiple locations, at a particular instant in time.
esys.lsm.util.PathSearcher'.PathSearcher
esys.lsm.util.Process'.Process
esys.lsm.vis.core.Scene'.RenderDefaults: Class for setting default rendering options.
- esys.lsm.vis.vtk.Scene'.RenderDefaults
esys.lsm.vis.vtk.Scene'.Renderer
esys.lsm.sim.WavePropagation.Seismograph: Helper class whose objects represent seismographs.
esys.lsm.sim.WavePropagation.SeismographData: Objects of this class represent seismograph data at a particular instant in time.
esys.lsm.sim.WavePropagation.SeismographGroup: Objects of this class represent a collection of seismographs.
esys.lsm.sim.WavePropagation.SeismographGroupCollection: Represents a collection/list of SeismographGroup objects.
esys.lsm.benchmarks.Util.SimSuite
esys.lsm.sim.WavePropagation.SourcePrms: Base class for point-source distubance which generates elastic wave.
- esys.lsm.sim.WavePropagation.CircularSourcePrms: Defines circular trajectory (time, position) for source disturbance.
- esys.lsm.sim.WavePropagation.ExpSourcePrms: Describes (time, position) trajectory information for a source particle.
  - esys.lsm.examples.Wave2d.MyExpSourcePrms
- esys.lsm.examples.Wave2d.MyCircularSourcePrms
- esys.lsm.examples.waveprop.WaveSim.MyLinearSineSourcePrms: Objects define linear spatial trajectory (sinusoidal time-frequency) for a particle-source-disturbance.
- esys.lsm.examples.Wave2d.MyLinearSineSourcePrms
esys.lsm.examples.waveprop.WaveSim.WaveSim: Wrapper class for 2D and 3D wave propagation simulation.
- esys.lsm.examples.waveprop.FixedLidWaveSim.FixedLidWaveSim: Extends WaveSim.WaveSim class, overides the createBoundaryWalls walls method simply by adding a "fixed lid" instead of having a free-surface.
object: The most base type
- esys.lsm.vis.core.Arrow'.Arrow: Objects of this class represent arrows with conical head and cylindrical tail.
  - esys.lsm.vis.vtk.Arrow'.Arrow
- esys.lsm.vis.core.ArrowExtractor'.ArrowExtractor
  - esys.lsm.vis.vtk.ArrowExtractor'.ArrowExtractor
- esys.lsm.vis.core.Camera'.Camera: Objects of this class represent a camera.
  - esys.lsm.vis.vtk.Camera'.Camera
- esys.lsm.vis.core.Capsule'.Capsule: Objects of this class represent capsules, a cylinder capped with a hemisphere at each end.
- esys.lsm.vis.core.Cylinder'.Cylinder: Objects of this class represent cylinders.
  - esys.lsm.vis.vtk.Cylinder'.Cylinder
    - esys.lsm.vis.vtk.Cylinder'.Disk: Objects of this class represent cylinders.
  - esys.lsm.vis.core.Cylinder'.Disk: Objects of this class represent cylinders.
- esys.lsm.vis.core.EdgeData'.EdgeData: Used to render data which contains piecewise linear edges.
  - esys.lsm.vis.vtk.EdgeData'.EdgeData
- esys.lsm.vis.core.Extractor'.Extractor: Objects of this class are used in conjunction with esys.lsm.vis.core.GlyphData objects in order to extract glyph information from record-data.
  - esys.lsm.vis.core.CylinderExtractor'.CylinderExtractor: Objects of this class can be used in conjunction with the esys.lsm.vis.core.GlyphData class for extracting cylinder info from data-records.
    - esys.lsm.vis.vtk.CylinderExtractor'.CylinderExtractor
  - esys.lsm.vis.core.CylinderExtractor'.DiskExtractor: Objects of this class can be used in conjunction with the esys.lsm.vis.core.GlyphData class for extracting cylinder info from data-records.
    - esys.lsm.vis.vtk.CylinderExtractor'.DiskExtractor
  - esys.lsm.vis.core.EdgeExtractor'.EdgeExtractor: Objects can be used in conjunction with EdgeData objects to extract piecewise-linear edges from data-records.
    - esys.lsm.vis.vtk.EdgeExtractor'.EdgeExtractor
  - esys.lsm.vis.core.PointExtractor'.PointExtractor: Extracts a point from a data-record.
    - esys.lsm.vis.vtk.PointExtractor'.PointExtractor
  - esys.lsm.vis.core.SphereExtractor'.SphereExtractor: Objects of this class can be used in conjunction with the esys.lsm.vis.core.GlyphData class for extracting sphere info from data-records.
    - esys.lsm.vis.vtk.SphereExtractor'.SphereExtractor
- esys.lsm.vis.core.GlyphData'.GlyphData: An object which is rendered as multiple glyphs (of the same type) at a collection of points in space.
  - esys.lsm.vis.vtk.GlyphData'.GlyphData
- esys.lsm.vis.core.ImageFormat'.ImageFormat: Class representing an image format.
- esys.lsm.vis.core.Modifier'.Modifiable
  - esys.lsm.vis.vtk.Modifier'.Modifiable
    - esys.lsm.vis.vtk.Arrow'.Arrow
    - esys.lsm.vis.vtk.Box'.Box
      - esys.lsm.vis.vtk.Box'.Cube: Box with all sides the same length.
    - esys.lsm.vis.vtk.Cone'.Cone
    - esys.lsm.vis.vtk.Cylinder'.Cylinder
      - esys.lsm.vis.vtk.Cylinder'.Disk: Objects of this class represent cylinders.
    - esys.lsm.vis.vtk.Sphere'.Sphere
    - esys.lsm.vis.vtk.TriangulatedSurface'.TriangulatedSurface
- esys.lsm.vis.core.Modifier'.Modifier
  - esys.lsm.vis.vtk.Modifier'.Modifier
    - esys.lsm.vis.vtk.Color'.RgbColor: Extends core.RgbColor by implementing the applyTo method.
- esys.lsm.vis.core.Color.RgbColor: Represents a named color as a (red, green, blue) tuple.
  - esys.lsm.vis.vtk.Color'.RgbColor: Extends core.RgbColor by implementing the applyTo method.
- esys.lsm.vis.core.Scene'.Scene: A container for scene objects.
  - esys.lsm.vis.vtk.Scene'.Scene
- esys.lsm.vis.core.Sphere'.Sphere: Objects of this class represent spheres.
  - esys.lsm.vis.vtk.Sphere'.Sphere
- esys.lsm.vis.core.SurfaceData'.SurfaceData: Represents a topographic surface.
  - esys.lsm.vis.vtk.SurfaceData'.SurfaceData
- esys.lsm.vis.core.TriangulatedSurface'.TriangulatedSurface
  - esys.lsm.vis.vtk.TriangulatedSurface'.TriangulatedSurface
- esys.lsm.vis.core.Cone'.TruncatedCone: Objects of this class represent truncated cones.
  - esys.lsm.vis.core.Cone'.Cone: Objects of this class represent cones.
    - esys.lsm.vis.vtk.Cone'.Cone
- threading._Verbose
  - threading.Thread
    - esys.lsm.util.Process'.ThreadedWriter
- unreachable.instance
  - esys.lsm.util.FoundationPy.BoundingBox: An axis aligned box.
    - esys.lsm.geometry.GeometryPy.HollowBox
    - esys.lsm.geometry.GeometryPy.SolidBox
  - esys.lsm.util.FoundationPy.BoundingSphere: A sphere - centre point and radius.
  - esys.lsm.LsmPy.CheckPointPrms: Parameters for specifying check-pointing intervals.
  - esys.lsm.geometry.GeometryPy.ConnectionFinder
  - esys.lsm.geometry.GeometryPy.DistConnections
  - esys.lsm.LsmPy.FieldSaverPrms: Base class for parameters related to saving model data.
    - esys.lsm.LsmPy.InteractionFieldSaverPrms: Base class describing parameters for saving interaction-data to file.
      - esys.lsm.LsmPy.CheckedInteractionScalarFieldSaverPrms: Parameters for saving checked scalar interaction-data to file.
      - esys.lsm.LsmPy.CheckedInteractionVectorFieldSaverPrms: Parameters for saving checked vector interaction-data to file.
      - esys.lsm.LsmPy.InteractionScalarFieldSaverPrms: Parameters for saving scalar interaction-data to file.
      - esys.lsm.LsmPy.InteractionVectorFieldSaverPrms: Parameters for saving vector interaction-data to file.
      - esys.lsm.LsmPy.TaggedInteractionScalarFieldSaverPrms: Parameters for saving scalar data on tagged interactions to file.
    - esys.lsm.LsmPy.ParticleFieldSaverPrms: Base class describing parameters for saving particle-data to file.
      - esys.lsm.LsmPy.ParticleScalarFieldSaverPrms: Parameters for saving scalar particle-data to file.
        
        esys.lsm.LsmPy.TaggedParticleScalarFieldSaverPrms: Parameters for saving scalar data of tagged particles to file.
      - esys.lsm.LsmPy.ParticleVectorFieldSaverPrms: Parameters for saving vector particle-data to file.
        
        esys.lsm.LsmPy.TaggedParticleVectorFieldSaverPrms: Parameters for saving vector data of tagged particles to file.
    - esys.lsm.LsmPy.WallFieldSaverPrms: Base class describing parameters for saving wall-data to file.
      - esys.lsm.LsmPy.WallVectorFieldSaverPrms: Parameters for saving vector wall-data to file.
  - esys.lsm.geometry.GeometryPy.GougeConfig
  - esys.lsm.geometry.GeometryPy.GougeConfigPrms
  - esys.lsm.geometry.GeometryPy.GrainCollection
  - esys.lsm.geometry.GeometryPy.GrainCollectionGrainIterator
  - esys.lsm.geometry.GeometryPy.GrainRndPackPrms
  - esys.lsm.LsmPy.InteractionGroup: Base class for interaction groups.
    - esys.lsm.LsmPy.BondInteractionGroup: Bonded interaction group.
  - esys.lsm.LsmPy.InteractionPrms: Base class for interaction parameters.
    - esys.lsm.LsmPy.ABCDampingPrms: Viscous damping parameters for absorbing boundary conditions.
    - esys.lsm.LsmPy.BrittleBeamPrms: Parameters for rotational bonded interactions based on elastic beam theory with a Mohr-Coulomb failure criterion.
    - esys.lsm.LsmPy.CappedNRotBondPrms: Parameters for linear elastic bond interactions.
    - esys.lsm.LsmPy.DampingPrms: Viscous damping parameters.
      - esys.lsm.LsmPy.LinDampingPrms: Linear velocity damping parameters.
      - esys.lsm.LsmPy.RotDampingPrms: Rotational/angular velocity damping parameters.
    - esys.lsm.LsmPy.FrictionPrms: Parameters for rotational friction, a Coulomb frictional law with shear stiffness.
    - esys.lsm.LsmPy.GravityPrms: Parameters for describing gravitational body force.
    - esys.lsm.LsmPy.HertzianElasticPrms: Parameters for Hertzian elastic contact interactions.
    - esys.lsm.LsmPy.HertzianViscoElasticFrictionPrms: Parameters for Hertzian viscoelastic contact interactions with friction.
    - esys.lsm.LsmPy.HertzianViscoElasticPrms: Parameters for Hertzian viscoelastic contact interactions.
    - esys.lsm.LsmPy.LinearDashpotPrms: Parameters for linear dashpot interactions.
    - esys.lsm.LsmPy.LocalDampingPrms: Local damping parameters for translational hysteretic damping.
    - esys.lsm.LsmPy.NRotBondPrms: Parameters for linear elastic bond interactions.
    - esys.lsm.LsmPy.NRotBondedLinMeshPrms: Parameters for specifying linear elastic bonds between particles and a piece-wise linear mesh surface.
    - esys.lsm.LsmPy.NRotBondedTriMeshPrms: Parameters for specifying linear elastic bonds between particles and a triangular mesh surface.
    - esys.lsm.LsmPy.NRotBondedWallPrms: Parameters for linear elastic bond between particles and a wall.
    - esys.lsm.LsmPy.NRotElasticPrms: Parameters for linear elastic contact interactions.
    - esys.lsm.LsmPy.NRotElasticWallPrms: Parameters for linear elastic contact between particles and a wall.
    - esys.lsm.LsmPy.NRotFrictionPrms: Parameters for non-rotational friction, a Coulomb frictional law with shear-stiffness.
    - esys.lsm.LsmPy.NRotShortBondPrms: Parameters for linear elastic bond interactions.
    - esys.lsm.LsmPy.NRotSoftBondedWallPrms: Parameters for linear elastic bond between particles and a wall.
    - esys.lsm.LsmPy.RotBondPrms: Parameters for rotational bonded interactions.
    - esys.lsm.LsmPy.RotElasticPrms: Parameters for rotational elastic contact interactions.
    - esys.lsm.LsmPy.RotFrictionPrms: Parameters for rotational friction, a Coulomb frictional law with shear stiffness.
    - esys.lsm.LsmPy.RotLocalDampingPrms: Local damping parameters for rotational hysteretic damping.
    - esys.lsm.LsmPy.RotThermalBondPrms: EXPERIMENTAL.
    - esys.lsm.LsmPy.RotThermalElasticPrms: EXPERIMENTAL.
    - esys.lsm.LsmPy.RotThermalFrictionPrms: EXPERIMENTAL.
    - esys.lsm.LsmPy.VWFrictionPrms: Parameters for velocity weakening friction.
  - esys.lsm.tools.MacroFrictionCalcPy.LinearWindowAverager
  - esys.lsm.LsmPy.LsmMpi: Lattice Solid Model (parallelised using Message Passing Interface) class for particle simulation.
    - esys.lsm.benchmarks.Util.BenchSim
      - esys.lsm.benchmarks.BondedBlock.BondedBlockSim
      - esys.lsm.benchmarks.Gravity.GravitySim
    - esys.lsm.sim.WavePropagationPy.WavePropagation
      - esys.lsm.sim.WavePropagation.WavePropagation: Wave propagation model, extends the esys.lsm.sim.WavePropagationPy.WavePropagation by providing convenient methods for saving data, creating partices/bonds and creating seismographs.
  - esys.lsm.tools.MacroFrictionCalcPy.MacroFrictionCalculator
  - esys.lsm.LsmPy.MaxTriggerPrms: Parameter class for max trigger
  - esys.lsm.LsmPy.MeshGapBuildPrms: Parameters for bonding particles to a mesh which uses distance-to-mesh criterion for creating bonds.
  - esys.lsm.LsmPy.MeshTagBuildPrms: Parameters for bonding particles to a mesh which uses particle-tags as the criterion for creating bonds.
  - esys.lsm.LsmPy.NRotElasticLinMeshPrms: Defines linear elastic contact interaction between particles and a piece-wise linear mesh surface.
  - esys.lsm.LsmPy.NRotElasticMesh2DPrms: Defines linear elastic contact interaction between particles and a 2D mesh.
  - esys.lsm.LsmPy.NRotElasticTriMeshPrms: Defines linear elastic contact interaction between particles and a triangular mesh surface.
  - esys.lsm.LsmPy.NRotSphere
  - esys.lsm.geometry.GeometryPy.Packer: Base class for sphere packers.
    - esys.lsm.geometry.GeometryPy.BoxPackerBase: Base class for BoxPacker.
      - esys.lsm.geometry.GeometryPy.BoxPacker: Base class of packers which generate packings within a rectangular region.
        
        esys.lsm.geometry.GeometryPy.CubicBoxPackerBase: Base class for CubicBoxPacker.
        
        esys.lsm.geometry.GeometryPy.CubicBoxPacker: Instances generate a regular cubic close packing of identically sized spheres within the confines of a specified box.
        
        esys.lsm.geometry.GeometryPy.GrainCubicBoxPacker: Base class for GrainRndBoxPacker.
        
        esys.lsm.geometry.GeometryPy.GrainRndBoxPacker: Base class for GrainRandomBoxPackerBase.
        
        esys.lsm.geometry.GeometryPy.GrainRandomBoxPackerBase: Base class for GrainRandomBoxPacker.
        
        esys.lsm.geometry.GeometryPy.GrainRandomBoxPacker: Instances generate a packing of randomly sized aggregate grains within the confines of a specified box.
        
        esys.lsm.geometry.GeometryPy.RandomBoxPackerBase: Base class for RandomBoxPacker.
        
        esys.lsm.geometry.GeometryPy.RandomBoxPacker: Instances generate a packing of randomly sized spheres within the confines of a specified box.
        
        esys.lsm.geometry.GeometryPy.RndCubicBoxPackerBase: Base class for RandomSpherePacker.
        
        esys.lsm.geometry.GeometryPy.RandomSpherePackerBase: Base class for RandomSpherePacker.
        
        esys.lsm.geometry.GeometryPy.RandomSpherePacker: Instances generate a packing of randomly sized spheres within the confines of a specified sphere.
  - esys.lsm.geometry.GeometryPy.ParticleCollection: A collection of SimpleSphere objects.
    - esys.lsm.geometry.GeometryPy.Grain: Represents an aggregation of particles.
  - esys.lsm.LsmPy.ParticleIdPair: Pair of particle Id's.
  - esys.lsm.LsmPy.ParticleIdPairSet: Set of particle ID pairs.
  - esys.lsm.LsmPy.ParticleIdPairVector: Vector of particle ID pairs.
  - esys.lsm.geometry.GeometryPy.ParticleRndPackPrms
  - esys.lsm.geometry.GeometryPy.RndGrainGen: Virtual class used to generate grains for GrainRandomBoxPacker instances.
    - esys.lsm.geometry.SphericalGrainGen.AbsGrainGen: Grain generator which can be used in conjunction with the GougeConfigPrms and GrainRandomBoxPacker classes.
    - esys.lsm.geometry.SphericalGrainGen.ScaledMaxGrainGen: Grain generator which can be used in conjunction with the GougeConfigPrms and GrainRandomBoxPacker classes.
    - esys.lsm.geometry.SphericalGrainGen.ScaledMinMaxGrainGen: Grain generator which can be used in conjunction with the GougeConfigPrms and GrainRandomBoxPacker classes.
    - esys.lsm.geometry.SingleParticleGrainGen.SingleParticleGrainGen: Grain generator which can be used in conjunction with the GougeConfigPrms and GrainRandomBoxPacker classes.
  - esys.lsm.LsmPy.RotSphere
  - esys.lsm.LsmPy.RotSphereVi: EXPERIMENTAL.
  - esys.lsm.LsmPy.RotThermalSphere: EXPERIMENTAL.
  - esys.lsm.LsmPy.Runnable: Base class which contains overridable run method.
    - esys.lsm.benchmarks.compress.compbench.Loading: Objects of this class provide the loading mechanism for a compression simulation.
    - esys.lsm.benchmarks.gouge2d.gouge2dbench.Loading: Objects of this class provide the loading mechanism for a compression simulation.
    - esys.lsm.examples.simple.compress3d.Loading: Loading mechanism which moves the walls.
    - esys.lsm.sim.WavePropagation.WaveSource: Helper class which moves a source particle during each time step.
  - esys.lsm.geometry.GeometryPy.SimpleSphere
  - esys.lsm.geometry.GeometryPy.SimpleSphereCollection: A collection of SimpleSphere objects.
    - esys.lsm.geometry.GeometryPy.CubicBlock: Collection of particles arranged in a cubic close (face centred cubic) packing.
    - esys.lsm.geometry.GeometryPy.HexagBlock: Collection of particles arranged in a hexagonal close packing.
    - esys.lsm.geometry.GeometryPy.SimpleBlock: A regular packing of spheres.
  - esys.lsm.geometry.GeometryPy.SimpleSphereCollectionIterator
  - esys.lsm.geometry.GeometryPy.SimpleSphereNeighbours: Discovers pairs of spheres which are closer than a specified threshold distance.
  - esys.lsm.geometry.GeometryPy.SsNeighbourParticleIdPairIterator
  - esys.lsm.geometry.GeometryPy.TaggedIdConnection: Instances represent some kind of relationship (connection) between a pair of Id's.
  - esys.lsm.geometry.GeometryPy.TaggedIdConnectionIterator
  - esys.lsm.util.FoundationPy.Vec3: A 3D coordinate.
  - esys.lsm.tools.MacroFrictionCalcPy.WallForcePair
  - esys.lsm.tools.MacroFrictionCalcPy.WallForceReader
- int: int(x[, base]) -> integer
  - unreachable.enum
    - esys.lsm.geometry.GeometryPy.Orientation