Package esys :: Package lsm

Package lsm

Lattice Solid Model discrete element simulation package. For an introduction, see the documentation modules in esys.lsm.doc.

Organization: The University of Queensland Earth Systems Science Computational Centre (ESSCC) (Brisbane, Queensland, Australia) www.uq.edu.au/esscc

License: Open Software License version 3.0 www.opensource.org/licenses/osl-3.0.php

See Also: the ESyS-Particle home page

Submodules

[hide private]

esys.lsm.Logging
esys.lsm.LsmPy: Dynamic linked library module defining classes for creating particle models - this library exposes C++ implementations in Python.
esys.lsm.benchmarks: Package containing various simulations to be used as a basis for performance analysis.
- esys.lsm.benchmarks.BondedBlock: Module for running a suite of bonded-block benchmark simulations.
- esys.lsm.benchmarks.Gravity: Module for running a suite of gravity benchmark simulations.
- esys.lsm.benchmarks.Util: Common functionality between benchmarks.
- esys.lsm.benchmarks.compress: Elastically bonded block-compression simulations.
  - esys.lsm.benchmarks.compress.compbench: Defines runSimulation function which executes compression simulation.
- esys.lsm.benchmarks.gouge2d
  - esys.lsm.benchmarks.gouge2d.gouge2dbench: Defines runSimulation function which executes gouge shear simulation.
esys.lsm.doc: Documentation package.
- esys.lsm.doc.GravityTut: A simple gravity simulation.
- esys.lsm.doc.InitialConfigTut: Creating packings of spheres and saving/loading packing-data from file.
- esys.lsm.doc.Installation: Installation documentation.
- esys.lsm.doc.Overview: LSM overview.
- esys.lsm.doc.VisualisationTut: Visualising data tutorial.
esys.lsm.examples: Example LSM python modules and packages.
- esys.lsm.examples.Wave2d
- esys.lsm.examples.simple: Package containing basic example scripts for running LSM simulations.
  - esys.lsm.examples.simple.compress3d: Example simulation of compression of an elastically bonded block of non-rotational spheres.
- esys.lsm.examples.waveprop: Wave propagation example package.
  - esys.lsm.examples.waveprop.FixedLidWaveSim: Defines single class FixedLidWaveSim.FixedLidWaveSim which extends WaveSim.WaveSim.
  - esys.lsm.examples.waveprop.OptionParser: Defines classes for parsing command line options of wave propagation simulations.
  - esys.lsm.examples.waveprop.WaveSim: Wave propagation simulation module.
