diff --git a/doc/compute_meso_e_atom.html b/doc/compute_meso_e_atom.html index 85c435232f..4d7859e58d 100644 --- a/doc/compute_meso_e_atom.html +++ b/doc/compute_meso_e_atom.html @@ -36,14 +36,18 @@ specified compute group.

Output info:

-

This compute calculates a per-atom vector, which can be accessed by -any command that uses per-atom values from a compute as input. See -this section for an overview of LAMMPS -output options. +

This compute calculates a scalar quantity for each atom, which can be +accessed by any command that uses per-atom values from a compute as +input. See this section for an overview of +LAMMPS output options.

The per-atom vector values will be in energy units.

-

Restrictions: none +

Restrictions: +

+

This compute is part of the USER-SPH package. It is only enabled if +LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

diff --git a/doc/compute_meso_e_atom.txt b/doc/compute_meso_e_atom.txt index e1ef49f22b..55d2d0d6c3 100644 --- a/doc/compute_meso_e_atom.txt +++ b/doc/compute_meso_e_atom.txt @@ -33,14 +33,18 @@ specified compute group. [Output info:] -This compute calculates a per-atom vector, which can be accessed by -any command that uses per-atom values from a compute as input. See -"this section"_Section_howto.html#4_15 for an overview of LAMMPS -output options. +This compute calculates a scalar quantity for each atom, which can be +accessed by any command that uses per-atom values from a compute as +input. See "this section"_Section_howto.html#4_15 for an overview of +LAMMPS output options. The per-atom vector values will be in energy "units"_units.html. -[Restrictions:] none +[Restrictions:] + +This compute is part of the USER-SPH package. It is only enabled if +LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] diff --git a/doc/compute_meso_rho_atom.html b/doc/compute_meso_rho_atom.html index 259664bc2f..202be3573c 100644 --- a/doc/compute_meso_rho_atom.html +++ b/doc/compute_meso_rho_atom.html @@ -28,8 +28,11 @@ for each atom in a group.

The mesoscopic density is the mass density of a mesoscopic particle, -calculated by kernel function interpolation using -"pair style sph/rhosum". +calculated by kernel function interpolation using "pair style +sph/rhosum". +

+

See this PDF guide to using SPH in +LAMMPS.

The value of the mesoscopic density will be 0.0 for atoms not in the specified compute group. @@ -41,9 +44,13 @@ any command that uses per-atom values from a compute as input. See this section for an overview of LAMMPS output options.

-

The per-atom vector values will be in mass / volume units. +

The per-atom vector values will be in mass/volume units.

-

Restrictions: none +

Restrictions: +

+

This compute is part of the USER-SPH package. It is only enabled if +LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

diff --git a/doc/compute_meso_rho_atom.txt b/doc/compute_meso_rho_atom.txt index 573566ff70..c09581864d 100644 --- a/doc/compute_meso_rho_atom.txt +++ b/doc/compute_meso_rho_atom.txt @@ -25,8 +25,11 @@ Define a computation that calculates the per-atom mesoscopic density for each atom in a group. The mesoscopic density is the mass density of a mesoscopic particle, -calculated by kernel function interpolation using -"pair style sph/rhosum". +calculated by kernel function interpolation using "pair style +sph/rhosum". + +See "this PDF guide"_USER/sph/SPH_LAMMPS_userguide.pdf to using SPH in +LAMMPS. The value of the mesoscopic density will be 0.0 for atoms not in the specified compute group. @@ -38,9 +41,13 @@ any command that uses per-atom values from a compute as input. See "this section"_Section_howto.html#4_15 for an overview of LAMMPS output options. -The per-atom vector values will be in mass / volume "units"_units.html. +The per-atom vector values will be in mass/volume "units"_units.html. -[Restrictions:] none +[Restrictions:] + +This compute is part of the USER-SPH package. It is only enabled if +LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] diff --git a/doc/compute_meso_t_atom.html b/doc/compute_meso_t_atom.html index 6d4b141d72..dc41ea8d3b 100644 --- a/doc/compute_meso_t_atom.html +++ b/doc/compute_meso_t_atom.html @@ -33,6 +33,9 @@ particles, e.g. a Smooth-Particle Hydrodynamics particle.

T_int = E_int / C_V, int

+

See this PDF guide to using SPH in +LAMMPS. +

The value of the internal energy will be 0.0 for atoms not in the specified compute group.

@@ -45,7 +48,11 @@ output options.

The per-atom vector values will be in temperature units.

-

Restrictions: none +

Restrictions: +

+

This compute is part of the USER-SPH package. It is only enabled if +LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

diff --git a/doc/compute_meso_t_atom.txt b/doc/compute_meso_t_atom.txt index 5b9110e24a..1d1a3a12ae 100644 --- a/doc/compute_meso_t_atom.txt +++ b/doc/compute_meso_t_atom.txt @@ -30,6 +30,9 @@ particles, e.g. a Smooth-Particle Hydrodynamics particle. T_{int} = E_{int} / C_{V, int} +See "this PDF guide"_USER/sph/SPH_LAMMPS_userguide.pdf to using SPH in +LAMMPS. + The value of the internal energy will be 0.0 for atoms not in the specified compute group. @@ -42,7 +45,11 @@ output options. The per-atom vector values will be in temperature "units"_units.html. -[Restrictions:] none +[Restrictions:] + +This compute is part of the USER-SPH package. It is only enabled if +LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] diff --git a/doc/fix_meso.html b/doc/fix_meso.html index 768ae4ac78..b3684d8720 100644 --- a/doc/fix_meso.html +++ b/doc/fix_meso.html @@ -25,8 +25,12 @@

