Merge pull request #1117 from lammps/doc-tweak (6f379f54) · Commits · 郑智淋 / lammps

doc/src/Build_basics.txt

+4 −0

Original line number	Diff line number	Diff line
		@@ -292,6 +292,10 @@ This will create a lammps/doc/html dir with the HTML doc pages so that
		you can browse them locally on your system. Type "make" from the
		lammps/doc dir to see other options.

		NOTE: You can also download a tarball of the documention for the
		current LAMMPS version (HTML and PDF files), from the website
		"download page"_http://lammps.sandia.gov/download.html.

		:line

		Install LAMMPS after a build :h4,link(install)

+3 −3

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@ Documentation"_ld - "LAMMPS Commands"_lc :c

		:line

		Using LAMMPS in client/server mode
		Using LAMMPS in client/server mode :h3

		Client/server coupling of two codes is where one code is the "client"
		and sends request messages to a "server" code. The server responds to
		@@ -61,7 +61,7 @@ client or server.
		"message"_message.html
		"fix client md"_fix_client_md.html = LAMMPS is a client for running MD
		"server md"_server_md.html = LAMMPS is a server for computing MD forces
		"server mc"_server_mc.html = LAMMPS is a server for computing a Monte Carlo energy
		"server mc"_server_mc.html = LAMMPS is a server for computing a Monte Carlo energy :ul

		The server doc files give details of the message protocols
		for data that is exchanged bewteen the client and server.
		@@ -119,7 +119,7 @@ For message exchange in {mpi/one} mode:

		Launch both codes in a single mpirun command:

		mpirun -np 2 lmp_mpi -mpicolor 0 -in in.message.client -log log.client : -np 4 lmp_mpi -mpicolor 1 -in in.message.server -log log.server
		mpirun -np 2 lmp_mpi -mpicolor 0 -in in.message.client -log log.client : -np 4 lmp_mpi -mpicolor 1 -in in.message.server -log log.server :pre

		The two -np values determine how many procs the client and the server
		run on.

+5 −1

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@ Documentation"_ld - "LAMMPS Commands"_lc :c

		:line

		Download source as a tarball :h3
		Download source and documentation as a tarball :h3

		You can download a current LAMMPS tarball from the "download page"_download
		of the "LAMMPS website"_lws.
		@@ -22,6 +22,10 @@ few times per year, and undergo more testing before release. Patch
		releases occur a couple times per month. The new contents in all
		releases are listed on the "bug and feature page"_bug of the website.

		Both tarballs include LAMMPS documentation (HTML and PDF files)
		corresponding to that version. The download page also has an option
		to download the current-version LAMMPS documentation by itself.

		Older versions of LAMMPS can also be downloaded from "this
		page"_older.

+3 −2

Original line number	Diff line number	Diff line
		@@ -46,6 +46,7 @@ as contained in the file name.
		"MANYBODY"_#PKG-MANYBODY,
		"MC"_#PKG-MC,
		"MEAM"_#PKG-MEAM,
		"MESSAGE"_#PKG-MESSAGE,
		"MISC"_#PKG-MISC,
		"MOLECULE"_#PKG-MOLECULE,
		"MPIIO"_#PKG-MPIIO,
		@@ -92,7 +93,7 @@ as contained in the file name.
		"USER-QTB"_#PKG-USER-QTB,
		"USER-QUIP"_#PKG-USER-QUIP,
		"USER-REAXC"_#PKG-USER-REAXC,
		"USER-SCAFACOS"_#USER-SCAFACOS,
		"USER-SCAFACOS"_#PKG-USER-SCAFACOS,
		"USER-SMD"_#PKG-USER-SMD,
		"USER-SMTBQ"_#PKG-USER-SMTBQ,
		"USER-SPH"_#PKG-USER-SPH,
		@@ -1860,7 +1861,7 @@ examples/reax :ul

		:line

		USER-SCAFACOS package :link(USER-SCAFACOS),h4
		USER-SCAFACOS package :link(PKG-USER-SCAFACOS),h4

		[Contents:]

+3 −3

Original line number	Diff line number	Diff line
		@@ -63,7 +63,7 @@ See the src/MESSAGE/server_mc.cpp file for details on how LAMMPS uses
		these messages. See the examples/COUPLE/lammmps_mc/mc.cpp file for an
		example of how an MC driver code can use these messages.

		Let NATOMS=1, EINIT=2, DISPLACE=3, ACCEPT=4, RUN=5.
		Define NATOMS=1, EINIT=2, DISPLACE=3, ACCEPT=4, RUN=5.

		[Client sends one of these kinds of message]:

		@@ -93,9 +93,9 @@ cs->pack(2,3*natoms,x) # 2nd field = 3N coords of Natoms :pre
		cs->send(DISPLACE,1) # msgID = 3 with 1 field
		cs->pack_double(1,poteng) # 1st field = new potential energy of system :pre

		cs->send(ACCEPT,0) # msgID = 4 with no fields
		cs->send(ACCEPT,0) # msgID = 4 with no fields :pre

		cs->send(RUN,0) # msgID = 5 with no fields
		cs->send(RUN,0) # msgID = 5 with no fields :pre

		:line