tgranularpacking.1 - granular - granular dynamics simulation
 (HTM) git clone git://src.adamsgaard.dk/granular
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) README
 (DIR) LICENSE
       ---
       tgranularpacking.1 (1907B)
       ---
            1 .Dd $Mdocdate$
            2 .Dt GRANULARPACKING 1
            3 .Os
            4 .Sh NAME
            5 .Nm granularpacking
            6 .Nd generate a packing of granular data
            7 .Sh SYNOPSIS
            8 .Nm
            9 .Op Fl D Ar max-diameter
           10 .Op Fl d Ar min-diameter
           11 .Op Fl h
           12 .Op Fl P
           13 .Op Fl p Ar padding-factor
           14 .Op Fl t
           15 .Op Fl X Ar x-offset
           16 .Op Fl x Ar nx
           17 .Op Fl Y Ar y-offset
           18 .Op Fl y Ar ny
           19 .Op Fl Z Ar z-offset
           20 .Op Fl z Ar nz
           21 .Sh DESCRIPTION
           22 The
           23 .Nm
           24 program generates a regular or random packing of grains, and outputs
           25 the grain data in
           26 .Xr granular 5
           27 format.
           28 .Pp
           29 The options are as follows:
           30 .Bl -tag -width Ds
           31 .It Fl D Ar max-diameter
           32 Specify maximum size of generated grains (default 1.0).
           33 .It Fl d Ar min-diameter
           34 Specify minimum size of generated grains (default 1.0).
           35 .It Fl h
           36 Show help text.
           37 .It Fl t
           38 Generate triangular packing (default: rectangular).
           39 .It Fl P
           40 Draw random diameters using a power-law distribution (default: uniform).
           41 .It Fl p Ar padding-factor
           42 Add padding between grains and add corresponding random variation
           43 to placement with the specified multiplier, respective to the grain
           44 radius (default 0.0).
           45 .It Fl X Ar x-offset
           46 Add the specified offset to all output x positions (default 0.0).
           47 .It Fl x Ar nx
           48 Generate
           49 .Ar nx
           50 grains in the x dimension (default 10).
           51 .It Fl Y Ar y-offset
           52 Add the specified offset to all output y positions (default 0.0).
           53 .It Fl y Ar ny
           54 Generate
           55 .Ar ny
           56 grains in the y dimension (default 10).
           57 .It Fl Z Ar x-offset
           58 Add the specified offset to all output z positions (default 0.0).
           59 .It Fl z Ar nz
           60 Generate
           61 .Ar nz
           62 grains in the z dimension (default 1).
           63 .El
           64 .Sh EXIT STATUS
           65 .Nm
           66 exits 0 on success, and >0 if a runtime error occurs:
           67 .Pp
           68 .Bl -tag -width Ds -compact
           69 .It 0
           70 successful exit
           71 .It 1
           72 unspecified error
           73 .It 2
           74 .Xr pledge 2
           75 error
           76 .El
           77 .Sh EXAMPLES
           78 .Dl $ granularpacking | granular2vtk > out.vtk
           79 .Sh SEE ALSO
           80 .Xr granular2img 1 ,
           81 .Xr granular2vtk 1 ,
           82 .Xr granulargrain 1 ,
           83 .Xr granular 5
           84 .Sh AUTHORS
           85 .An Anders Damsgaard Aq Mt anders@adamsgaard.dk