Description:

Perform time integration to update position, velocity, internal energy -and local density for atoms in the group each timestep. This fix is needed to -time-integrate mesoscopic systems where particles carry internal variables such as SPH or DPDE. +and local density for atoms in the group each timestep. This fix is +needed to time-integrate mesoscopic systems where particles carry +internal variables such as SPH or DPDE. +

+

See this PDF guide to using SPH in +LAMMPS.

Restart, fix_modify, output, run start/stop, minimize info:

@@ -38,7 +42,11 @@ commands. No parameter of this fix can be used with the start/stop keywords of the run command. This fix is not invoked during energy minimization.

-

Restrictions: none +

Restrictions: +

+

This fix is part of the USER-SPH package. It is only enabled if +LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

diff --git a/doc/fix_meso.txt b/doc/fix_meso.txt index 19a1abf963..7c6a5cfc43 100644 --- a/doc/fix_meso.txt +++ b/doc/fix_meso.txt @@ -22,8 +22,12 @@ fix 1 all meso :pre [Description:] Perform time integration to update position, velocity, internal energy -and local density for atoms in the group each timestep. This fix is needed to -time-integrate mesoscopic systems where particles carry internal variables such as SPH or DPDE. +and local density for atoms in the group each timestep. This fix is +needed to time-integrate mesoscopic systems where particles carry +internal variables such as SPH or DPDE. + +See "this PDF guide"_USER/sph/SPH_LAMMPS_userguide.pdf to using SPH in +LAMMPS. [Restart, fix_modify, output, run start/stop, minimize info:] @@ -35,7 +39,11 @@ commands"_Section_howto.html#4_15. No parameter of this fix can be used with the {start/stop} keywords of the "run"_run.html command. This fix is not invoked during "energy minimization"_minimize.html. -[Restrictions:] none +[Restrictions:] + +This fix is part of the USER-SPH package. It is only enabled if +LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] diff --git a/doc/fix_meso_stationary.html b/doc/fix_meso_stationary.html index f586fdbf67..67a9a6a207 100644 --- a/doc/fix_meso_stationary.html +++ b/doc/fix_meso_stationary.html @@ -24,10 +24,14 @@

Description:

-

Perform time integration to update internal energy and local density, but not -position or velocity for atoms in the group each timestep. This fix is needed -for SPH simulations to correctly time-integrate fixed boundary particles which -constrain a fluid to a given region in space. +

Perform time integration to update internal energy and local density, +but not position or velocity for atoms in the group each timestep. +This fix is needed for SPH simulations to correctly time-integrate +fixed boundary particles which constrain a fluid to a given region in +space. +

+

See this PDF guide to using SPH in +LAMMPS.

Restart, fix_modify, output, run start/stop, minimize info:

@@ -39,7 +43,11 @@ commands. No parameter of this fix can be used with the start/stop keywords of the run command. This fix is not invoked during energy minimization.

-

Restrictions: none +

Restrictions: +

+

This fix is part of the USER-SPH package. It is only enabled if +LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

diff --git a/doc/fix_meso_stationary.txt b/doc/fix_meso_stationary.txt index be3152dc14..31bdb4b1f3 100644 --- a/doc/fix_meso_stationary.txt +++ b/doc/fix_meso_stationary.txt @@ -21,10 +21,14 @@ fix 1 boundary meso/stationary :pre [Description:] -Perform time integration to update internal energy and local density, but not -position or velocity for atoms in the group each timestep. This fix is needed -for SPH simulations to correctly time-integrate fixed boundary particles which -constrain a fluid to a given region in space. +Perform time integration to update internal energy and local density, +but not position or velocity for atoms in the group each timestep. +This fix is needed for SPH simulations to correctly time-integrate +fixed boundary particles which constrain a fluid to a given region in +space. + +See "this PDF guide"_USER/sph/SPH_LAMMPS_userguide.pdf to using SPH in +LAMMPS. [Restart, fix_modify, output, run start/stop, minimize info:] @@ -36,7 +40,11 @@ commands"_Section_howto.html#4_15. No parameter of this fix can be used with the {start/stop} keywords of the "run"_run.html command. This fix is not invoked during "energy minimization"_minimize.html. -[Restrictions:] none +[Restrictions:] + +This fix is part of the USER-SPH package. It is only enabled if +LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] diff --git a/doc/pair_meam.html b/doc/pair_meam.html index f0dd319464..8d5868201c 100644 --- a/doc/pair_meam.html +++ b/doc/pair_meam.html @@ -373,7 +373,7 @@ This report may be accessed on-line via -

(ZBL) J.F. Ziegler, J.P. Biersack, U. Littmark, 'Stopping and Ranges -of Ions in Matter' Vol 1, 1985, Pergamon Press. +

(ZBL) J.F. Ziegler, J.P. Biersack, U. Littmark, "Stopping and Ranges +of Ions in Matter", Vol 1, 1985, Pergamon Press.

