Unverified Commit 70d3d569 authored by Axel Kohlmeyer's avatar Axel Kohlmeyer
Browse files

add minimal doc page for compute smd/ulsph/effm

parent ed568782
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -122,6 +122,7 @@ KOKKOS, o = USER-OMP, t = OPT.
   * :doc:`smd/tlsph/strain/rate <compute_smd_tlsph_strain_rate>`
   * :doc:`smd/tlsph/stress <compute_smd_tlsph_stress>`
   * :doc:`smd/triangle/vertices <compute_smd_triangle_vertices>`
   * :doc:`smd/ulsph/effm <compute_smd_ulsph_effm>`
   * :doc:`smd/ulsph/num/neighs <compute_smd_ulsph_num_neighs>`
   * :doc:`smd/ulsph/strain <compute_smd_ulsph_strain>`
   * :doc:`smd/ulsph/strain/rate <compute_smd_ulsph_strain_rate>`
+1 −0
Original line number Diff line number Diff line
@@ -268,6 +268,7 @@ The individual style names on the :doc:`Commands compute <Commands_compute>` doc
* :doc:`smd/tlsph/strain/rate <compute_smd_tlsph_strain_rate>` -
* :doc:`smd/tlsph/stress <compute_smd_tlsph_stress>` - per-particle Cauchy stress tensor for SPH particles
* :doc:`smd/triangle/vertices <compute_smd_triangle_vertices>` -
* :doc:`smd/ulsph/effm <compute_smd_ulsph_effm>` - per-particle effective shear modulus
* :doc:`smd/ulsph/num/neighs <compute_smd_ulsph_num_neighs>` -
* :doc:`smd/ulsph/strain <compute_smd_ulsph_strain>` -
* :doc:`smd/ulsph/strain/rate <compute_smd_ulsph_strain_rate>` -
+56 −0
Original line number Diff line number Diff line
.. index:: compute smd/ulsph/effm

compute smd/ulsph/effm command
================================

Syntax
""""""

.. code-block:: LAMMPS

   compute ID group-ID smd/ulsph/effm

* ID, group-ID are documented in :doc:`compute <compute>` command
* smd/ulsph/effm = style name of this compute command

Examples
""""""""

.. code-block:: LAMMPS

   compute 1 all smd/ulsph/effm

Description
"""""""""""

Define a computation that outputs the effective shear modulus for
particles interacting via the updated Lagrangian SPH pair style.

See `this PDF guide <PDF/SMD_LAMMPS_userguide.pdf>`_ to using Smooth
Mach Dynamics in LAMMPS.

**Output info:**

This compute calculates a per-particle vector, which can be accessed
by any command that uses per-particle values from a compute as input.
See the :doc:`Howto output <Howto_output>` doc page for an overview of
LAMMPS output options.

The per-particle vector contains the current effective per atom shear
modulus as computed by the :doc:`pair smd/ulsph <pair_smd_ulsph>` pair
style.

Restrictions
""""""""""""

This compute is part of the USER-SMD package.  It is only enabled if
LAMMPS was built with that package. See the :doc:`Build package <Build_package>` doc page for more info. This compute can
only be used for particles which interact with the updated Lagrangian
SPH pair style.

Related commands
""""""""""""""""

:doc:`pair smd/ulsph <pair_smd_ulsph>`

**Default:** none