From 4509a70bcd668fea28b6e2be29c71ba31594c2da Mon Sep 17 00:00:00 2001 From: jduriez Date: Tue, 1 Feb 2022 11:46:02 +0100 Subject: [PATCH 1/3] :pencil: Correct typos in Developer Getting Started documentation --- developer/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/getting-started.md b/developer/getting-started.md index f9166c53..606e100b 100644 --- a/developer/getting-started.md +++ b/developer/getting-started.md @@ -29,7 +29,7 @@ Always use `clang-format` to format your code. Runnning `sh ../clang-tools/forma ## Code documentation -**Documentation is an integral part of code development and must go in-sync with feature development and bug fixes. Documentation is always more important than the facy new feature** Always add in-code docuemntation using Doxygen. +**Documentation is an integral part of code development and must go in-sync with feature development and bug fixes. Documentation is always more important than the fancy new feature** Always add in-code documentation using Doxygen. To document a C++ class: From c0f0efd41e6306af4349b0b6405048bcb9a75994 Mon Sep 17 00:00:00 2001 From: jduriez Date: Tue, 1 Feb 2022 11:48:33 +0100 Subject: [PATCH 2/3] :pencil: Correct typos in User documentation --- user/postprocess/hdf5.md | 2 +- user/postprocess/vtk.md | 2 +- user/preprocess/entity-sets.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/user/postprocess/hdf5.md b/user/postprocess/hdf5.md index 83af67ea..e072544a 100644 --- a/user/postprocess/hdf5.md +++ b/user/postprocess/hdf5.md @@ -1,6 +1,6 @@ # HDF5 -The CB-Geo mpm code writes HDF5 data of partices at each output time step. The HDF5 data can be read using Python / Pandas. If `pandas` package is not installed, run `pip3 install pandas`. +The CB-Geo mpm code writes HDF5 data of particles at each output time step. The HDF5 data can be read using Python / Pandas. If `pandas` package is not installed, run `pip3 install pandas`. To read a particles HDF5 data, for example `particles00.h5` at step 0: diff --git a/user/postprocess/vtk.md b/user/postprocess/vtk.md index 612a44f5..4fa95251 100644 --- a/user/postprocess/vtk.md +++ b/user/postprocess/vtk.md @@ -1,6 +1,6 @@ # VTK -When the CB-Geo mpm code is compiled with VTK libraries, the MPM code can be set to write VTK data of partices at a specified output frequency. The input JSON configuration takes as optional `vtk` argument. The following attributes are valid options for VTK: `"stresses`, `strains`, and `velocities`. When the attribute `vtk` is not specified or an incorrect argument is defined, the code will write all available options. +When the CB-Geo mpm code is compiled with VTK libraries, the MPM code can be set to write VTK data of particles at a specified output frequency. The input JSON configuration takes as optional `vtk` argument. The following attributes are valid options for VTK: `"stresses`, `strains`, and `velocities`. When the attribute `vtk` is not specified or an incorrect argument is defined, the code will write all available options. ```JSON "post_processing": { diff --git a/user/preprocess/entity-sets.md b/user/preprocess/entity-sets.md index 24c00a1f..6bb52745 100644 --- a/user/preprocess/entity-sets.md +++ b/user/preprocess/entity-sets.md @@ -44,4 +44,4 @@ The model can be divided into several sets of particles or nodes by using the `e `c0_i` is the id of a cell within the set id 0. -Each entity (particle or node or cell) set will be assigned a unique id and a vector with the entity's (particles or nodes) id belonging to this set. The entity's id respect the order of the entity input file -- e.g. a particle id of 3 is the fourth particle in the input file `particles.txt`. +Each entity (particle or node or cell) set will be assigned a unique id and a vector with the entity's (particles or nodes) id belonging to this set. The entity's id respects the order of the entity input file -- e.g. a particle id of 3 is the fourth particle in the input file `particles.txt`. From 2f9a7c69df898e07ed1708a752306f479257bbc5 Mon Sep 17 00:00:00 2001 From: jduriez Date: Tue, 1 Feb 2022 11:50:16 +0100 Subject: [PATCH 3/3] :pencil: Possible improvements in consistency of User documentation (ASCII Mesh/Particles part) --- user/preprocess/ascii-mesh-particles.md | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/user/preprocess/ascii-mesh-particles.md b/user/preprocess/ascii-mesh-particles.md index b8094898..4c0fb395 100644 --- a/user/preprocess/ascii-mesh-particles.md +++ b/user/preprocess/ascii-mesh-particles.md @@ -6,7 +6,7 @@ The ASCII mesh has the following format: ``` nnodes ncells # nodal coordinates -x_0 y_0 z_0 +x_0 y_0 z_0 x_1 y_1 z_1 ... 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 nn_i nn_j nn_k nn_l nn_w nn_x nn_y nn_z ``` -`nnz` is the number of nodes. +`nnodes` is the number of nodes. `ncells` the number of cells. @@ -32,9 +32,6 @@ $x_i$, $y_i$, $z_i$ correspond to the Cartesian coordinates of each node. Each node will be assigned a unique id from `0` to `nnodes -1`, and will be assigned in the order in which they appear. -`ncells` refers to the number of nodes per element. - - `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. 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 x_n y_n z_n ``` -`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`. +`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`. The `particles-cell.txt` file which describes the initial cell location of each material point has the following format: ``` -p_1 c_0 +p_0 c_0 p_1 c_1 ... 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 ... sigma_xx,i sigma_yy,i sigma_zz,i tau_xy,i tau_yz,i tau_zx,i ... -sigma_11,n sigma_22,n sigma_33,n tau_12,n tau_23,n tau_31,n +sigma_xx,n sigma_yy,n sigma_zz,n tau_xy,n tau_yz,n tau_zx,n ``` -`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. \ No newline at end of file +`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. \ No newline at end of file