mesh_module binning

Purpose

Command for binning particle-wall contacts in a cylindrical manner.

Syntax

mesh_module binning id module-ID keywords values
  • id = obligatory keyword

  • module-ID = user-defined name for the mesh module

  • zero or more keyword/value pairs may be appended

  • keyword = file or axis or coord_lo or coord_hi or d_axis or d_phi or every

file value = filename
  filename = file to write binning info to
every value = ev
  ev = write to file every this many time-steps
axis values = x or y or z
  x, y, z = axis used for cylinder binning
coord_lo values = clo
  clo = minimum coordinate along axis for particles to be included in binning  (length units)
coord_hi values = chi
  chi = maximum coordinate along axis for particles to be included in binning  (length units)
d_axis values = da
  da = resolution along axis (length units)
d_phi values = dp
  dp = azimuthal resolution (degrees)

Examples

mesh_module binning id my_binning file meshes/cylinder.stl type 1 stress on wear_model off &
file post/cylinder_binning.txt axis z coord_lo 0. coord_hi 0.3 d_axis 0.1 d_phi 45. every 10000

Description

In this mesh module particle-wall contacts are binned in a cylindrical manner. The cylinder axis is defined by keyword axis and is assumed to go through coordinate 0/0 in the other two directions. Keywords coord_lo and coord_hi define the lowest and highest coordinate along axis for particles to be included in binning. The number of bins in axial and azimuthal direction is controlled via the resolution as defined via keywords d_axis and d_phi.

Currently, the only output quantity is the force in normal direction to the mesh. The file output is then structured as outlined in the example below. Each line in the file stands for one time-step where output is performed:

fn_a0_phi0 fn_a0_phi1 fn_a0_phi2 ... fn_a1_phi0 fn_a1_phi1 ... fn_a(N-1)_phi0 .. fn_a(N-1)_phi(M-1)

where a0..a(N-1) are axial binning indices and phi0..phi(M-1) are azimuthal binning indices. N is the number of bins in axial direction and M the number of bins in azimuthal direction of the mesh. The coordinate order is lo->hi for all the bin indices

Warning

The binning performs a global “allreduce” operation which is expensive and may impair scalability for large number of processes.

Additional information

See mesh command.

Restrictions

None

Default

every = 1,*coord_lo* = coord_hi = 0.0