diff --git a/doc/pair_meam.txt b/doc/pair_meam.txt index ed2ad404d4..b787345ae5 100644 --- a/doc/pair_meam.txt +++ b/doc/pair_meam.txt @@ -363,6 +363,5 @@ This report may be accessed on-line via "this link"_sandreport. [(Wang)] Wang, Van Hove, Ross, Baskes, J. Chem. Phys., 121, 5410 (2004). :link(ZBL) -[(ZBL)] J.F. Ziegler, J.P. Biersack, U. Littmark, 'Stopping and Ranges -of Ions in Matter' Vol 1, 1985, Pergamon Press. - +[(ZBL)] J.F. Ziegler, J.P. Biersack, U. Littmark, "Stopping and Ranges +of Ions in Matter", Vol 1, 1985, Pergamon Press. diff --git a/doc/pair_sph_heatconduction.html b/doc/pair_sph_heatconduction.html index 1c45874a89..570a324b87 100644 --- a/doc/pair_sph_heatconduction.html +++ b/doc/pair_sph_heatconduction.html @@ -17,42 +17,47 @@

Examples:

-

pair_style sph/heatconduction -pair_coeff * * 1.0 2.4 -

+
pair_style sph/heatconduction
+pair_coeff * * 1.0 2.4 
+

Description:

The sph/heatconduction style computes heat transport between SPH particles. The transport model is the diffusion euqation for the internal energy.

+

See this PDF guide to using SPH in +LAMMPS. +

The following coefficients must be defined for each pair of atoms types via the pair_coeff command as in the examples above.

-

D diffusion coefficient (length^2/time units) -h kernel function cutoff (distance units) -

+

Mixing, shift, table, tail correction, restart, rRESPA info:

-

These pair styles do not support mixing. Thus, coefficients for all +

This style does not support mixing. Thus, coefficients for all I,J pairs must be specified explicitly.

-

This style does not write information to binary restart -files, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +

This style does not support the pair_modify +shift, table, and tail options.

-

These styles can only be used via the pair keyword of the run_style -respa command. They do not support the inner, +

This style does not write information to binary restart +files. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file. +

+

This style can only be used via the pair keyword of the run_style +respa command. It does not support the inner, middle, outer keywords.

Restrictions:

-

The pair sph/heatconduction style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the Making LAMMPS section for -more info. +

This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

diff --git a/doc/pair_sph_heatconduction.txt b/doc/pair_sph_heatconduction.txt index 3f2c2a93dd..d25debe91b 100644 --- a/doc/pair_sph_heatconduction.txt +++ b/doc/pair_sph_heatconduction.txt @@ -15,45 +15,49 @@ pair_style sph/heatconduction :pre [Examples:] pair_style sph/heatconduction -pair_coeff * * 1.0 2.4 +pair_coeff * * 1.0 2.4 :pre [Description:] The sph/heatconduction style computes heat transport between SPH particles. The transport model is the diffusion euqation for the internal energy. +See "this PDF guide"_USER/sph/SPH_LAMMPS_userguide.pdf to using SPH in +LAMMPS. + The following coefficients must be defined for each pair of atoms types via the "pair_coeff"_pair_coeff.html command as in the examples above. D diffusion coefficient (length^2/time units) -h kernel function cutoff (distance units) +h kernel function cutoff (distance units) :ul :line [Mixing, shift, table, tail correction, restart, rRESPA info]: -These pair styles do not support mixing. Thus, coefficients for all +This style does not support mixing. Thus, coefficients for all I,J pairs must be specified explicitly. -This style does not write information to "binary restart -files"_restart.html, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +This style does not support the "pair_modify"_pair_modify.html +shift, table, and tail options. -These styles can only be used via the {pair} keyword of the "run_style -respa"_run_style.html command. They do not support the {inner}, +This style does not write information to "binary restart +files"_restart.html. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file. + +This style can only be used via the {pair} keyword of the "run_style +respa"_run_style.html command. It does not support the {inner}, {middle}, {outer} keywords. [Restrictions:] -The {pair sph/heatconduction} style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the "Making LAMMPS"_Section_start.html#2_3 section for -more info. +This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] "pair_coeff"_pair_coeff.html, pair_sph/rhosum [Default:] none - diff --git a/doc/pair_sph_idealgas.html b/doc/pair_sph_idealgas.html index 2c8b917b63..8d5ac22a2d 100644 --- a/doc/pair_sph_idealgas.html +++ b/doc/pair_sph_idealgas.html @@ -17,45 +17,56 @@

Examples:

-

pair_style sph/idealgas -pair_coeff * * 1.0 2.4 -

+
pair_style sph/idealgas
+pair_coeff * * 1.0 2.4 
+

Description:

-

The sph/idealgas style computes pressure forces between particles according to the ideal gas equation of state, -\beginequation +

The sph/idealgas style computes pressure forces between particles +according to the ideal gas equation of state: +

+

\beginequation p = (\gamma - 1) \rho e, \endequation -where $\gamma=1.4$ is the heat capacity ratio, $\rho$ is the local density, and $e$ is the internal energy per unit mass. This pair style also computes Monaghan's artificial viscosity to prevent particles from interpentrating (Monaghan1983). +

+

where gamma = 1.4 is the heat capacity ratio, rho is the local +density, and e is the internal energy per unit mass. This pair style +also computes Monaghan's artificial viscosity to prevent particles +from interpentrating (Monaghan). +

