esys.lsm.LsmPy

Module LsmPy

Dynamic linked library module defining classes for creating particle models - this library exposes C++ implementations in Python.

Classes

[hide private]

Model

LsmMpi
Lattice Solid Model (parallelised using Message Passing Interface) container class for defining particle simulations.

NRotSphere
Class defining the properties of non-rotational spheres.

RotSphere
Class defining the properties of spheres with translational and rotational degrees of freedom.

RotSphereVi
EXPERIMENTAL Rotational sphere using Verlet 2nd order time integration.

RotThermalSphere
EXPERIMENTAL Rotational sphere with additional thermal properties.

Runnable
Base class with overridable run method, that is subclassed to implement user-defined subroutines called each timestep of a simulation.

Interaction Types

ABCDampingPrms
Class defining Viscous damping parameters for absorbing boundary conditions.

BondInteractionGroup
Base class for bonded interaction groups.

BrittleBeamPrms
Parameters for rotational bonded interactions based on elastic beam theory with a Mohr-Coulomb failure criterion.

BuoyancyPrms
Parameters for describing simple buoyancy body forces.

CappedNRotBondPrms
Parameters defining linear elastic bonded interactions with a capped separation distance.

DampingPrms
Viscous damping parameters.

FrictionPrms
Parameters for rotational friction, a Coulomb frictional law with shear stiffness.

GravityPrms
Parameters for describing gravitational body force.

HertzianElasticPrms
Parameters for Hertzian elastic contact interactions.

HertzianViscoElasticFrictionPrms
Parameters for Hertzian viscoelastic contact interactions with friction.

HertzianViscoElasticPrms
Parameters for Hertzian viscoelastic contact interactions.

InteractionGroup
Base class for interaction groups.

InteractionPrms
Base class for interaction parameters.

LinDampingPrms
Linear velocity damping parameters.

LinearDashpotPrms
Parameters for linear dashpot interactions.

LocalDampingPrms
Local damping parameters for translational hysteretic damping.

MaxTriggerPrms
Parameter class for max trigger

NRotBondPrms
Parameters for linear elastic bonded interactions with a specified breaking distance (or strain).

NRotBondedLinMeshPrms
Parameters for specifying linear elastic bonds between particles and a piece-wise linear mesh surface.

NRotBondedTriMeshPrms
Parameters for specifying linear elastic bonds between particles and a triangular mesh surface.

NRotBondedWallPrms
Parameters for linear elastic bond between particles and a wall.

NRotElasticLinMeshPrms
Defines linear elastic contact interaction between particles and a piece-wise linear mesh surface.

NRotElasticMesh2DPrms
Defines linear elastic contact interaction between particles and a 2D mesh.

NRotElasticPrms
Parameters for linear elastic contact interactions.

NRotElasticTriMeshPrms
Defines linear elastic contact interaction between particles and a triangular mesh surface.

NRotElasticWallPrms
Parameters for linear elastic contact between particles and a wall.

NRotFrictionPrms
Parameters for non-rotational friction, a Coulomb frictional law with shear-stiffness.

NRotShortBondPrms
Parameters for short linear elastic bond interactions.

NRotSoftBondedWallPrms
Parameters for soft linear elastic bonds between particles and a wall.

RotBondPrms
Parameters for rotational bonded interactions.

RotDampingPrms
Rotational/angular velocity damping parameters.

RotElasticPrms
Parameters defining elastic contacts between rotational particles.

RotFrictionPrms
Parameters for rotational friction, a Coulomb frictional law with shear stiffness.

RotLocalDampingPrms
Local damping parameters for rotational hysteretic damping.

RotThermalBondPrms
EXPERIMENTAL Parameters for rotational, thermal bonded interactions.

RotThermalElasticPrms
EXPERIMENTAL Parameters for linear elastic contact interactions with heat transfer.

RotThermalFrictionPrms
EXPERIMENTAL Parameters for rotational friction, a Coulomb frictional force law with shear stiffness and heat generation due to friction.

VWFrictionPrms
Parameters for velocity weakening friction.

Saving Data

CheckedInteractionScalarFieldSaverPrms
Parameters for saving checked scalar interaction-data to file.

CheckedInteractionVectorFieldSaverPrms
Parameters for saving checked vector interaction-data to file.

FieldSaverPrms
Base class for parameters defining field savers to store model data.

InteractionFieldSaverPrms
Base class describing parameters for saving interaction-data to file.

InteractionScalarFieldSaverPrms
Parameters for saving scalar interaction-data to file.

InteractionVectorFieldSaverPrms
Parameters for saving vector interaction-data to file.

ParticleFieldSaverPrms
Base class describing parameters for saving particle-data to file.

ParticleScalarFieldSaverPrms
Parameters for saving scalar particle-data to file.

ParticleVectorFieldSaverPrms
Parameters for saving vector particle-data to file.

TaggedInteractionScalarFieldSaverPrms
Parameters for saving scalar data on tagged interactions to file.

TaggedParticleScalarFieldSaverPrms
Parameters for saving scalar data of tagged particles to file.

TaggedParticleVectorFieldSaverPrms
Parameters for saving vector data of tagged particles to file.

TriangleScalarFieldSaverPrms
Class describing parameters for saving data located on a triangle mesh to file.

TriangleVectorFieldSaverPrms
Class describing parameters for saving data located on a triangle mesh to file.

WallFieldSaverPrms
Base class describing parameters for saving wall-data to file.

WallVectorFieldSaverPrms
Parameters for saving vector wall-data to file.

Saving Model State

CheckPointPrms
Parameters for specifying check-pointing intervals.

RestartCheckPointPrms
Parameters for specifying check-pointing intervals.

Miscellaneous

MeshGapBuildPrms
Parameters for bonding particles to a mesh which uses distance-to-mesh criterion for creating bonds.

MeshTagBuildPrms
Parameters for bonding particles to a mesh which uses particle-tags as the criterion for creating bonds.

ParticleIdPair
Pair of particle Id's.

ParticleIdPairSet
Set of particle ID pairs.

ParticleIdPairVector
Vector of particle ID pairs.

Functions

[hide private]

Miscellaneous

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

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

setVerbosity(...)

Variables

[hide private]

Miscellaneous

__package__ = None

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.