From 871efda589c4c7119a1f1738e53a02e217439ffa Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Wed, 2 Nov 2022 20:39:10 -0400 Subject: [PATCH] a few formal changes and spelling updates --- doc/src/Modify_gsm.rst | 26 ++++++++-------- doc/src/fix_temp_integrate.rst | 6 ---- doc/src/pair_granular.rst | 33 +++++++++++---------- doc/utils/sphinx-config/false_positives.txt | 1 + 4 files changed, 32 insertions(+), 34 deletions(-) diff --git a/doc/src/Modify_gsm.rst b/doc/src/Modify_gsm.rst index f549a9bb45..515c776c6c 100644 --- a/doc/src/Modify_gsm.rst +++ b/doc/src/Modify_gsm.rst @@ -1,5 +1,5 @@ -Granular Submodel (GSM) styles -=========== +Granular Sub-model (GSM) styles +=============================== In granular models, particles are spheres with a finite radius and rotational degrees of freedom as further described in the @@ -9,22 +9,22 @@ of motion as described in :doc:`pair granular ` and :doc:`fix wall/gran `. In both cases, the exchange of forces, torques, and heat flow between two types of bodies is defined using a GranularModel class. The GranularModel class organizes the details of an -interaction using a series of granular submodels each of which describe a +interaction using a series of granular sub-models each of which describe a particular interaction mode (e.g. normal forces or rolling friction). From a -parent GSM class, several types of submodel classes are derived: +parent GSM class, several types of sub-model classes are derived: -* GSMNormal: normal force submodel -* GSMDamping: normal damping submodel -* GSMTangential: tangential forces and sliding friction submodel -* GSMRolling: rolling friction submodel -* GSMTwisting: twisting friction submodel -* GSMHeat: heat conduction submodel +* GSMNormal: normal force sub-model +* GSMDamping: normal damping sub-model +* GSMTangential: tangential forces and sliding friction sub-model +* GSMRolling: rolling friction sub-model +* GSMTwisting: twisting friction sub-model +* GSMHeat: heat conduction sub-model -For each type of submodel, more classes are further derived, each describing +For each type of sub-model, more classes are further derived, each describing a specific implementation. For instance, from the GSMNormal class the GSMNormalHooke, GSMNormalHertz, and GSMNormalJKR classes are derived which calculate Hookean, Hertzian, or JKR normal forces, respectively. This modular -structure simplifies the addition of new granualar contact models as as one only +structure simplifies the addition of new granular contact models as as one only needs to create a new GSM class without having to modify the more complex PairGranular, FixGranWall, and GranularModel classes. Most GSM methods are also already defined by the parent classes so new contact models typically only require @@ -82,7 +82,7 @@ There are also several type-specific methods * - ``GSMNormal->calculate_area()`` - Optional method to return the surface area of the contact. By default, this returns the geometric cross section. * - ``GSMNormal->set_fncrit()`` - - Optional method that defines the critical force to break the contact used by some tangential, rolling, and twisting submodels. By default, this is the current total normal force including damping. + - Optional method that defines the critical force to break the contact used by some tangential, rolling, and twisting sub-models. By default, this is the current total normal force including damping. * - ``GSMNormal->calculate_forces()`` - Required method that returns the normal contact force * - ``GSMDamping->calculate_forces()`` diff --git a/doc/src/fix_temp_integrate.rst b/doc/src/fix_temp_integrate.rst index 03fae7a872..efcf450d8f 100644 --- a/doc/src/fix_temp_integrate.rst +++ b/doc/src/fix_temp_integrate.rst @@ -41,12 +41,6 @@ the *constant* or *type* keywords. For style *constant*, the specific heat is a constant value *cp* for all atoms. For style *type*, *N* different values of the specific heat are defined, one for each of the *N* types of atoms. - - ----------- - -.. include:: accel_styles.rst - ---------- Restart, fix_modify, output, run start/stop, minimize info diff --git a/doc/src/pair_granular.rst b/doc/src/pair_granular.rst index a6533957df..cb044252da 100644 --- a/doc/src/pair_granular.rst +++ b/doc/src/pair_granular.rst @@ -766,26 +766,29 @@ These extra quantities can be accessed by the :doc:`compute pair/local ` page for more info. +This pair style is part of the GRANULAR package. It is +only enabled if LAMMPS was built with that package. +See the :doc:`Build package ` page for more info. -These pair styles require that atoms store torque and angular velocity -(omega) as defined by the :doc:`atom_style `. They also -require a per-particle radius is stored. The *sphere* atom style does -all of this. +This pair style requires that atoms store per-particle radius, +torque, and angular velocity (omega) as defined by the +:doc:`atom_style sphere `. -This pair style requires you to use the :doc:`comm_modify vel yes ` command so that velocities are stored by ghost -atoms. +This pair style requires you to use the :doc:`comm_modify vel yes ` +command so that velocities are stored by ghost atoms. -These pair styles will not restart exactly when using the -:doc:`read_restart ` command, though they should provide -statistically similar results. This is because the forces they -compute depend on atom velocities. See the -:doc:`read_restart ` command for more details. +This pair style will not restart exactly when using the +:doc:`read_restart ` command, though it should provide +statistically similar results. This is because the forces it +computes depend on atom velocities and the atom velocities have +been propagated half a timestep between the force computation and +when the restart is written, due to using Velocity Verlet time +integration. See the :doc:`read_restart ` command +for more details. -Accumulated values for individual contacts are saved to to restart +Accumulated values for individual contacts are saved to restart files but are not saved to data files. Therefore, forces may -differ significantly when a system is reloaded using A +differ significantly when a system is reloaded using the :doc:`read_data ` command. Related commands diff --git a/doc/utils/sphinx-config/false_positives.txt b/doc/utils/sphinx-config/false_positives.txt index 61c1d45ba7..5aeb259ee6 100644 --- a/doc/utils/sphinx-config/false_positives.txt +++ b/doc/utils/sphinx-config/false_positives.txt @@ -1336,6 +1336,7 @@ hdnnp HDNNP Hearn heatconduction +heatflow Hebbeker Hebenstreit Hecht