Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
L
lammps
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
multiscale
lammps
Commits
69903cb4
Unverified
Commit
69903cb4
authored
6 years ago
by
Steve Plimpton
Committed by
GitHub
6 years ago
Browse files
Options
Downloads
Plain Diff
Merge pull request #921 from lammps/doctweaks
tweaks to doc pages
parents
94c6d2d5
cab60204
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
doc/src/pair_gw.txt
+5
-4
5 additions, 4 deletions
doc/src/pair_gw.txt
doc/src/pair_reaxc.txt
+29
-25
29 additions, 25 deletions
doc/src/pair_reaxc.txt
doc/src/pair_sw.txt
+2
-2
2 additions, 2 deletions
doc/src/pair_sw.txt
with
36 additions
and
31 deletions
doc/src/pair_gw.txt
+
5
−
4
View file @
69903cb4
...
@@ -95,9 +95,9 @@ This pair style can only be used via the {pair} keyword of the
...
@@ -95,9 +95,9 @@ This pair style can only be used via the {pair} keyword of the
[Restrictions:]
[Restrictions:]
This pair style is part of the
USER-MISC
package. It is only enabled
This pair style is part of the
MANYBODY
package. It is only enabled
if
if
LAMMPS was built with that package. See
LAMMPS was built with that package. See
the "Making
the "Making
LAMMPS"_Section_start.html#start_3 section for more info.
LAMMPS"_Section_start.html#start_3 section for more info.
This pair style requires the "newton"_newton.html setting to be "on"
This pair style requires the "newton"_newton.html setting to be "on"
for pair interactions.
for pair interactions.
...
@@ -117,4 +117,5 @@ appropriate units if your simulation doesn't use "metal" units.
...
@@ -117,4 +117,5 @@ appropriate units if your simulation doesn't use "metal" units.
:line
:line
:link(Gao)
:link(Gao)
[(Gao)] Gao and Weber, Nuclear Instruments and Methods in Physics Research B 191 (2012) 504.
[(Gao)] Gao and Weber, Nuclear Instruments and Methods in Physics
Research B 191 (2012) 504.
This diff is collapsed.
Click to expand it.
doc/src/pair_reaxc.txt
+
29
−
25
View file @
69903cb4
...
@@ -47,13 +47,14 @@ the "(Aktulga)"_#Aktulga paper. The {reax/c} style was initially
...
@@ -47,13 +47,14 @@ the "(Aktulga)"_#Aktulga paper. The {reax/c} style was initially
implemented as a stand-alone C code and is now integrated into LAMMPS
implemented as a stand-alone C code and is now integrated into LAMMPS
as a package.
as a package.
The {reax/c/kk} style is a Kokkos version of the ReaxFF potential that is
The {reax/c/kk} style is a Kokkos version of the ReaxFF potential that
derived from the {reax/c} style. The Kokkos version can run on GPUs and
is derived from the {reax/c} style. The Kokkos version can run on GPUs
can also use OpenMP multithreading. For more information about the Kokkos package,
and can also use OpenMP multithreading. For more information about the
see "Section 4"_Section_packages.html#kokkos and "Section 5.3.3"_accelerate_kokkos.html.
Kokkos package, see "Section 4"_Section_packages.html#kokkos and
One important consideration when using the {reax/c/kk} style is the choice of either
"Section 5.3.3"_accelerate_kokkos.html. One important consideration
half or full neighbor lists. This setting can be changed using the Kokkos "package"_package.html
when using the {reax/c/kk} style is the choice of either half or full
command.
neighbor lists. This setting can be changed using the Kokkos
"package"_package.html command.
The {reax/c} style differs from the "pair_style reax"_pair_reax.html
The {reax/c} style differs from the "pair_style reax"_pair_reax.html
command in the lo-level implementation details. The {reax} style is a
command in the lo-level implementation details. The {reax} style is a
...
@@ -80,9 +81,8 @@ parameterizations for different classes of materials. You can submit
...
@@ -80,9 +81,8 @@ parameterizations for different classes of materials. You can submit
a contact request at the Materials Computation Center (MCC) website
a contact request at the Materials Computation Center (MCC) website
"https://www.mri.psu.edu/materials-computation-center/connect-mcc"_https://www.mri.psu.edu/materials-computation-center/connect-mcc,
"https://www.mri.psu.edu/materials-computation-center/connect-mcc"_https://www.mri.psu.edu/materials-computation-center/connect-mcc,
describing the material(s) you are interested in modeling with ReaxFF.
describing the material(s) you are interested in modeling with ReaxFF.
They can tell
They can tell you what is currently available or what it would take to
you what is currently available or what it would take to create a
create a suitable ReaxFF parameterization.
suitable ReaxFF parameterization.
The {cfile} setting can be specified as NULL, in which case default
The {cfile} setting can be specified as NULL, in which case default
settings are used. A control file can be specified which defines
settings are used. A control file can be specified which defines
...
@@ -120,28 +120,31 @@ assign to each atom will be used for computing the electrostatic
...
@@ -120,28 +120,31 @@ assign to each atom will be used for computing the electrostatic
interactions in the system.
interactions in the system.
See the "fix qeq/reax"_fix_qeq_reax.html command for details.
See the "fix qeq/reax"_fix_qeq_reax.html command for details.
Using the optional keyword {lgvdw} with the value {yes} turns on
Using the optional keyword {lgvdw} with the value {yes} turns on
the
the
low-gradient correction of the ReaxFF/C for long-range
low-gradient correction of the ReaxFF/C for long-range
London
London
Dispersion, as described in the "(Liu)"_#Liu_2011 paper. Force field
Dispersion, as described in the "(Liu)"_#Liu_2011 paper. Force field
file {ffield.reax.lg} is designed for this correction, and is trained
file {ffield.reax.lg} is designed for this correction, and is trained
for several energetic materials (see "Liu"). When using lg-correction,
for several energetic materials (see "Liu"). When using lg-correction,
recommended value for parameter {thb} is 0.01, which can be set in the
recommended value for parameter {thb} is 0.01, which can be set in the
control file. Note: Force field files are different for the original
control file. Note: Force field files are different for the original
or lg corrected pair styles, using wrong ffield file generates an error message.
or lg corrected pair styles, using wrong ffield file generates an
error message.
Using the optional keyword {enobonds} with the value {yes}, the energy
Using the optional keyword {enobonds} with the value {yes}, the energy
of atoms with no bonds (i.e. isolated atoms) is included in the total
of atoms with no bonds (i.e. isolated atoms) is included in the total
potential energy and the per-atom energy of that atom. If the value
potential energy and the per-atom energy of that atom. If the value
{no} is specified then the energy of atoms with no bonds is set to zero.
{no} is specified then the energy of atoms with no bonds is set to
The latter behavior is usual not desired, as it causes discontinuities
zero. The latter behavior is usual not desired, as it causes
in the potential energy when the bonding of an atom drops to zero.
discontinuities in the potential energy when the bonding of an atom
drops to zero.
Optional keywords {safezone} and {mincap} are used for allocating
Optional keywords {safezone} and {mincap} are used for allocating
reax/c arrays. Increasing these values can avoid memory problems, such
reax/c arrays. Increasing these values can avoid memory problems,
as segmentation faults and bondchk failed errors, that could occur under
such as segmentation faults and bondchk failed errors, that could
certain conditions. These keywords aren't used by the Kokkos version, which
occur under certain conditions. These keywords aren't used by the
instead uses a more robust memory allocation scheme that checks if the sizes of
Kokkos version, which instead uses a more robust memory allocation
the arrays have been exceeded and automatically allocates more memory.
scheme that checks if the sizes of the arrays have been exceeded and
automatically allocates more memory.
The thermo variable {evdwl} stores the sum of all the ReaxFF potential
The thermo variable {evdwl} stores the sum of all the ReaxFF potential
energy contributions, with the exception of the Coulombic and charge
energy contributions, with the exception of the Coulombic and charge
...
@@ -153,7 +156,8 @@ This pair style tallies a breakdown of the total ReaxFF potential
...
@@ -153,7 +156,8 @@ This pair style tallies a breakdown of the total ReaxFF potential
energy into sub-categories, which can be accessed via the "compute
energy into sub-categories, which can be accessed via the "compute
pair"_compute_pair.html command as a vector of values of length 14.
pair"_compute_pair.html command as a vector of values of length 14.
The 14 values correspond to the following sub-categories (the variable
The 14 values correspond to the following sub-categories (the variable
names in italics match those used in the original FORTRAN ReaxFF code):
names in italics match those used in the original FORTRAN ReaxFF
code):
{eb} = bond energy
{eb} = bond energy
{ea} = atom energy
{ea} = atom energy
...
@@ -340,8 +344,8 @@ reax"_pair_reax.html
...
@@ -340,8 +344,8 @@ reax"_pair_reax.html
[Default:]
[Default:]
The keyword defaults are checkqeq = yes, enobonds = yes, lgvdw = no,
safezone = 1.2,
The keyword defaults are checkqeq = yes, enobonds = yes, lgvdw = no,
mincap = 50.
safezone = 1.2,
mincap = 50.
:line
:line
...
...
This diff is collapsed.
Click to expand it.
doc/src/pair_sw.txt
+
2
−
2
View file @
69903cb4
...
@@ -192,8 +192,8 @@ This pair style can only be used via the {pair} keyword of the
...
@@ -192,8 +192,8 @@ This pair style can only be used via the {pair} keyword of the
[Restrictions:]
[Restrictions:]
This pair style is part of the MANYBODY package. It is only enabled
This pair style is part of the MANYBODY package. It is only enabled
if LAMMPS was built with that package. See
if LAMMPS was built with that package. See
the "Making
the "Making
LAMMPS"_Section_start.html#start_3 section for more info.
LAMMPS"_Section_start.html#start_3 section for more info.
This pair style requires the "newton"_newton.html setting to be "on"
This pair style requires the "newton"_newton.html setting to be "on"
for pair interactions.
for pair interactions.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment