Module WaveSim

Wave propagation simulation module. Contains WaveSim convenience class for initialising LSM particle model and running wave propagation simulation. This module may be run as a __main__ from the command line as follows:

 Usage: (imported) [options]
 
 Runs wave propagation simulation. A rectangular block of
 particles acts as the elastic medium. Two different spring
 constants can be specified to create non-homogeneity.
 A single point source disturbance creates a wave in theelastic block.
 
 Options:
   -h, --help            show this help message and exit
   -n N, --mpi-worker-processes=N
                         Defines the number of MPI worker processes (default
                         N=2)
   -d D, --mpi-dim-list=D
                         Defines the spatial grid division of domain among  MPI
                         worker processes (default D=[2,0,0])
   -t T, --time-step-size=T
                         Defines time step size used in explicit integration
                         scheme (default T=0.05)
   -r R, --radius=R      Defines radius of particles (default R=1.0)
   -m M, --max-time-steps=M
                         Defines max number of time step iterations (default
                         M=2000)
   -b B, --block-size=B  Defines the size of the particle block as number of
                         particles per dimension component (default
                         B=[128,128,1])
   -P N, --particle-data-incr=N
                         Defines the frequency at which particle displacement
                         data is saved to file. Data is saved every N time
                         steps (default N=100)
   -S N, --seismo-data-incr=N
                         Defines the frequency at which seismograph data is
                         saved to file. Data is saved every N time steps
                         (default N=10)
   -v, --verbosity       Generates (lots of) debug output during simulation run
                         (default no debug output)
   -s D, --source-depth=D
                         Specifies the depth of the source disturbance as a
                         value between 0.0 and 1.0. A value of 0.0 places the
                         source at the surface of the particle-block, a value
                         of 0.5 places the source at the centre of the block, a
                         value of 1.0 places places the source at the bottom of
                         the particle-block, etc (default D=0.5). The source is
                         centred in the particle block with respect to the x
                         and z dimensions.
   -f F, --source-frequency=F
                         Specifies the frequency of the sinusoidal source
                         disturbance (default F=0.02)
   -D M, --source-max-displacement=M
                         Specifies the maximum relative displacement point of
                         the source disturbance  (default F=[0.1,0.1,0.0]). If
                         the point-source is located at point X, then the
                         source particle will be moved on the line between the
                         point X and the point X+F.
   -U D, --upper-medum-depth=D
                         Specifies the depth of the --upper-spring-K bonds as a
                         value between 0.0 and 1.0. A 0.0 value implies no
                         upper-spring-K bonds, a 0.5 value creates half the
                         bonds as upper-spring-K and half the bonds as lower-
                         spring-K, a 1.0 value  creates all bonds as upper-
                         spring-K, etc (default D=0.25)
   -u K, --upper-spring-K=K
                         Defines bond spring constant for 'upper' particle
                         region (default K=1.0)
   -l K, --lower-spring-K=K
                         Defines bond spring constant for 'lower' particle
                         region (default K=1.0)