From 4a3394b300087ca7e553d688ffb9701fec961e15 Mon Sep 17 00:00:00 2001
From: jtclemm <jtclemm@sandia.gov>
Date: Tue, 4 Feb 2025 15:42:01 -0700
Subject: [PATCH] Adding references to bpplastic bpm bond style

---
 doc/src/Commands_bond.rst | 1 +
 doc/src/Howto_bpm.rst     | 6 ++++--
 doc/src/bond_style.rst    | 3 ++-
 3 files changed, 7 insertions(+), 3 deletions(-)

diff --git a/doc/src/Commands_bond.rst b/doc/src/Commands_bond.rst
index 40532bdef7..05c505b5ee 100644
--- a/doc/src/Commands_bond.rst
+++ b/doc/src/Commands_bond.rst
@@ -23,6 +23,7 @@ OPT.
    *
    * :doc:`bpm/rotational <bond_bpm_rotational>`
    * :doc:`bpm/spring <bond_bpm_spring>`
+   * :doc:`bpm/spring/plastic <bond_bpm_spring_plastic>`
    * :doc:`class2 (ko) <bond_class2>`
    * :doc:`fene (iko) <bond_fene>`
    * :doc:`fene/expand (o) <bond_fene_expand>`
diff --git a/doc/src/Howto_bpm.rst b/doc/src/Howto_bpm.rst
index f2aa1fc0a3..f632ee6172 100644
--- a/doc/src/Howto_bpm.rst
+++ b/doc/src/Howto_bpm.rst
@@ -42,12 +42,14 @@ such as those created by pouring grains using :doc:`fix pour
 
 ----------
 
-Currently, there are two types of bonds included in the BPM package. The
+Currently, there are three types of bonds included in the BPM package. The
 first bond style, :doc:`bond bpm/spring <bond_bpm_spring>`, only applies
 pairwise, central body forces. Point particles must have :doc:`bond atom
 style <atom_style>` and may be thought of as nodes in a spring
 network. An optional multibody term can be used to adjust the network's
-Poisson's ratio. Alternatively, the second bond style, :doc:`bond bpm/rotational
+Poisson's ratio. The :doc:`bpm/spring/plastic <bond_bpm_spring_plastic>`
+bond style is similar except it adds a plastic yield strain.
+Alternatively, the third bond style, :doc:`bond bpm/rotational
 <bond_bpm_rotational>`, resolves tangential forces and torques arising
 with the shearing, bending, and twisting of the bond due to rotation or
 displacement of particles.  Particles are similar to those used in the
diff --git a/doc/src/bond_style.rst b/doc/src/bond_style.rst
index 590f7c8cba..a30fb9e812 100644
--- a/doc/src/bond_style.rst
+++ b/doc/src/bond_style.rst
@@ -10,7 +10,7 @@ Syntax
 
    bond_style style args
 
-* style = *none* or *zero* or *hybrid* or *bpm/rotational* or *bpm/spring* or *class2* or *fene* or *fene/expand* or *fene/nm* or *gaussian* or *gromos* or *harmonic* or *harmonic/restrain* *harmonic/shift* or *harmonic/shift/cut* or *lepton* or *morse* or *nonlinear* or *oxdna/fene* or *oxdena2/fene* or *oxrna2/fene* or *quartic* or *special* or *table*
+* style = *none* or *zero* or *hybrid* or *bpm/rotational* or *bpm/spring* or *bpm/spring/plastic* or *class2* or *fene* or *fene/expand* or *fene/nm* or *gaussian* or *gromos* or *harmonic* or *harmonic/restrain* *harmonic/shift* or *harmonic/shift/cut* or *lepton* or *morse* or *nonlinear* or *oxdna/fene* or *oxdena2/fene* or *oxrna2/fene* or *quartic* or *special* or *table*
 
 * args = none for any style except *hybrid*
 
@@ -86,6 +86,7 @@ accelerated styles exist.
 
 * :doc:`bpm/rotational <bond_bpm_rotational>` - breakable bond with forces and torques based on deviation from reference state
 * :doc:`bpm/spring <bond_bpm_spring>` - breakable bond with forces based on deviation from reference length
+* :doc:`bpm/spring/plastic <bond_bpm_spring_plastic>` - a similar breakable bond with plastic yield
 * :doc:`class2 <bond_class2>` - COMPASS (class 2) bond
 * :doc:`fene <bond_fene>` - FENE (finite-extensible non-linear elastic) bond
 * :doc:`fene/expand <bond_fene_expand>` - FENE bonds with variable size particles