Skip to content

Commit 2f9a7c6

Browse files
committed
📝 Possible improvements in consistency of User documentation (ASCII Mesh/Particles part)
1 parent c0f0efd commit 2f9a7c6

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

user/preprocess/ascii-mesh-particles.md

+6-9
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The ASCII mesh has the following format:
66
```
77
nnodes ncells
88
# nodal coordinates
9-
x_0 y_0 z_0
9+
x_0 y_0 z_0
1010
x_1 y_1 z_1
1111
...
1212
x_i y_i z_i
@@ -23,7 +23,7 @@ ni_i ni_j ni_k ni_l ni_w ni_x ni_y ni_z
2323
nn_i nn_j nn_k nn_l nn_w nn_x nn_y nn_z
2424
```
2525

26-
`nnz` is the number of nodes.
26+
`nnodes` is the number of nodes.
2727

2828
`ncells` the number of cells.
2929

@@ -32,9 +32,6 @@ $x_i$, $y_i$, $z_i$ correspond to the Cartesian coordinates of each node.
3232
Each node will be assigned a unique id from `0` to `nnodes -1`, and will be assigned in the
3333
order in which they appear.
3434

35-
`ncells` refers to the number of nodes per element.
36-
37-
3835
`n1_1, n1_2... n1_nn` corresponds to the node ids forming each cell. Cell ids should be arranged in the same order as the shape functions. This code uses the standard GMSH order for numbering nodes in cells.
3936

4037
An example of a 3D mesh comprising of two cells and twelve nodes is shown below:
@@ -74,11 +71,11 @@ x_i y_i z_i
7471
x_n y_n z_n
7572
```
7673

77-
`nparticles` is the total number of particles. $x_i$, $y_i$, $z_i$ correspond to the Cartesian coordinates of each material point. The material points are assigned a unique id from 0 to `n - 1`.
74+
`nparticles` is the total number of particles. $x_i$, $y_i$, $z_i$ correspond to the Cartesian coordinates of each material point. The material points are assigned a unique id from 0 to `nparticles - 1`.
7875

7976
The `particles-cell.txt` file which describes the initial cell location of each material point has the following format:
8077
```
81-
p_1 c_0
78+
p_0 c_0
8279
p_1 c_1
8380
...
8481
p_i c_i
@@ -99,7 +96,7 @@ sigma_xx,1 sigma_yy,1 sigma_zz,1 tau_xy,1 tau_yz,1 tau_zx,1
9996
...
10097
sigma_xx,i sigma_yy,i sigma_zz,i tau_xy,i tau_yz,i tau_zx,i
10198
...
102-
sigma_11,n sigma_22,n sigma_33,n tau_12,n tau_23,n tau_31,n
99+
sigma_xx,n sigma_yy,n sigma_zz,n tau_xy,n tau_yz,n tau_zx,n
103100
```
104101

105-
`nparticles` is the total number of particles. $\sigma_{xx,i}$, $\sigma_{yy,i}$, $\sigma_{zz,i}$, $\tau_{xy,i}$, $\tau_{yz,i}$, $\tau_{zx,i}$ correspond to the insitu stresses on each material point. Stresses are assigned in order to each material point based on the unique id from 0 to `n - 1`. If including a `particles_stresses.txt` file, stresses must be assigned for all material points.
102+
`nparticles` is the total number of particles. $\sigma_{xx,i}$, $\sigma_{yy,i}$, $\sigma_{zz,i}$, $\tau_{xy,i}$, $\tau_{yz,i}$, $\tau_{zx,i}$ correspond to the insitu stresses on each material point. Stresses are assigned in order to each material point based on the unique id from 0 to `nparticles - 1`. If including a `particles_stresses.txt` file, stresses must be assigned for all material points.

0 commit comments

Comments
 (0)