+

See this PDF guide to using SPH in +LAMMPS.

The following coefficients must be defined for each pair of atoms types via the pair_coeff command as in the examples above.

-

nu artificial viscosity (no units) -h kernel function cutoff (distance units) -

+

Mixing, shift, table, tail correction, restart, rRESPA info:

-

These pair styles do not support mixing. Thus, coefficients for all +

This style does not support mixing. Thus, coefficients for all I,J pairs must be specified explicitly.

-

This style does not write information to binary restart -files, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +

This style does not support the pair_modify +shift, table, and tail options.

-

These styles can only be used via the pair keyword of the run_style -respa command. They do not support the inner, +

This style does not write information to binary restart +files. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file. +

+

This style can only be used via the pair keyword of the run_style +respa command. It does not support the inner, middle, outer keywords.

Restrictions:

-

The pair sph/idealgas style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the Making LAMMPS section for -more info. +

This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

@@ -63,6 +74,11 @@ more info.

Default: none

-

(Monaghan1983) J. J. Monaghan and R. A. Gingold, “Shock simulation by the particle method SPH,” Journal of Computational Physics, vol. 52, no. 2, pp. 374-389, Nov. 1983. +


+ + + +

(Monaghan) Monaghan and Gingold, Journal of Computational Physics, +52, 374-389 (1983).

diff --git a/doc/pair_sph_idealgas.txt b/doc/pair_sph_idealgas.txt index 309b8f8a1a..ad8ef6a0c8 100644 --- a/doc/pair_sph_idealgas.txt +++ b/doc/pair_sph_idealgas.txt @@ -15,45 +15,55 @@ pair_style sph/idealgas :pre [Examples:] pair_style sph/idealgas -pair_coeff * * 1.0 2.4 +pair_coeff * * 1.0 2.4 :pre [Description:] -The sph/idealgas style computes pressure forces between particles according to the ideal gas equation of state, +The sph/idealgas style computes pressure forces between particles +according to the ideal gas equation of state: + \begin{equation} p = (\gamma - 1) \rho e, \end{equation} -where $\gamma=1.4$ is the heat capacity ratio, $\rho$ is the local density, and $e$ is the internal energy per unit mass. This pair style also computes Monaghan's artificial viscosity to prevent particles from interpentrating (Monaghan1983). +where gamma = 1.4 is the heat capacity ratio, rho is the local +density, and e is the internal energy per unit mass. This pair style +also computes Monaghan's artificial viscosity to prevent particles +from interpentrating "(Monaghan)"_#Monoghan. + +See "this PDF guide"_USER/sph/SPH_LAMMPS_userguide.pdf to using SPH in +LAMMPS. The following coefficients must be defined for each pair of atoms types via the "pair_coeff"_pair_coeff.html command as in the examples above. nu artificial viscosity (no units) -h kernel function cutoff (distance units) +h kernel function cutoff (distance units) :ul :line [Mixing, shift, table, tail correction, restart, rRESPA info]: -These pair styles do not support mixing. Thus, coefficients for all +This style does not support mixing. Thus, coefficients for all I,J pairs must be specified explicitly. -This style does not write information to "binary restart -files"_restart.html, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +This style does not support the "pair_modify"_pair_modify.html +shift, table, and tail options. -These styles can only be used via the {pair} keyword of the "run_style -respa"_run_style.html command. They do not support the {inner}, +This style does not write information to "binary restart +files"_restart.html. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file. + +This style can only be used via the {pair} keyword of the "run_style +respa"_run_style.html command. It does not support the {inner}, {middle}, {outer} keywords. [Restrictions:] -The {pair sph/idealgas} style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the "Making LAMMPS"_Section_start.html#2_3 section for -more info. +This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] @@ -61,5 +71,9 @@ more info. [Default:] none -[(Monaghan1983)] J. J. Monaghan and R. A. Gingold, “Shock simulation by the particle method SPH,” Journal of Computational Physics, vol. 52, no. 2, pp. 374-389, Nov. 1983. +:line + +:link(Monoghan) +[(Monaghan)] Monaghan and Gingold, Journal of Computational Physics, +52, 374-389 (1983). diff --git a/doc/pair_sph_lj.html b/doc/pair_sph_lj.html index 836cdaefce..60cbdc67c8 100644 --- a/doc/pair_sph_lj.html +++ b/doc/pair_sph_lj.html @@ -17,46 +17,54 @@

Examples:

-

pair_style sph/lj -pair_coeff * * 1.0 2.4 -

+
pair_style sph/lj
+pair_coeff * * 1.0 2.4 
+

Description:

-

The sph/lj style computes pressure forces between particles according to -the Lennard-Jones equation of state, which is computed according to -Ree's 1980 polynomial fit (Ree1980). The Lennard-Jones parameters -$\epsilon$ and $\sigma$ are set to unity. This pair style also computes +

The sph/lj style computes pressure forces between particles according +to the Lennard-Jones equation of state, which is computed according to +Ree's 1980 polynomial fit (Ree). The Lennard-Jones parameters +epsilon and sigma are set to unity. This pair style also computes Monaghan's artificial viscosity to prevent particles from -interpentrating (Monaghan1983). +interpentrating (Monaghan). +

+

