doc fixes

This commit is contained in:
jtclemm
2024-11-26 15:55:08 -07:00
parent e4683c3134
commit 8aba26bd71
4 changed files with 22 additions and 24 deletions

View File

@ -102,12 +102,12 @@ more uniform spatial distribution. By default, shifting does not consider the
type of a particle and therefore may be inappropriate in systems consisting type of a particle and therefore may be inappropriate in systems consisting
of multiple atom types representing multiple fluid phases. However, two of multiple atom types representing multiple fluid phases. However, two
optional subarguments can follow the *shift* keyword, *exclude/type* and optional subarguments can follow the *shift* keyword, *exclude/type* and
*scale/cross/type*. *scale/cross/type* to adjust shifting at fluid interfaces.
The *exclude/type* option lets the user specify a list of atom types which The *exclude/type* option lets the user specify a list of atom types which
are not shifted, *types*. A wild-card asterisk can be used in place are not shifted, *types*. A wild-card asterisk can be used in place
of or in conjunction with the *types* argument to set the coefficients for of or in conjunction with the *types* argument to toggle shifting for
multiple pairs of atom types. This takes the form "\*" or "\*n" or "m\*" multiple atom types. This takes the form "\*" or "\*n" or "m\*"
or "m\*n". If :math:`N` is the number of atom types, then an asterisk with or "m\*n". If :math:`N` is the number of atom types, then an asterisk with
no numeric values means all types from 1 to :math:`N`. A leading asterisk no numeric values means all types from 1 to :math:`N`. A leading asterisk
means all types from 1 to n (inclusive). A trailing asterisk means all types means all types from 1 to n (inclusive). A trailing asterisk means all types

View File

@ -44,13 +44,12 @@ define different equations of state for different atom types. An equation
must be specified for every atom type. must be specified for every atom type.
One first defines the atom *types*. A wild-card asterisk can be used in place One first defines the atom *types*. A wild-card asterisk can be used in place
of or in conjunction with the *types* argument to set the coefficients for of or in conjunction with the *types* argument to set values for multiple atom
multiple pairs of atom types. This takes the form "\*" or "\*n" or "m\*" types. This takes the form "\*" or "\*n" or "m\*" or "m\*n". If :math:`N` is
or "m\*n". If :math:`N` is the number of atom types, then an asterisk with the number of atom types, then an asterisk with no numeric values means all types
no numeric values means all types from 1 to :math:`N`. A leading asterisk from 1 to :math:`N`. A leading asterisk means all types from 1 to n (inclusive).
means all types from 1 to n (inclusive). A trailing asterisk means all types A trailing asterisk means all types from m to :math:`N` (inclusive). A middle
from m to :math:`N` (inclusive). A middle asterisk means all types from m to n asterisk means all types from m to n (inclusive).
(inclusive).
The *types* definition is followed by the pressure style, *pstyle*. Current The *types* definition is followed by the pressure style, *pstyle*. Current
options *linear*, *taitwater*, and *cubic*. Style *linear* is a linear options *linear*, *taitwater*, and *cubic*. Style *linear* is a linear

View File

@ -70,13 +70,13 @@ of the energy is used to shift energies. This may be inappropriate in systems
with multiple atom types with different specific heats. with multiple atom types with different specific heats.
For each property, one must first define a list of atom types. A wild-card For each property, one must first define a list of atom types. A wild-card
asterisk can be used in place of or in conjunction with the *types* argument asterisk can be used in place of or in conjunction with the *types* argument to
to set the coefficients for multiple pairs of atom types. This takes the set values for multiple atom types. This takes the form "\*" or "\*n" or "m\*"
form "\*" or "\*n" or "m\*" or "m\*n". If :math:`N` is the number of atom or "m\*n". If :math:`N` is the number of atom types, then an asterisk with no
types, then an asterisk with no numeric values means all types from 1 to numeric values means all types from 1 to :math:`N`. A leading asterisk means
:math:`N`. A leading asterisk means all types from 1 to n (inclusive). all types from 1 to n (inclusive). A trailing asterisk means all types from m
A trailing asterisk means all types from m to :math:`N` (inclusive). A to :math:`N` (inclusive). A middle asterisk means all types from m to n
middle asterisk means all types from m to n (inclusive). (inclusive).
The *types* definition for each property is followed by the style. Currently, The *types* definition for each property is followed by the style. Currently,
the only option is *constant*. Style *constant* simply applies a constant value the only option is *constant*. Style *constant* simply applies a constant value

View File

@ -45,13 +45,12 @@ viscosities for different atom types, but a viscosity must be specified for
every atom type. every atom type.
One first defines the atom *types*. A wild-card asterisk can be used in place One first defines the atom *types*. A wild-card asterisk can be used in place
of or in conjunction with the *types* argument to set the coefficients for of or in conjunction with the *types* argument to set values for multiple atom
multiple pairs of atom types. This takes the form "\*" or "\*n" or "m\*" types. This takes the form "\*" or "\*n" or "m\*" or "m\*n". If :math:`N` is
or "m\*n". If :math:`N` is the number of atom types, then an asterisk with the number of atom types, then an asterisk with no numeric values means all types
no numeric values means all types from 1 to :math:`N`. A leading asterisk from 1 to :math:`N`. A leading asterisk means all types from 1 to n (inclusive).
means all types from 1 to n (inclusive). A trailing asterisk means all types A trailing asterisk means all types from m to :math:`N` (inclusive). A middle
from m to :math:`N` (inclusive). A middle asterisk means all types from m to n asterisk means all types from m to n (inclusive).
(inclusive).
The *types* definition is followed by the viscosity style, *vstyle*. Two The *types* definition is followed by the viscosity style, *vstyle*. Two
options are available, *constant* and *power*. Style *constant* simply options are available, *constant* and *power*. Style *constant* simply