Unverified Commit e07a6d1e authored by Steve Plimpton's avatar Steve Plimpton Committed by GitHub
Browse files

Merge pull request #768 from akohlmey/collected-doc-fixes

collected documentation fixes
parents 6e37272c 61ebf626
Loading
Loading
Loading
Loading
+7 −7
Original line number Diff line number Diff line
@@ -326,9 +326,9 @@ include both "Cuda" and "OpenMP", as is the case for /src/MAKE/OPTIONS/Makefile.

KOKKOS_DEVICES=Cuda,OpenMP :pre

The suffix “/kk” is equivalent to “/kk/device”, and for Kokkos CUDA,
using the “-sf kk” in the command line gives the default CUDA version everywhere.
However, if the “/kk/host” suffix is added to a specific style in the input
The suffix "/kk" is equivalent to "/kk/device", and for Kokkos CUDA,
using the "-sf kk" in the command line gives the default CUDA version everywhere.
However, if the "/kk/host" suffix is added to a specific style in the input
script, the Kokkos OpenMP (CPU) version of that specific style will be used instead.
Set the number of OpenMP threads as "t Nt" and the number of GPUs as "g Ng"

@@ -338,16 +338,16 @@ For example, the command to run with 1 GPU and 8 OpenMP threads is then:

mpiexec -np 1 lmp_kokkos_cuda_openmpi -in in.lj -k on g 1 t 8 -sf kk :pre

Conversely, if the “-sf kk/host” is used in the command line and then the
“/kk” or “/kk/device” suffix is added to a specific style in your input script,
Conversely, if the "-sf kk/host" is used in the command line and then the
"/kk" or "/kk/device" suffix is added to a specific style in your input script,
then only that specific style will run on the GPU while everything else will
run on the CPU in OpenMP mode. Note that the execution of the CPU and GPU
styles will NOT overlap, except for a special case:

A kspace style and/or molecular topology (bonds, angles, etc.) running on
the host CPU can overlap with a pair style running on the GPU. First compile
with “--default-stream per-thread” added to CCFLAGS in the Kokkos CUDA Makefile.
Then explicitly use the “/kk/host” suffix for kspace and bonds, angles, etc.
with "--default-stream per-thread" added to CCFLAGS in the Kokkos CUDA Makefile.
Then explicitly use the "/kk/host" suffix for kspace and bonds, angles, etc.
in the input file and the "kk" suffix (equal to "kk/device") on the command line.
Also make sure the environment variable CUDA_LAUNCH_BLOCKING is not set to "1"
so CPU/GPU overlap can occur.
+1 −1
Original line number Diff line number Diff line
@@ -261,7 +261,7 @@ For images created by the "dump image"_dump_image.html command, if the
polygon consisting of N line segments.  Note that the line segments
are drawn between the N vertices, which does not correspond exactly to
the physical extent of the body (because the "pair_style
rounded/polygon"_pair_body_rounded_polygon.cpp defines finite-size
rounded/polygon"_pair_body_rounded_polygon.html defines finite-size
spheres at those point and the line segments between the spheres are
tangent to the spheres).  The drawn diameter of each line segment is
determined by the {bflag1} parameter for the {body} keyword.  The
+2 −5
Original line number Diff line number Diff line
@@ -14,15 +14,12 @@ fix ID group-ID smd/integrate_tlsph keyword values :pre

ID, group-ID are documented in "fix"_fix.html command
smd/integrate_tlsph = style name of this fix command
zero or more keyword/value pairs may be appended :ul

keyword = {limit_velocity}  :l
zero or more keyword/value pairs may be appended
keyword = {limit_velocity}  :ul

  {limit_velocity} value = max_vel
    max_vel = maximum allowed velocity :pre

:ule

[Examples:]

fix 1 all smd/integrate_tlsph
+4 −5
Original line number Diff line number Diff line
@@ -14,9 +14,8 @@ fix ID group-ID smd/integrate_ulsph keyword :pre

ID, group-ID are documented in "fix"_fix.html command
smd/integrate_ulsph = style name of this fix command
zero or more keyword/value pairs may be appended :ul

keyword = adjust_radius or limit_velocity
zero or more keyword/value pairs may be appended
keyword = adjust_radius or limit_velocity :ul

adjust_radius values = adjust_radius_factor min_nn max_nn
      adjust_radius_factor = factor which scale the smooth/kernel radius
@@ -28,7 +27,7 @@ limit_velocity values = max_velocity

[Examples:]

fix 1 all smd/integrate_ulsph adjust_radius 1.02 25 50 :pre
fix 1 all smd/integrate_ulsph adjust_radius 1.02 25 50
fix 1 all smd/integrate_ulsph limit_velocity 1000 :pre

[Description:]
+19 −0
Original line number Diff line number Diff line
"LAMMPS WWW Site"_lws - "LAMMPS Documentation"_ld - "LAMMPS Commands"_lc :c

:link(lws,http://lammps.sandia.gov)
:link(ld,Manual.html)
:link(lc,Section_commands.html#comm)

:line

fix wall/surface/globale command :h3

[Description:]

This feature is not yet implemented.

[Related commands:]

"dump image"_dump_image.html

Loading