See this PDF guide to using SPH in +LAMMPS.

The following coefficients must be defined for each pair of atoms types via the pair_coeff command as in the examples above.

-

nu artificial viscosity (no units) -h kernel function cutoff (distance units) -

+

Mixing, shift, table, tail correction, restart, rRESPA info:

-

These pair styles do not support mixing. Thus, coefficients for all +

This style does not support mixing. Thus, coefficients for all I,J pairs must be specified explicitly.

-

This style does not write information to binary restart -files, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +

This style does not support the pair_modify +shift, table, and tail options.

-

These styles can only be used via the pair keyword of the run_style -respa command. They do not support the inner, +

This style does not write information to binary restart +files. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file. +

+

This style can only be used via the pair keyword of the run_style +respa command. It does not support the inner, middle, outer keywords.

Restrictions: -The Lennard-Jones parameters $\epsilon$ and $\sigma$ are set to unity. -The pair sph/lj style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the Making LAMMPS section for -more info. +

+

As noted above, the Lennard-Jones parameters epsilon and sigma are set +to unity. +

+

This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

@@ -64,9 +72,15 @@ more info.

Default: none

-

(Ree1980) F. H. Ree. Analytic representation of thermodynamic data for the Lennard-Jones fluid. -The Journal of Chemical Physics, 73(10):5401, 1980. +


+ + + +

(Ree) Ree, Journal of Chemical Physics, 73, 5401 (1980).

-

(Monaghan1983) J. J. Monaghan and R. A. Gingold, “Shock simulation by the particle method SPH,” Journal of Computational Physics, vol. 52, no. 2, pp. 374-389, Nov. 1983. + + +

(Monaghan) Monaghan and Gingold, Journal of Computational Physics, +52, 374-389 (1983).

diff --git a/doc/pair_sph_lj.txt b/doc/pair_sph_lj.txt index d5fde5843c..8498841131 100644 --- a/doc/pair_sph_lj.txt +++ b/doc/pair_sph_lj.txt @@ -15,46 +15,53 @@ pair_style sph/lj :pre [Examples:] pair_style sph/lj -pair_coeff * * 1.0 2.4 +pair_coeff * * 1.0 2.4 :pre [Description:] -The sph/lj style computes pressure forces between particles according to -the Lennard-Jones equation of state, which is computed according to -Ree's 1980 polynomial fit (Ree1980). The Lennard-Jones parameters -$\epsilon$ and $\sigma$ are set to unity. This pair style also computes +The sph/lj style computes pressure forces between particles according +to the Lennard-Jones equation of state, which is computed according to +Ree's 1980 polynomial fit "(Ree)"_#Ree. The Lennard-Jones parameters +epsilon and sigma are set to unity. This pair style also computes Monaghan's artificial viscosity to prevent particles from -interpentrating (Monaghan1983). +interpentrating "(Monaghan)"_#Monoghan. +See "this PDF guide"_USER/sph/SPH_LAMMPS_userguide.pdf to using SPH in +LAMMPS. The following coefficients must be defined for each pair of atoms types via the "pair_coeff"_pair_coeff.html command as in the examples above. nu artificial viscosity (no units) -h kernel function cutoff (distance units) +h kernel function cutoff (distance units) :ul :line [Mixing, shift, table, tail correction, restart, rRESPA info]: -These pair styles do not support mixing. Thus, coefficients for all +This style does not support mixing. Thus, coefficients for all I,J pairs must be specified explicitly. -This style does not write information to "binary restart -files"_restart.html, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +This style does not support the "pair_modify"_pair_modify.html +shift, table, and tail options. -These styles can only be used via the {pair} keyword of the "run_style -respa"_run_style.html command. They do not support the {inner}, +This style does not write information to "binary restart +files"_restart.html. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file. + +This style can only be used via the {pair} keyword of the "run_style +respa"_run_style.html command. It does not support the {inner}, {middle}, {outer} keywords. [Restrictions:] -The Lennard-Jones parameters $\epsilon$ and $\sigma$ are set to unity. -The {pair sph/lj} style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the "Making LAMMPS"_Section_start.html#2_3 section for -more info. + +As noted above, the Lennard-Jones parameters epsilon and sigma are set +to unity. + +This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] @@ -62,9 +69,11 @@ more info. [Default:] none -[(Ree1980)] F. H. Ree. Analytic representation of thermodynamic data for the Lennard-Jones fluid. -The Journal of Chemical Physics, 73(10):5401, 1980. - -[(Monaghan1983)] J. J. Monaghan and R. A. Gingold, “Shock simulation by the particle method SPH,” Journal of Computational Physics, vol. 52, no. 2, pp. 374-389, Nov. 1983. +:line +:link(Ree) +[(Ree)] Ree, Journal of Chemical Physics, 73, 5401 (1980). +:link(Monoghan) +[(Monaghan)] Monaghan and Gingold, Journal of Computational Physics, +52, 374-389 (1983). diff --git a/doc/pair_sph_rhosum.html b/doc/pair_sph_rhosum.html index 1a46024aab..7e3f38a91a 100644 --- a/doc/pair_sph_rhosum.html +++ b/doc/pair_sph_rhosum.html @@ -13,47 +13,52 @@

Syntax:

-
pair_style sph/rhosum nstep 
+
pair_style sph/rhosum Nstep 
 
-

