forked from lijiext/lammps
Merge pull request #1222 from lammps/doc-adjust3
Some adjustments to the documentation for the per style listing pages
This commit is contained in:
commit
6745c37741
|
@ -354,29 +354,31 @@ the LAMMPS simulation domain.
|
|||
|
||||
:line
|
||||
|
||||
[-restart2data restartfile (remap) datafile keyword value ...] :link(restart2data)
|
||||
[-restart2data restartfile \[remap\] datafile keyword value ...]
|
||||
:link(restart2data)
|
||||
|
||||
Convert the restart file into a data file and immediately exit. This
|
||||
is the same operation as if the following 2-line input script were
|
||||
run:
|
||||
|
||||
read_restart restartfile (remap)
|
||||
read_restart restartfile \[remap\]
|
||||
write_data datafile keyword value ... :pre
|
||||
|
||||
Note that the specified restartfile and/or datafile can have the
|
||||
wild-card character "*". The restartfile can also have the wild-card
|
||||
The specified restartfile and/or datafile name may contain the wild-card
|
||||
character "*". The restartfile name may also contain the wild-card
|
||||
character "%". The meaning of these characters is explained on the
|
||||
"read_restart"_read_restart.html and "write_data"_write_data.html doc
|
||||
pages. The use of "%" means that a parallel restart file can be read.
|
||||
Note that a filename such as file.* will need to be enclosed in quotes
|
||||
to avoid shell expansion of the "*" character.
|
||||
Note that a filename such as file.* may need to be enclosed in quotes or
|
||||
the "*" character prefixed with a backslash ("\") to avoid shell
|
||||
expansion of the "*" character.
|
||||
|
||||
Note that following restartfile, the optional word "remap" can be
|
||||
used. This has the effect of adding it to the
|
||||
"read_restart"_read_restart.html command, as explained on its doc
|
||||
page. This is useful if reading the restart file triggers an error
|
||||
that atoms have been lost. In that case, use of the remap flag should
|
||||
allow the data file to still be produced.
|
||||
Following restartfile argument, the optional word "remap" may be used.
|
||||
This has the same effect like adding it to a
|
||||
"read_restart"_read_restart.html command, and operates as explained on
|
||||
its doc page. This is useful if reading the restart file triggers an
|
||||
error that atoms have been lost. In that case, use of the remap flag
|
||||
should allow the data file to still be produced.
|
||||
|
||||
The syntax following restartfile (or remap), namely
|
||||
|
||||
|
@ -388,29 +390,30 @@ optional keyword/value settings.
|
|||
|
||||
:line
|
||||
|
||||
[-restart2dump restartfile {remap} group-ID dumpstyle dumpfile arg1 arg2 ...] :link(restart2dump)
|
||||
[-restart2dump restartfile \[remap\] group-ID dumpstyle dumpfile arg1 arg2 ...] :link(restart2dump)
|
||||
|
||||
Convert the restart file into a dump file and immediately exit. This
|
||||
is the same operation as if the following 2-line input script were
|
||||
run:
|
||||
|
||||
read_restart restartfile (remap)
|
||||
read_restart restartfile \[remap\]
|
||||
write_dump group-ID dumpstyle dumpfile arg1 arg2 ... :pre
|
||||
|
||||
Note that the specified restartfile and dumpfile can have wild-card
|
||||
characters ("*","%") as explained on the
|
||||
Note that the specified restartfile and dumpfile names may contain
|
||||
wild-card characters ("*","%") as explained on the
|
||||
"read_restart"_read_restart.html and "write_dump"_write_dump.html doc
|
||||
pages. The use of "%" means that a parallel restart file and/or
|
||||
parallel dump file can be read and/or written. Note that a filename
|
||||
such as file.* will need to be enclosed in quotes to avoid shell
|
||||
expansion of the "*" character.
|
||||
such as file.* may need to be enclosed in quotes or the "*" character
|
||||
prefixed with a backslash ("\") to avoid shell expansion of the "*"
|
||||
character.
|
||||
|
||||
Note that following restartfile, the optional word "remap" can be
|
||||
used. This has the effect as adding it to the
|
||||
"read_restart"_read_restart.html command, as explained on its doc
|
||||
page. This is useful if reading the restart file triggers an error
|
||||
that atoms have been lost. In that case, use of the remap flag should
|
||||
allow the dump file to still be produced.
|
||||
Note that following the restartfile argument, the optional word "remap"
|
||||
can be used. This has the effect as adding it to the
|
||||
"read_restart"_read_restart.html command, as explained on its doc page.
|
||||
This is useful if reading the restart file triggers an error that atoms
|
||||
have been lost. In that case, use of the remap flag should allow the
|
||||
dump file to still be produced.
|
||||
|
||||
The syntax following restartfile (or remap), namely
|
||||
|
||||
|
|
|
@ -60,26 +60,14 @@ doc page for details.
|
|||
|
||||
:line
|
||||
|
||||
Here is an alphabetic list of angle styles defined in LAMMPS. Click on
|
||||
the style to display the formula it computes and coefficients
|
||||
specified by the associated "angle_coeff"_angle_coeff.html command.
|
||||
|
||||
Note that there are also additional angle styles submitted by users
|
||||
which are included in the LAMMPS distribution. The full list of all
|
||||
angle styles is on the "Commands bond"_Commands_bond.html#angle doc
|
||||
The list of all angle styles defined in LAMMPS is given on the
|
||||
"angle_style"_angle_style.html doc page. They are also listed in more
|
||||
compact form on the "Commands angle"_Commands_bond.html#angle doc
|
||||
page.
|
||||
|
||||
"angle_style none"_angle_none.html - turn off angle interactions
|
||||
"angle_style hybrid"_angle_hybrid.html - define multiple styles of angle interactions :ul
|
||||
|
||||
"angle_style charmm"_angle_charmm.html - CHARMM angle
|
||||
"angle_style class2"_angle_class2.html - COMPASS (class 2) angle
|
||||
"angle_style cosine"_angle_cosine.html - cosine angle potential
|
||||
"angle_style cosine/delta"_angle_cosine_delta.html - difference of cosines angle potential
|
||||
"angle_style cosine/periodic"_angle_cosine_periodic.html - DREIDING angle
|
||||
"angle_style cosine/squared"_angle_cosine_squared.html - cosine squared angle potential
|
||||
"angle_style harmonic"_angle_harmonic.html - harmonic angle
|
||||
"angle_style table"_angle_table.html - tabulated by angle :ul
|
||||
On either of those pages, click on the style to display the formula it
|
||||
computes and its coefficients as specified by the associated
|
||||
angle_coeff command.
|
||||
|
||||
:line
|
||||
|
||||
|
|
|
@ -57,10 +57,15 @@ Here is an alphabetic list of angle styles defined in LAMMPS. Click on
|
|||
the style to display the formula it computes and coefficients
|
||||
specified by the associated "angle_coeff"_angle_coeff.html command.
|
||||
|
||||
Note that there are also additional angle styles submitted by users
|
||||
which are included in the LAMMPS distribution. The full list of all
|
||||
angle styles are is on the "Commands bond"_Commands_bond.html#angle
|
||||
doc page.
|
||||
Click on the style to display the formula it computes, any additional
|
||||
arguments specified in the angle_style command, and coefficients
|
||||
specified by the associated "angle_coeff"_angle_coeff.html command.
|
||||
|
||||
There are also additional accelerated pair styles included in the
|
||||
LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs.
|
||||
The individual style names on the "Commands
|
||||
angle"_Commands_bond.html#angle doc page are followed by one or more
|
||||
of (g,i,k,o,t) to indicate which accelerated styles exist.
|
||||
|
||||
"none"_angle_none.html - turn off angle interactions
|
||||
"zero"_angle_zero.html - topology but no interactions
|
||||
|
|
|
@ -56,25 +56,13 @@ corresponds to the 1st example above would be listed as
|
|||
|
||||
:line
|
||||
|
||||
Here is an alphabetic list of bond styles defined in LAMMPS. Click on
|
||||
the style to display the formula it computes and coefficients
|
||||
specified by the associated "bond_coeff"_bond_coeff.html command.
|
||||
The list of all bond styles defined in LAMMPS is given on the
|
||||
"bond_style"_bond_style.html doc page. They are also listed in more
|
||||
compact form on the "Commands bond"_Commands_bond.html doc page.
|
||||
|
||||
Note that here are also additional bond styles submitted by users
|
||||
which are included in the LAMMPS distribution. The full list of all
|
||||
bond styles is on the "Commands bond"_Commands_bond.html doc page.
|
||||
|
||||
"bond_style none"_bond_none.html - turn off bonded interactions
|
||||
"bond_style hybrid"_bond_hybrid.html - define multiple styles of bond interactions :ul
|
||||
|
||||
"bond_style class2"_bond_class2.html - COMPASS (class 2) bond
|
||||
"bond_style fene"_bond_fene.html - FENE (finite-extensible non-linear elastic) bond
|
||||
"bond_style fene/expand"_bond_fene_expand.html - FENE bonds with variable size particles
|
||||
"bond_style harmonic"_bond_harmonic.html - harmonic bond
|
||||
"bond_style morse"_bond_morse.html - Morse bond
|
||||
"bond_style nonlinear"_bond_nonlinear.html - nonlinear bond
|
||||
"bond_style quartic"_bond_quartic.html - breakable quartic bond
|
||||
"bond_style table"_bond_table.html - tabulated by bond length :ul
|
||||
On either of those pages, click on the style to display the formula it
|
||||
computes and its coefficients as specified by the associated
|
||||
bond_coeff command.
|
||||
|
||||
:line
|
||||
|
||||
|
|
|
@ -65,9 +65,15 @@ Here is an alphabetic list of bond styles defined in LAMMPS. Click on
|
|||
the style to display the formula it computes and coefficients
|
||||
specified by the associated "bond_coeff"_bond_coeff.html command.
|
||||
|
||||
Note that there are also additional bond styles submitted by users
|
||||
which are included in the LAMMPS distribution. The full list of all
|
||||
bond styles is on the "Commands bond"_Commands_bond.html doc page.
|
||||
Click on the style to display the formula it computes, any additional
|
||||
arguments specified in the bond_style command, and coefficients
|
||||
specified by the associated "bond_coeff"_bond_coeff.html command.
|
||||
|
||||
There are also additional accelerated pair styles included in the
|
||||
LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs.
|
||||
The individual style names on the "Commands bond"_Commands_bond.html
|
||||
doc page are followed by one or more of (g,i,k,o,t) to indicate which
|
||||
accelerated styles exist.
|
||||
|
||||
"none"_bond_none.html - turn off bonded interactions
|
||||
"zero"_bond_zero.html - topology but no interactions
|
||||
|
|
|
@ -164,11 +164,6 @@ and what it does. Here is an alphabetic list of compute styles
|
|||
available in LAMMPS. They are also listed in more compact form on the
|
||||
"Commands compute"_Commands_compute.html doc page.
|
||||
|
||||
There are also additional compute styles (not listed here) submitted
|
||||
by users which are included in the LAMMPS distribution. The full list
|
||||
of all compute styles is on the "Commands
|
||||
compute"_Commands_compute.html doc page.
|
||||
|
||||
There are also additional accelerated compute styles included in the
|
||||
LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs.
|
||||
The individual style names on the "Commands
|
||||
|
@ -176,7 +171,7 @@ compute"_Commands_compute.html doc page are followed by one or more of
|
|||
(g,i,k,o,t) to indicate which accelerated styles exist.
|
||||
|
||||
"ackland/atom"_compute_ackland_atom.html -
|
||||
"adf"_compute_adf.html - angular distribution function
|
||||
"adf"_compute_adf.html - angular distribution function of triples of atoms
|
||||
"aggregate/atom"_compute_cluster_atom.html - aggregate ID for each atom
|
||||
"angle"_compute_angle.html -
|
||||
"angle/local"_compute_angle_local.html -
|
||||
|
|
|
@ -69,24 +69,14 @@ necessary.
|
|||
|
||||
:line
|
||||
|
||||
Here is an alphabetic list of dihedral styles defined in LAMMPS. Click on
|
||||
the style to display the formula it computes and coefficients
|
||||
specified by the associated "dihedral_coeff"_dihedral_coeff.html command.
|
||||
The list of all dihedral styles defined in LAMMPS is given on the
|
||||
"dihedral_style"_dihedral_style.html doc page. They are also listed
|
||||
in more compact form on the "Commands
|
||||
dihedral"_Commands_bond.html#dihedral doc page.
|
||||
|
||||
Note that there are also additional dihedral styles submitted by users
|
||||
which are included in the LAMMPS distribution. The full list of all
|
||||
dihedral styles is on the "Commands bond"_Commands_bond.html#dihedral
|
||||
doc page.
|
||||
|
||||
"dihedral_style none"_dihedral_none.html - turn off dihedral interactions
|
||||
"dihedral_style hybrid"_dihedral_hybrid.html - define multiple styles of dihedral interactions :ul
|
||||
|
||||
"dihedral_style charmm"_dihedral_charmm.html - CHARMM dihedral
|
||||
"dihedral_style class2"_dihedral_class2.html - COMPASS (class 2) dihedral
|
||||
"dihedral_style harmonic"_dihedral_harmonic.html - harmonic dihedral
|
||||
"dihedral_style helix"_dihedral_helix.html - helix dihedral
|
||||
"dihedral_style multi/harmonic"_dihedral_multi_harmonic.html - multi-harmonic dihedral
|
||||
"dihedral_style opls"_dihedral_opls.html - OPLS dihedral :ul
|
||||
On either of those pages, click on the style to display the formula it
|
||||
computes and its coefficients as specified by the associated
|
||||
dihedral_coeff command.
|
||||
|
||||
:line
|
||||
|
||||
|
|
|
@ -80,10 +80,16 @@ Here is an alphabetic list of dihedral styles defined in LAMMPS. Click on
|
|||
the style to display the formula it computes and coefficients
|
||||
specified by the associated "dihedral_coeff"_dihedral_coeff.html command.
|
||||
|
||||
Note that there are also additional dihedral styles submitted by users
|
||||
which are included in the LAMMPS distribution. The full list of all
|
||||
dihedral styles is on the "Commands bond"_Commands_bond.html#dihedral
|
||||
doc page.
|
||||
Click on the style to display the formula it computes, any additional
|
||||
arguments specified in the dihedral_style command, and coefficients
|
||||
specified by the associated "dihedral_coeff"_dihedral_coeff.html
|
||||
command.
|
||||
|
||||
There are also additional accelerated pair styles included in the
|
||||
LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs.
|
||||
The individual style names on the "Commands
|
||||
dihedral"_Commands_bond.html#dihedral doc page are followed by one or
|
||||
more of (g,i,k,o,t) to indicate which accelerated styles exist.
|
||||
|
||||
"none"_dihedral_none.html - turn off dihedral interactions
|
||||
"zero"_dihedral_zero.html - topology but no interactions
|
||||
|
|
|
@ -156,10 +156,6 @@ what it does, as listed below. Here is an alphabetic list of fix
|
|||
styles available in LAMMPS. They are also listed in more compact form
|
||||
on the "Commands fix"_Commands_fix.html doc page.
|
||||
|
||||
There are also additional fix styles (not listed here) submitted by
|
||||
users which are included in the LAMMPS distribution. The full list of
|
||||
all fix styles is on the "Commands fix"_Commands_fix.html doc page.
|
||||
|
||||
There are also additional accelerated fix styles included in the
|
||||
LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs.
|
||||
The individual style names on the "Commands fix"_Commands_fix.html doc
|
||||
|
|
|
@ -62,22 +62,14 @@ page for details.
|
|||
|
||||
:line
|
||||
|
||||
Here is an alphabetic list of improper styles defined in LAMMPS. Click on
|
||||
the style to display the formula it computes and coefficients
|
||||
specified by the associated "improper_coeff"_improper_coeff.html command.
|
||||
The list of all improper styles defined in LAMMPS is given on the
|
||||
"improper_style"_improper_style.html doc page. They are also listed
|
||||
in more compact form on the "Commands
|
||||
improper"_Commands_bond.html#improper doc page.
|
||||
|
||||
Note that there are also additional improper styles submitted by users
|
||||
which are included in the LAMMPS distribution. The full list of all
|
||||
improper styles is on the "Commands bond"_Commands_bond.html#improper
|
||||
doc page.
|
||||
|
||||
"improper_style none"_improper_none.html - turn off improper interactions
|
||||
"improper_style hybrid"_improper_hybrid.html - define multiple styles of improper interactions :ul
|
||||
|
||||
"improper_style class2"_improper_class2.html - COMPASS (class 2) improper
|
||||
"improper_style cvff"_improper_cvff.html - CVFF improper
|
||||
"improper_style harmonic"_improper_harmonic.html - harmonic improper
|
||||
"improper_style umbrella"_improper_umbrella.html - DREIDING improper :ul
|
||||
On either of those pages, click on the style to display the formula it
|
||||
computes and its coefficients as specified by the associated
|
||||
improper_coeff command.
|
||||
|
||||
:line
|
||||
|
||||
|
|
|
@ -59,10 +59,16 @@ Click on the style to display the formula it computes and coefficients
|
|||
specified by the associated "improper_coeff"_improper_coeff.html
|
||||
command.
|
||||
|
||||
Note that there are also additional improper styles submitted by users
|
||||
which are included in the LAMMPS distribution. The full list of all
|
||||
improper styles is on the "Commands bond"_Commands_bond.html#improper
|
||||
doc page.
|
||||
Click on the style to display the formula it computes, any additional
|
||||
arguments specified in the improper_style command, and coefficients
|
||||
specified by the associated "improper_coeff"_improper_coeff.html
|
||||
command.
|
||||
|
||||
There are also additional accelerated pair styles included in the
|
||||
LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs.
|
||||
The individual style names on the "Commands
|
||||
improper"_Commands_bond.html#improper doc page are followed by one or
|
||||
more of (g,i,k,o,t) to indicate which accelerated styles exist.
|
||||
|
||||
"none"_improper_none.html - turn off improper interactions
|
||||
"zero"_improper_zero.html - topology but no interactions
|
||||
|
|
|
@ -114,21 +114,8 @@ The alphabetic list of pair styles defined in LAMMPS is given on the
|
|||
"pair_style"_pair_style.html doc page. They are also listed in more
|
||||
compact form on the "Commands pair"_Commands_pair.html doc page.
|
||||
|
||||
Click on the style to display the formula it computes, arguments
|
||||
specified in the pair_style command, and coefficients specified by the
|
||||
associated "pair_coeff"_pair_coeff.html command.
|
||||
|
||||
Note that there are also additional pair styles (not listed on the
|
||||
"pair_style"_pair_style.html doc page) submitted by users which are
|
||||
included in the LAMMPS distribution. The full list of all pair styles
|
||||
is on the "Commands pair"_Commands_pair.html doc page.
|
||||
|
||||
There are also additional accelerated pair styles (not listed on the
|
||||
"pair_style"_pair_style.html doc page) included in the LAMMPS
|
||||
distribution for faster performance on CPUs, GPUs, and KNLs. The
|
||||
individual style names on the "Commands pair"_Commands_pair.html doc
|
||||
page are followed by one or more of (g,i,k,o,t) to indicate which
|
||||
accelerated styles exist.
|
||||
Click on the style to display the formula it computes and its
|
||||
coefficients as specified by the associated pair_coeff command.
|
||||
|
||||
:line
|
||||
|
||||
|
|
|
@ -81,19 +81,15 @@ Here is an alphabetic list of pair styles defined in LAMMPS. They are
|
|||
also listed in more compact form on the "Commands
|
||||
pair"_Commands_pair.html doc page.
|
||||
|
||||
Click on the style to display the formula it computes, arguments
|
||||
specified in the pair_style command, and coefficients specified by the
|
||||
associated "pair_coeff"_pair_coeff.html command.
|
||||
Click on the style to display the formula it computes, any additional
|
||||
arguments specified in the pair_style command, and coefficients
|
||||
specified by the associated "pair_coeff"_pair_coeff.html command.
|
||||
|
||||
There are also additional pair styles (not listed here) submitted by
|
||||
users which are included in the LAMMPS distribution. The full list of
|
||||
all pair styles is on the "Commands pair"_Commands_pair.html doc page.
|
||||
|
||||
There are also additional accelerated pair styles (not listed here)
|
||||
included in the LAMMPS distribution for faster performance on CPUs,
|
||||
GPUs, and KNLs. The individual style names on the "Commands
|
||||
pair"_Commands_pair.html doc page are followed by one or more of
|
||||
(g,i,k,o,t) to indicate which accelerated styles exist.
|
||||
There are also additional accelerated pair styles included in the
|
||||
LAMMPS distribution for faster performance on CPUs, GPUs, and KNLs.
|
||||
The individual style names on the "Commands pair"_Commands_pair.html
|
||||
doc page are followed by one or more of (g,i,k,o,t) to indicate which
|
||||
accelerated styles exist.
|
||||
|
||||
"none"_pair_none.html - turn off pairwise interactions
|
||||
"hybrid"_pair_hybrid.html - multiple styles of pairwise interactions
|
||||
|
|
Loading…
Reference in New Issue