tgranulargrain.1 - granular - granular dynamics simulation | |
git clone git://src.adamsgaard.dk/granular | |
Log | |
Files | |
Refs | |
README | |
LICENSE | |
--- | |
tgranulargrain.1 (1478B) | |
--- | |
1 .Dd $Mdocdate$ | |
2 .Dt GRANULARGRAIN 1 | |
3 .Os | |
4 .Sh NAME | |
5 .Nm granulargrain | |
6 .Nd generate a single grain in granular format | |
7 .Sh SYNOPSIS | |
8 .Nm | |
9 .Op Fl d Ar diameter | |
10 .Op Fl f | |
11 .Op Fl h | |
12 .Op Fl R | |
13 .Op Fl u Ar vx | |
14 .Op Fl v Ar vy | |
15 .Op Fl w Ar vz | |
16 .Op Fl x Ar x | |
17 .Op Fl y Ar y | |
18 .Op Fl z Ar z | |
19 .Sh DESCRIPTION | |
20 The | |
21 .Nm | |
22 program generates a single grain with default properties, and outputs | |
23 the grain data in | |
24 .Xr granular 5 | |
25 format. | |
26 .Pp | |
27 The options are as follows: | |
28 .Bl -tag -width Ds | |
29 .It Fl d Ar diameter | |
30 Specify grain diameter (default 1.0). | |
31 .It Fl f | |
32 Fix grain in space. | |
33 .It Fl h | |
34 Show help text. | |
35 .It Fl R | |
36 Disable grain rotation. | |
37 .It Fl u Ar vx | |
38 Set x velocity to | |
39 .Ar vx | |
40 [m/s]. | |
41 .It Fl v Ar vy | |
42 Set y velocity to | |
43 .Ar vy | |
44 [m/s]. | |
45 .It Fl w Ar vz | |
46 Set z velocity to | |
47 .Ar vz | |
48 [m/s]. | |
49 .It Fl x Ar x | |
50 Place grain at | |
51 .Ar x | |
52 position [m]. | |
53 .It Fl y Ar y | |
54 Place grain at | |
55 .Ar y | |
56 position [m]. | |
57 .It Fl z Ar z | |
58 Place grain at | |
59 .Ar z | |
60 position [m]. | |
61 .El | |
62 .Sh EXIT STATUS | |
63 .Nm | |
64 exits 0 on success, and >0 if a runtime error occurs: | |
65 .Pp | |
66 .Bl -tag -width Ds -compact | |
67 .It 0 | |
68 successful exit | |
69 .It 1 | |
70 unspecified error | |
71 .It 2 | |
72 .Xr pledge 2 | |
73 error | |
74 .El | |
75 .Sh EXAMPLES | |
76 .Bd -literal -offset indent | |
77 $ (granulargrain -u 1.0; granulargrain -x 1.0) \\ | |
78 | granular -e 2.0 -I 0.1 collision | |
79 $ for f in collision.grain.*.tsv; do \\ | |
80 granular2vtu <"$f" >"${f%.tsv}.vtu"; \\ | |
81 done | |
82 .Ed | |
83 .Sh SEE ALSO | |
84 .Xr granular 1 , | |
85 .Xr granular2img 1 , | |
86 .Xr granular2vtu 1 , | |
87 .Xr granularpacking 1 , | |
88 .Xr granular 5 | |
89 .Sh AUTHORS | |
90 .An Anders Damsgaard Aq Mt [email protected] |