nstep = timestep interval -

+

Examples:

-

pair_style sph/rhosum 10 -pair_coeff * * 2.4 -

+
pair_style sph/rhosum 10
+pair_coeff * * 2.4 
+

Description:

-

The sph/rhosum style computes the local particle mass density rho by kernel function interpolation, -see the SPH-USER documentation. +

The sph/rhosum style computes the local particle mass density rho for +SPH particles by kernel function interpolation, every Nstep timesteps. +

+

See this PDF guide to using SPH in +LAMMPS.

The following coefficients must be defined for each pair of atoms types via the pair_coeff command as in the examples above.

-

h (distance units) -

+

Mixing, shift, table, tail correction, restart, rRESPA info:

-

These pair styles do not support mixing. Thus, coefficients for all +

This style does not support mixing. Thus, coefficients for all I,J pairs must be specified explicitly.

-

This style does not write information to binary restart -files, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +

This style does not support the pair_modify +shift, table, and tail options.

-

These styles can only be used via the pair keyword of the run_style -respa command. They do not support the inner, +

This style does not write information to binary restart +files. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file. +

+

This style can only be used via the pair keyword of the run_style +respa command. It does not support the inner, middle, outer keywords.

Restrictions:

-

The pair sph/rhosum style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the Making LAMMPS section for -more info. +

This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

diff --git a/doc/pair_sph_rhosum.txt b/doc/pair_sph_rhosum.txt index 8824f89925..352e717f76 100644 --- a/doc/pair_sph_rhosum.txt +++ b/doc/pair_sph_rhosum.txt @@ -10,47 +10,52 @@ pair_style sph/rhosum command :h3 [Syntax:] -pair_style sph/rhosum nstep :pre +pair_style sph/rhosum Nstep :pre -nstep = timestep interval +Nstep = timestep interval :ul [Examples:] pair_style sph/rhosum 10 -pair_coeff * * 2.4 +pair_coeff * * 2.4 :pre [Description:] -The sph/rhosum style computes the local particle mass density rho by kernel function interpolation, -see the SPH-USER documentation. +The sph/rhosum style computes the local particle mass density rho for +SPH particles by kernel function interpolation, every Nstep timesteps. + +See "this PDF guide"_USER/sph/SPH_LAMMPS_userguide.pdf to using SPH in +LAMMPS. The following coefficients must be defined for each pair of atoms types via the "pair_coeff"_pair_coeff.html command as in the examples above. -h (distance units) +h (distance units) :ul :line [Mixing, shift, table, tail correction, restart, rRESPA info]: -These pair styles do not support mixing. Thus, coefficients for all +This style does not support mixing. Thus, coefficients for all I,J pairs must be specified explicitly. -This style does not write information to "binary restart -files"_restart.html, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +This style does not support the "pair_modify"_pair_modify.html +shift, table, and tail options. -These styles can only be used via the {pair} keyword of the "run_style -respa"_run_style.html command. They do not support the {inner}, +This style does not write information to "binary restart +files"_restart.html. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file. + +This style can only be used via the {pair} keyword of the "run_style +respa"_run_style.html command. It does not support the {inner}, {middle}, {outer} keywords. [Restrictions:] -The {pair sph/rhosum} style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the "Making LAMMPS"_Section_start.html#2_3 section for -more info. +This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] diff --git a/doc/pair_sph_taitwater.html b/doc/pair_sph_taitwater.html index d2bc4c54a4..1d43a15374 100644 --- a/doc/pair_sph_taitwater.html +++ b/doc/pair_sph_taitwater.html @@ -17,49 +17,59 @@

Examples:

-

pair_style sph/taitwater -pair_coeff * * 1000.0 1430.0 1.0 2.4 -

+
pair_style sph/taitwater
+pair_coeff * * 1000.0 1430.0 1.0 2.4 
+

Description:

-

The sph/taitwater style computes pressure forces between particles according to Tait's equation of state, -\beginequation +

The sph/taitwater style computes pressure forces between SPH particles +according to Tait's equation of state: +

+

\beginequation p = B (\frac\rho\rho_0)^\gamma - 1, \endequation -where $\gamma=7$ and $B=c_0^2 \rho_0 / \gamma$, with $\rho_0$ being the reference density and $c_0$ the reference speed of sound. -This pair style also computes Monaghan's artificial viscosity to prevent particles from interpentrating (Monaghan1983). +

+

where gamma = 7 and B = c_0^2 rho_0 / gamma, with rho_0 being the +reference density and c_0 the reference speed of sound. +

+

This pair style also computes Monaghan's artificial viscosity to +prevent particles from interpentrating (Monaghan). +

+

See this PDF guide to using SPH in +LAMMPS.

The following coefficients must be defined for each pair of atoms types via the pair_coeff command as in the examples above.

-

rho0 reference density (mass/volume units) -c0 reference soundspeed (distance/time units) -nu artificial viscosity (no units) -h kernel function cutoff (distance units) -

+

Mixing, shift, table, tail correction, restart, rRESPA info:

-

These pair styles do not support mixing. Thus, coefficients for all -I,J pairs must be specified explicitly. Additionally, because rho0 and c0 are defined on a per-type basis, -an I,I as well a J,J coefficients line must be specified prior to specifying an I,J interaction. +

