From f5a80196549860d6f63ca99eb8ec2af00dfb3f2d Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Wed, 29 Jan 2025 16:39:53 -0500 Subject: [PATCH] spelling fixes and updates for the manual --- doc/src/Build_basics.rst | 4 ++-- doc/src/fix_wall_gran.rst | 8 ++++---- doc/src/fix_wall_gran_region.rst | 8 ++++---- doc/src/pair_granular.rst | 15 ++++++++------- doc/utils/sphinx-config/false_positives.txt | 4 ++++ 5 files changed, 22 insertions(+), 17 deletions(-) diff --git a/doc/src/Build_basics.rst b/doc/src/Build_basics.rst index 761c743e2a..be4b312578 100644 --- a/doc/src/Build_basics.rst +++ b/doc/src/Build_basics.rst @@ -203,7 +203,7 @@ LAMMPS. check if the detected or selected compiler is compatible with the C++ support requirements of LAMMPS and stop with an error, if this is not the case. A C++11 compatible compiler is currently - required, but a transition to require C++17 is in progess and + required, but a transition to require C++17 is in progress and planned to be completed in Summer 2025. Currently, setting ``-DLAMMPS_CXX11=yes`` is required when configuring with CMake while using a C++11 compatible compiler that does not support C++17, @@ -329,7 +329,7 @@ LAMMPS. either as a binary package or through compiling from source. While a C++11 compatible compiler is currently sufficient to compile - LAMMPS, a transition to require C++17 is in progess and planned to + LAMMPS, a transition to require C++17 is in progress and planned to be completed in Summer 2025. Currently, setting ``-DLAMMPS_CXX11`` in the ``LMP_INC =`` line in the machine makefile is required when using a C++11 compatible compiler that does not support C++17. diff --git a/doc/src/fix_wall_gran.rst b/doc/src/fix_wall_gran.rst index 0d864cce88..81a411ffc8 100644 --- a/doc/src/fix_wall_gran.rst +++ b/doc/src/fix_wall_gran.rst @@ -248,11 +248,11 @@ listed in the following table. | 8 | Radius :math:`r` of atom | distance units | +-------+----------------------------------------------------+----------------+ -If a granular submodel calculates additional contact information (e.g. the -heat submodels calculate the amount of heat exchanged), these quantities +If a granular sub-model calculates additional contact information (e.g. the +heat sub-models calculate the amount of heat exchanged), these quantities are appended to the end of this array. First, any extra values from the -normal submodel are appended followed by the damping, tangential, rolling, -twisting, then heat models. See the descriptions of granular submodels in +normal sub-model are appended followed by the damping, tangential, rolling, +twisting, then heat models. See the descriptions of granular sub-models in the :doc:`pair granular ` page for information on any extra quantities. diff --git a/doc/src/fix_wall_gran_region.rst b/doc/src/fix_wall_gran_region.rst index 0e5e98f1a8..4ad3b9d6c5 100644 --- a/doc/src/fix_wall_gran_region.rst +++ b/doc/src/fix_wall_gran_region.rst @@ -269,11 +269,11 @@ listed in the following table. | 8 | Radius :math:`r` of atom | distance units | +-------+----------------------------------------------------+----------------+ -If a granular submodel calculates additional contact information (e.g. the -heat submodels calculate the amount of heat exchanged), these quantities +If a granular sub-model calculates additional contact information (e.g. the +heat sub-models calculate the amount of heat exchanged), these quantities are appended to the end of this array. First, any extra values from the -normal submodel are appended followed by the damping, tangential, rolling, -twisting, then heat models. See the descriptions of granular submodels in +normal sub-model are appended followed by the damping, tangential, rolling, +twisting, then heat models. See the descriptions of granular sub-models in the :doc:`pair granular ` page for information on any extra quantities. diff --git a/doc/src/pair_granular.rst b/doc/src/pair_granular.rst index 0a44ccb197..db5e7410b4 100644 --- a/doc/src/pair_granular.rst +++ b/doc/src/pair_granular.rst @@ -258,7 +258,7 @@ in damping model. The definition of multiple *mdr* models in the *pair_style* is currently not supported. Similarly, the *mdr* model cannot be combined with a different normal -model in the *pair_style*. Physically this means that only one homogenous +model in the *pair_style*. Physically this means that only one homogeneous collection of particles governed by a single *mdr* model is allowed. The *mdr* model currently only supports *fix wall/gran/region*, not @@ -303,6 +303,7 @@ radius in the *mdr* model, the keyword/arg pair *cutoff radius* must be specifie simulation involving 200 particles named *in.tableting.200*. The second is a triaxial compaction simulation involving 12 particles named *in.triaxial.compaction.12*. + ---------- In addition, the normal force is augmented by a damping term of the @@ -941,16 +942,16 @@ particle I. The next entry (8) is the magnitude of the rolling torque. The next entry (9) is the magnitude of the twisting torque acting about the vector connecting the two particle centers. The next 3 (10-12) are the components of the vector connecting -the centers of the two particles (x_I - x_J). If a granular submodel -calculates additional contact information (e.g. the heat submodels +the centers of the two particles (x_I - x_J). If a granular sub-model +calculates additional contact information (e.g. the heat sub-models calculate the amount of heat exchanged), these quantities are appended -to the end of this list. First, any extra values from the normal submodel +to the end of this list. First, any extra values from the normal sub-model are appended followed by the damping, tangential, rolling, twisting, then -heat models. See the descriptions of specific granular submodels above +heat models. See the descriptions of specific granular sub-models above for information on any extra quantities. If two or more models are defined by pair coefficients, the size of the array is set by the maximum number of extra quantities in a model but the order of quantities -is determined by each model's specific set of submodels. Any unused +is determined by each model's specific set of sub-models. Any unused quantities are zeroed. These extra quantities can be accessed by the :doc:`compute pair/local ` command, as *p1*, *p2*, ..., @@ -1046,7 +1047,7 @@ a bulk elastic response. Journal of the Mechanics and Physics of Solids, **(Zunker et al, 2025)** Zunker, W., Dunatunga, S., Thakur, S., Tang, P., & Kamrin, K. (2025). Experimentally validated DEM for large deformation powder compaction: mechanically-derived contact model and -screening of non-physical contacts. engrXiv. +screening of non-physical contacts. .. _Luding2008: diff --git a/doc/utils/sphinx-config/false_positives.txt b/doc/utils/sphinx-config/false_positives.txt index 6746d591c6..4bab2b1a95 100644 --- a/doc/utils/sphinx-config/false_positives.txt +++ b/doc/utils/sphinx-config/false_positives.txt @@ -1583,6 +1583,7 @@ Impropers imulator includelink incompressible +incompressibility incrementing indenter indenters @@ -1762,6 +1763,7 @@ Kadiri Kai Kalia Kamberaj +Kamrin Kantorovich Kapfer Kapil @@ -3731,6 +3733,7 @@ tgnpt tgnvt th Thakkar +Thakur Thaokar thb thei @@ -3831,6 +3834,7 @@ Tref Tretyakov tri triangleflag +triaxial Tribello triclinic Triclinic