Class Hierarchy

• unreachable
• unreachable
• unreachable
• unreachable
• esys.lsm.vis.core.box.Box: A rectangular box.
• 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.util.process.Process
• esys.lsm.vis.core.scene.RenderDefaults: Class for setting default rendering options.
• 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.core.arrowExtractor.ArrowExtractor
  • esys.lsm.vis.core.camera.Camera: Objects of this class represent a 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.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.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.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.core.edgeExtractor.EdgeExtractor: Objects can be used in conjunction with EdgeData objects to extract piecewise-linear edges from data-records.
    • esys.lsm.vis.core.pointExtractor.PointExtractor: Extracts a point from a data-record.
    • 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.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.core.imageFormat.ImageFormat: Class representing an image format.
  • esys.lsm.vis.core.modifier.Modifiable
  • esys.lsm.vis.core.modifier.Modifier
  • esys.lsm.vis.core.color.RgbColor: Represents a named color as a (red, green, blue) tuple.
  • esys.lsm.vis.core.scene.Scene: A container for scene objects.
  • esys.lsm.vis.core.sphere.Sphere: Objects of this class represent spheres.
  • esys.lsm.vis.core.surfaceData.SurfaceData: Represents a topographic surface.
  • esys.lsm.vis.core.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.
  • threading._Verbose
    • threading.Thread: A class that represents a thread of control.
      • esys.lsm.util.process.ThreadedWriter
  • unreachable.instance
    • esys.lsm.util.FoundationPy.BoundingBox: An axis aligned box.
    • esys.lsm.util.FoundationPy.BoundingSphere: A sphere - centre point and radius.
    • esys.lsm.LsmPy.CheckPointPrms: Parameters for specifying check-pointing intervals.
      • esys.lsm.LsmPy.RestartCheckPointPrms: Parameters for specifying check-pointing intervals.
    • esys.lsm.LsmPy.FieldSaverPrms: Base class for parameters defining field savers to store 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.TriangleScalarFieldSaverPrms: Class describing parameters for saving data located on a triangle mesh to file.
      • esys.lsm.LsmPy.TriangleVectorFieldSaverPrms: Class describing parameters for saving data located on a triangle mesh 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.LsmPy.InteractionGroup: Base class for interaction groups.
      • esys.lsm.LsmPy.BondInteractionGroup: Base class for bonded interaction groups.
    • esys.lsm.LsmPy.InteractionPrms: Base class for interaction parameters.
      • esys.lsm.LsmPy.ABCDampingPrms: Class defining 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.BuoyancyPrms: Parameters for describing simple buoyancy body forces.
      • esys.lsm.LsmPy.CappedNRotBondPrms: Parameters defining linear elastic bonded interactions with a capped separation distance.
      • 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 bonded interactions with a specified breaking distance (or strain).
      • 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 short linear elastic bond interactions.
      • esys.lsm.LsmPy.NRotSoftBondedWallPrms: Parameters for soft linear elastic bonds between particles and a wall.
      • esys.lsm.LsmPy.RotBondPrms: Parameters for rotational bonded interactions.
      • esys.lsm.LsmPy.RotElasticPrms: Parameters defining elastic contacts between rotational particles.
      • 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 Parameters for rotational, thermal bonded interactions.
      • esys.lsm.LsmPy.RotThermalElasticPrms: EXPERIMENTAL Parameters for linear elastic contact interactions with heat transfer.
      • esys.lsm.LsmPy.RotThermalFrictionPrms: EXPERIMENTAL Parameters for rotational friction, a Coulomb frictional force law with shear stiffness and heat generation due to friction.
      • esys.lsm.LsmPy.VWFrictionPrms: Parameters for velocity weakening friction.
    • esys.lsm.LsmPy.LsmMpi: Lattice Solid Model (parallelised using Message Passing Interface) container class for defining particle simulations.
    • 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: Class defining the properties of non-rotational spheres.
    • 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.LsmPy.RotSphere: Class defining the properties of spheres with translational and rotational degrees of freedom.
    • esys.lsm.LsmPy.RotSphereVi: EXPERIMENTAL Rotational sphere using Verlet 2nd order time integration.
    • esys.lsm.LsmPy.RotThermalSphere: EXPERIMENTAL Rotational sphere with additional thermal properties.
    • esys.lsm.LsmPy.Runnable: Base class with overridable run method, that is subclassed to implement user-defined subroutines called each timestep of a simulation.
    • esys.lsm.util.FoundationPy.Vec3: A 3D coordinate.