This style does not support mixing. Thus, coefficients for all +I,J pairs must be specified explicitly. +

+

This style does not support the pair_modify +shift, table, and tail options.

This style does not write information to binary restart -files, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +files. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file.

-

These styles can only be used via the pair keyword of the run_style -respa command. They do not support the inner, +

This style can only be used via the pair keyword of the run_style +respa command. It does not support the inner, middle, outer keywords.

Restrictions:

-

The pair sph/taitwater style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the Making LAMMPS section for -more info. +

This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

@@ -67,6 +77,11 @@ more info.

Default: none

-

(Monaghan1983) J. J. Monaghan and R. A. Gingold, “Shock simulation by the particle method SPH,” Journal of Computational Physics, vol. 52, no. 2, pp. 374-389, Nov. 1983. +


+ + + +

(Monaghan) Monaghan and Gingold, Journal of Computational Physics, +52, 374-389 (1983).

diff --git a/doc/pair_sph_taitwater.txt b/doc/pair_sph_taitwater.txt index b064bb77ff..bb00aeffb1 100644 --- a/doc/pair_sph_taitwater.txt +++ b/doc/pair_sph_taitwater.txt @@ -15,17 +15,25 @@ pair_style sph/taitwater :pre [Examples:] pair_style sph/taitwater -pair_coeff * * 1000.0 1430.0 1.0 2.4 +pair_coeff * * 1000.0 1430.0 1.0 2.4 :pre [Description:] -The sph/taitwater style computes pressure forces between particles according to Tait's equation of state, +The sph/taitwater style computes pressure forces between SPH particles +according to Tait's equation of state: + \begin{equation} p = B [(\frac{\rho}{\rho_0})^{\gamma} - 1], \end{equation} -where $\gamma=7$ and $B=c_0^2 \rho_0 / \gamma$, with $\rho_0$ being the reference density and $c_0$ the reference speed of sound. -This pair style also computes Monaghan's artificial viscosity to prevent particles from interpentrating (Monaghan1983). +where gamma = 7 and B = c_0^2 rho_0 / gamma, with rho_0 being the +reference density and c_0 the reference speed of sound. + +This pair style also computes Monaghan's artificial viscosity to +prevent particles from interpentrating "(Monaghan)"_#Monaghan. + +See "this PDF guide"_USER/sph/SPH_LAMMPS_userguide.pdf to using SPH in +LAMMPS. The following coefficients must be defined for each pair of atoms types via the "pair_coeff"_pair_coeff.html command as in the examples @@ -34,30 +42,31 @@ above. rho0 reference density (mass/volume units) c0 reference soundspeed (distance/time units) nu artificial viscosity (no units) -h kernel function cutoff (distance units) +h kernel function cutoff (distance units) :ul :line [Mixing, shift, table, tail correction, restart, rRESPA info]: -These pair styles do not support mixing. Thus, coefficients for all -I,J pairs must be specified explicitly. Additionally, because rho0 and c0 are defined on a per-type basis, -an I,I as well a J,J coefficients line must be specified prior to specifying an I,J interaction. +This style does not support mixing. Thus, coefficients for all +I,J pairs must be specified explicitly. + +This style does not support the "pair_modify"_pair_modify.html +shift, table, and tail options. This style does not write information to "binary restart -files"_restart.html, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +files"_restart.html. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file. -These styles can only be used via the {pair} keyword of the "run_style -respa"_run_style.html command. They do not support the {inner}, +This style can only be used via the {pair} keyword of the "run_style +respa"_run_style.html command. It does not support the {inner}, {middle}, {outer} keywords. [Restrictions:] -The {pair sph/taitwater} style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the "Making LAMMPS"_Section_start.html#2_3 section for -more info. +This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] @@ -65,5 +74,8 @@ more info. [Default:] none -[(Monaghan1983)] J. J. Monaghan and R. A. Gingold, “Shock simulation by the particle method SPH,” Journal of Computational Physics, vol. 52, no. 2, pp. 374-389, Nov. 1983. +:line +:link(Monoghan) +[(Monaghan)] Monaghan and Gingold, Journal of Computational Physics, +52, 374-389 (1983). diff --git a/doc/pair_sph_taitwater_morris.html b/doc/pair_sph_taitwater_morris.html index 9eabe44b42..94b95fa71c 100644 --- a/doc/pair_sph_taitwater_morris.html +++ b/doc/pair_sph_taitwater_morris.html @@ -17,49 +17,58 @@

Examples:

-

pair_style sph/taitwater/morris -pair_coeff * * 1000.0 1430.0 1.0 2.4 -

+
pair_style sph/taitwater/morris
+pair_coeff * * 1000.0 1430.0 1.0 2.4 
+

Description:

-

The sph/taitwater/morris style computes pressure forces between particles according to Tait's equation of state, -\beginequation +

The sph/taitwater/morris style computes pressure forces between SPH +particles according to Tait's equation of state: +

+

\beginequation p = B (\frac\rho\rho_0)^\gamma - 1, \endequation -where $\gamma=7$ and $B=c_0^2 \rho_0 / \gamma$, with $\rho_0$ being the reference density and $c_0$ the reference speed of sound. -This pair style also computes laminar viscosity (Morris1997). +

+

where gamma = 7 and B = c_0^2 rho_0 / gamma, with rho_0 being the +reference density and c_0 the reference speed of sound. +

