tgranular.1 - granular - granular dynamics simulation | |
git clone git://src.adamsgaard.dk/granular | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
tgranular.1 (1559B) | |
--- | |
1 .Dd $Mdocdate$ | |
2 .Dt GRANULAR 1 | |
3 .Os | |
4 .Sh NAME | |
5 .Nm granular | |
6 .Nd simulate granular interaction through time | |
7 .Sh SYNOPSIS | |
8 .Nm | |
9 .Op Fl e Ar end-time | |
10 .Op Fl g Ar gravity-accel | |
11 .Op Fl h | |
12 .Op Fl I Ar file-interval | |
13 .Op Fl j Ar time-step | |
14 .Op Fl t Ar curr-time | |
15 .Op name | |
16 .Sh DESCRIPTION | |
17 .Nm | |
18 reads | |
19 .Xr granular 5 | |
20 data with grain properties from stdin, simulates granular interaction | |
21 over time, and prints the resultant state. | |
22 If | |
23 .Ar name | |
24 is set, the simulation state is written to files in | |
25 .Xr granular 5 | |
26 format in the current directory. | |
27 The files are named | |
28 .Pa <name>.outputDDDDD.txt , | |
29 where DDDDD is an integer counter starting from 00000, and incrementing | |
30 by 1 for each new file. | |
31 .Pp | |
32 The options are as follows: | |
33 .Bl -tag -width Ds | |
34 .It Fl e Ar end-time | |
35 Set the time where to end the simulation [s] (default 0.0). | |
36 .It Fl g Ar gravity-accel | |
37 y-component of gravitational acceleration [m/s^2] (default 0.0). | |
38 .It Fl h | |
39 Show usage information. | |
40 .It Fl I Ar file-interval | |
41 Simulation time interval between writing output to disk [s] (default | |
42 1.0). | |
43 .It Fl j Ar time-step | |
44 Override numerical time step length [s]. | |
45 .It Fl t Ar curr-time | |
46 Simulation start time [s] (default 0.0). | |
47 .El | |
48 .Sh EXIT STATUS | |
49 .Nm | |
50 exits 0 on success, and >0 if a runtime error occurs: | |
51 .Pp | |
52 .Bl -tag -width Ds -compact | |
53 .It 0 | |
54 successful exit | |
55 .It 1 | |
56 unspecified error | |
57 .It 2 | |
58 .Xr pledge 2 | |
59 error | |
60 .El | |
61 .Sh EXAMPLES | |
62 .Dl $ granularpacking | granular | granular2vtu > out.vtk | |
63 .Sh SEE ALSO | |
64 .Xr granular2img 1 , | |
65 .Xr granular2vtu 1 , | |
66 .Xr granularpacking 1 , | |
67 .Xr granular 5 | |
68 .Sh AUTHORS | |
69 .An Anders Damsgaard Aq Mt [email protected] |