ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix up a few internal references

Browse Source
This commit is contained in:
Axel Kohlmeyer
2020-09-25 14:04:44 -04:00
parent 495438105f
commit 5e6d222d29
5 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/src/Classes.rst
View File

@ -5,7 +5,7 @@ LAMMPS is designed to be used as a C++ class library where one can set
up and drive a simulation through creating a class instance and then up and drive a simulation through creating a class instance and then
calling some abstract operations or commands on that class or its member calling some abstract operations or commands on that class or its member
class instances. These are interfaced to the :doc:`C library API class instances. These are interfaced to the :doc:`C library API
<pg_library>`, which providing an additional level of abstraction <Library>`, which providing an additional level of abstraction
simplification for common operations. The C API is also the basis for simplification for common operations. The C API is also the basis for
calling LAMMPS from Python or Fortran. calling LAMMPS from Python or Fortran.
@ -33,6 +33,6 @@ some selected examples for derived classes of specific models.
:caption: Individual Base Classes :caption: Individual Base Classes
:name: lammpsbase :name: lammpsbase
pg_lammps Classes_lammps
pg_atom Classes_atom
pg_input Classes_input

2
doc/src/Howto_couple.rst
View File

@ -54,7 +54,7 @@ context of your application.
invoked with minimal overhead (no setup or clean-up) if you wish to invoked with minimal overhead (no setup or clean-up) if you wish to
do multiple short runs, driven by another program. Details about do multiple short runs, driven by another program. Details about
using the library interface are given in the :doc:`library API using the library interface are given in the :doc:`library API
<pg_library>` documentation. <Library>` documentation.
.. spacer .. spacer

6
doc/src/Howto_library.rst
View File

@ -20,8 +20,8 @@ Creating a LAMMPS instance can be done by using C++ code directly or
through a C-style interface library to LAMMPS that is provided in the through a C-style interface library to LAMMPS that is provided in the
files ``src/library.cpp`` and ``library.h``. This files ``src/library.cpp`` and ``library.h``. This
:ref:`C language API <lammps_c_api>`, can be used from C and C++, :ref:`C language API <lammps_c_api>`, can be used from C and C++,
and is also the basis for the :doc:`Python <pg_python>` and and is also the basis for the :doc:`Python <Python_module>` and
:doc:`Fortran <pg_fortran>` interfaces or wrappers included in the :doc:`Fortran <Fortran>` interfaces or wrappers included in the
LAMMPS source code. LAMMPS source code.
The ``examples/COUPLE`` and ``python/examples`` directories contain some The ``examples/COUPLE`` and ``python/examples`` directories contain some
@ -33,5 +33,5 @@ LAMMPS.
A detailed documentation of the available APIs and examples of how to A detailed documentation of the available APIs and examples of how to
use them can be found in the :doc:`Programmer Documentation use them can be found in the :doc:`Programmer Documentation
<pg_library>` section of this manual. <Library>` section of this manual.

2
doc/src/Library.rst
View File

@ -53,7 +53,7 @@ LAMMPS C Library API
The C library interface is most commonly used path to manage LAMMPS The C library interface is most commonly used path to manage LAMMPS
instances from a compiled code and it is the basis for the :doc:`Python instances from a compiled code and it is the basis for the :doc:`Python
<pg_python>` and :doc:`Fortran <pg_fortran>` modules. Almost all <Python_module>` and :doc:`Fortran <Fortran>` modules. Almost all
functions of the C language API require an argument containing a functions of the C language API require an argument containing a
"handle" in the form of a ``void *`` type variable, which points to the "handle" in the form of a ``void *`` type variable, which points to the
location of a LAMMPS class instance. location of a LAMMPS class instance.

2
doc/src/Python_module.rst
View File

@ -204,7 +204,7 @@ to "compute" what the next LAMMPS command should be.
.. tab:: lammps API .. tab:: lammps API
Same as in the equivalent Same as in the equivalent
:doc:`C library functions <pg_lib_execute>`, commands can be read from a file, a :doc:`C library functions <Library_execute>`, commands can be read from a file, a
single string, a list of strings and a block of commands in a single single string, a list of strings and a block of commands in a single
multi-line string. They are processed under the same boundary conditions multi-line string. They are processed under the same boundary conditions
as the C library counterparts. The example below demonstrates the use as the C library counterparts. The example below demonstrates the use