+

This pair style also computes laminar viscosity (Morris). +

+

See this PDF guide to using SPH in +LAMMPS.

The following coefficients must be defined for each pair of atoms types via the pair_coeff command as in the examples above.

-

rho0 reference density (mass/volume units) -c0 reference soundspeed (distance/time units) -nu dynamic viscosity (mass*distance/time units) -h kernel function cutoff (distance units) -

+

Mixing, shift, table, tail correction, restart, rRESPA info:

-

These pair styles do not support mixing. Thus, coefficients for all -I,J pairs must be specified explicitly. Additionally, because rho0 and c0 are defined on a per-type basis, -an I,I as well a J,J coefficients line must be specified prior to specifying an I,J interaction. +

This style does not support mixing. Thus, coefficients for all +I,J pairs must be specified explicitly. +

+

This style does not support the pair_modify +shift, table, and tail options.

This style does not write information to binary restart -files, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +files. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file.

-

These styles can only be used via the pair keyword of the run_style -respa command. They do not support the inner, +

This style can only be used via the pair keyword of the run_style +respa command. It does not support the inner, middle, outer keywords.

Restrictions:

-

The pair sph/taitwater/morris style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the Making LAMMPS section for -more info. +

This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the Making +LAMMPS section for more info.

Related commands:

@@ -67,6 +76,10 @@ more info.

Default: none

-

(Morris1997) J.P. Morris, P.J. Fox, and Y. Zhu. Modeling Low Reynolds Number Incompressible Flows Using SPH. Journal of Computational Physics, 136:214–226, 1997. +


+ + + +

(Morris) Morris, Fox, Zhu, J Comp Physics, 136, 214–226 (1997).

diff --git a/doc/pair_sph_taitwater_morris.txt b/doc/pair_sph_taitwater_morris.txt index df07fd9650..836440915f 100644 --- a/doc/pair_sph_taitwater_morris.txt +++ b/doc/pair_sph_taitwater_morris.txt @@ -15,17 +15,24 @@ pair_style sph/taitwater/morris :pre [Examples:] pair_style sph/taitwater/morris -pair_coeff * * 1000.0 1430.0 1.0 2.4 +pair_coeff * * 1000.0 1430.0 1.0 2.4 :pre [Description:] -The sph/taitwater/morris style computes pressure forces between particles according to Tait's equation of state, +The sph/taitwater/morris style computes pressure forces between SPH +particles according to Tait's equation of state: + \begin{equation} p = B [(\frac{\rho}{\rho_0})^{\gamma} - 1], \end{equation} -where $\gamma=7$ and $B=c_0^2 \rho_0 / \gamma$, with $\rho_0$ being the reference density and $c_0$ the reference speed of sound. -This pair style also computes laminar viscosity (Morris1997). +where gamma = 7 and B = c_0^2 rho_0 / gamma, with rho_0 being the +reference density and c_0 the reference speed of sound. + +This pair style also computes laminar viscosity "(Morris)"_#Morris. + +See "this PDF guide"_USER/sph/SPH_LAMMPS_userguide.pdf to using SPH in +LAMMPS. The following coefficients must be defined for each pair of atoms types via the "pair_coeff"_pair_coeff.html command as in the examples @@ -34,30 +41,31 @@ above. rho0 reference density (mass/volume units) c0 reference soundspeed (distance/time units) nu dynamic viscosity (mass*distance/time units) -h kernel function cutoff (distance units) +h kernel function cutoff (distance units) :ul :line [Mixing, shift, table, tail correction, restart, rRESPA info]: -These pair styles do not support mixing. Thus, coefficients for all -I,J pairs must be specified explicitly. Additionally, because rho0 and c0 are defined on a per-type basis, -an I,I as well a J,J coefficients line must be specified prior to specifying an I,J interaction. +This style does not support mixing. Thus, coefficients for all +I,J pairs must be specified explicitly. + +This style does not support the "pair_modify"_pair_modify.html +shift, table, and tail options. This style does not write information to "binary restart -files"_restart.html, so pair_style and pair_coeff commands do need -to be specified in an input script that reads a restart file. +files"_restart.html. Thus, you need to re-specify the pair_style and +pair_coeff commands in an input script that reads a restart file. -These styles can only be used via the {pair} keyword of the "run_style -respa"_run_style.html command. They do not support the {inner}, +This style can only be used via the {pair} keyword of the "run_style +respa"_run_style.html command. It does not support the {inner}, {middle}, {outer} keywords. [Restrictions:] -The {pair sph/taitwater/morris} style is part of the "USER-SPH" package. It is -only enabled if LAMMPS was built with that package (which it is by -default). See the "Making LAMMPS"_Section_start.html#2_3 section for -more info. +This pair style is part of the USER-SPH package. It is only enabled +if LAMMPS was built with that package. See the "Making +LAMMPS"_Section_start.html#start_3 section for more info. [Related commands:] @@ -65,6 +73,9 @@ more info. [Default:] none -[(Morris1997)] J.P. Morris, P.J. Fox, and Y. Zhu. Modeling Low Reynolds Number Incompressible Flows Using SPH. Journal of Computational Physics, 136:214–226, 1997. +:line + +:link(Morris) +[(Morris)] Morris, Fox, Zhu, J Comp Physics, 136, 214–226 (1997).