esys.lsm.geometry: Defines modules and classes which can be used to generate various packings of particles and creating bonds/connections to be used in conjunction with the LSM.
- esys.lsm.geometry.GeometryPy: Dynamic linked library module defining classes for creating packings of particles and connections between particles - This library exposes C++ implementations in Python.
- esys.lsm.geometry.SingleParticleGrainGen': Defines the SingleParticleGrainGen class which extends RndGrainGen.
- esys.lsm.geometry.SphericalGrainGen: Defines classes, instances of which, can be used to generate spherical grains packed with randomly sized circular particles.
esys.lsm.sim
- esys.lsm.sim.WavePropagation'
- esys.lsm.sim.WavePropagationPy
esys.lsm.tools
- esys.lsm.tools.MacroFrictionCalcPy
esys.lsm.util
- esys.lsm.util.FileUtil
- esys.lsm.util.FoundationPy
- esys.lsm.util.InstallInfo: Provides install path infomation.
- esys.lsm.util.OptParse: Defines OptionParser class which extends optparse.OptionParser class by adding 'string_list', 'int_list' and 'float_list' option types.
- esys.lsm.util.PathSearcher'
- esys.lsm.util.Process'
esys.lsm.vis: Visualisation.
- esys.lsm.vis.core: Defines common base classes for render packages.
  - esys.lsm.vis.core.Arrow': Defines the Arrow base class
  - esys.lsm.vis.core.ArrowExtractor': Defines the Arrow base class
  - esys.lsm.vis.core.Box': Defines the Box base class
  - esys.lsm.vis.core.Camera': Defines the Camera base class
  - esys.lsm.vis.core.Capsule': Defines the Capsule base class
  - esys.lsm.vis.core.Color: Defines RgbColor base class and Colors pseudo class.
  - esys.lsm.vis.core.Cone': Defines the TruncatedCone and Cone base classes
  - esys.lsm.vis.core.Cylinder': Defines the Cylinder and Disk base classes
  - esys.lsm.vis.core.CylinderExtractor': Defines the CylinderExtractor class.
  - esys.lsm.vis.core.EdgeData': Defines the EdgeData class.
  - esys.lsm.vis.core.EdgeExtractor': Defines the EdgeExtractor class.
  - esys.lsm.vis.core.Exception: Defines helper function raiseNotImplemented for raising an exception in abstract methods of base classes.
  - esys.lsm.vis.core.Extractor': Defines the Extractor base class.
  - esys.lsm.vis.core.GlyphData': Defines GlyphData base class.
  - esys.lsm.vis.core.ImageFormat': Defines the ImageFormat class and functions for mapping a file name extension to an associated ImageFormat object.
  - esys.lsm.vis.core.Modifier': Defines classes which relate to modifying renderable objects.
  - esys.lsm.vis.core.PointExtractor': Defines the PointExtractor class.
  - esys.lsm.vis.core.Scene': Defines the Scene base class.
  - esys.lsm.vis.core.Sphere': Defines the Sphere base class
  - esys.lsm.vis.core.SphereExtractor': Defines the SphereExtractor class.
  - esys.lsm.vis.core.SurfaceData': Defines the SurfaceData class.
  - esys.lsm.vis.core.TriangulatedSurface': Defines the TriangulatedSurface class.
- esys.lsm.vis.povray: PovRay (Point of vision Ray-tracer) render package.
  - esys.lsm.vis.povray.Arrow': Defines the Arrow class
  - esys.lsm.vis.povray.ArrowExtractor'
  - esys.lsm.vis.povray.Box': Defines the Box and Cube classes
  - esys.lsm.vis.povray.Camera'
  - esys.lsm.vis.povray.Capsule': Defines the Capsule base class
  - esys.lsm.vis.povray.Color
  - esys.lsm.vis.povray.Cone': Defines the Cone base class
  - esys.lsm.vis.povray.Csg: Constructive solid geometry classes: Union.
  - esys.lsm.vis.povray.Cylinder': Defines the Cylinder base class
  - esys.lsm.vis.povray.CylinderExtractor'
  - esys.lsm.vis.povray.EdgeData'
  - esys.lsm.vis.povray.EdgeExtractor'
  - esys.lsm.vis.povray.GlyphData'
  - esys.lsm.vis.povray.Modifier': Defines classes which relate to modifying renderable objects.
  - esys.lsm.vis.povray.Object
  - esys.lsm.vis.povray.PovRenderer': Defines various classes which control the parameters (arguments) for running of a povray process.
  - esys.lsm.vis.povray.Scene'
  - esys.lsm.vis.povray.Sphere': Defines the Sphere base class
  - esys.lsm.vis.povray.SphereExtractor'
  - esys.lsm.vis.povray.TriangulatedSurface': Defines the TriangulatedSurface class.

Functions

[hide private]

checkMpiDimensions(...)
Checks validity of numProcesses and mpiDimList arguments.

checkParticleType(...)
Raises ValueError if particle type is invalid.

setVerbosity(...)

Variables

[hide private]

__package__ = 'esys.lsm'

Function Details

[hide private]

checkMpiDimensions(...)

Checks validity of numProcesses and mpiDimList arguments. numProcesses should be positive, mpiDimList should contain 3 elements and the product of non-zero elements should be a divisor of numProcesses. Raises ValueError if arguments are determined to be invalid.

Parameters:

numProcesses (int) - number of mpi worker processes.
mpiDimList (list of three ints) - MPI cartesian communicator list.

Raises:

ValueError - if numProcesses and mpiDimList are not consistent.

checkParticleType(...)

Raises ValueError if particle type is invalid.

Parameters:

particleType (string) - Type of particle.