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

add documentation for added keyword and library interface functions

Browse Source
This commit is contained in:
Axel Kohlmeyer
2021-01-12 20:11:38 -05:00
parent 3d3590f02d
commit 702de49f59
3 changed files with 14 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/src/Library_config.rst
View File

@ -14,6 +14,7 @@ This section documents the following functions:
- :cpp:func:`lammps_config_has_package` - :cpp:func:`lammps_config_has_package`
- :cpp:func:`lammps_config_package_count` - :cpp:func:`lammps_config_package_count`
- :cpp:func:`lammps_config_package_name` - :cpp:func:`lammps_config_package_name`
- :cpp:func:`lammps_config_accelerator`
- :cpp:func:`lammps_has_style` - :cpp:func:`lammps_has_style`
- :cpp:func:`lammps_style_count` - :cpp:func:`lammps_style_count`
- :cpp:func:`lammps_style_name` - :cpp:func:`lammps_style_name`
@ -126,6 +127,11 @@ approach.
----------------------- -----------------------
.. doxygenfunction:: lammps_config_accelerator
:project: progguide
-----------------------
.. doxygenfunction:: lammps_has_style .. doxygenfunction:: lammps_has_style
:project: progguide :project: progguide

4
doc/src/Python_config.rst
View File

@ -39,7 +39,9 @@ about compile time settings and included packages and styles.
* :py:attr:`lammps.has_jpeg_support <lammps.lammps.has_jpeg_support>` * :py:attr:`lammps.has_jpeg_support <lammps.lammps.has_jpeg_support>`
* :py:attr:`lammps.has_ffmpeg_support <lammps.lammps.has_ffmpeg_support>` * :py:attr:`lammps.has_ffmpeg_support <lammps.lammps.has_ffmpeg_support>`
* :py:attr:`lammps.installed_packages <lammps.lammps.installed_pages>` * :py:attr:`lammps.installed_packages <lammps.lammps.installed_packages>`
* :py:meth:`lammps.get_accelerator_config <lammps.lammps.accelerator_config>`
* :py:meth:`lammps.has_style() <lammps.lammps.has_style()>` * :py:meth:`lammps.has_style() <lammps.lammps.has_style()>`
* :py:meth:`lammps.available_styles() <lammps.lammps.available_styles()>` * :py:meth:`lammps.available_styles() <lammps.lammps.available_styles()>`

6
doc/src/info.rst
View File

@ -10,7 +10,7 @@ Syntax
info args info args
* args = one or more of the following keywords: *out*\ , *all*\ , *system*\ , *memory*\ , *communication*\ , *computes*\ , *dumps*\ , *fixes*\ , *groups*\ , *regions*\ , *variables*\ , *coeffs*\ , *styles*\ , *time*\ , or *configuration* * args = one or more of the following keywords: *out*\ , *all*\ , *system*\ , *memory*\ , *communication*\ , *computes*\ , *dumps*\ , *fixes*\ , *groups*\ , *regions*\ , *variables*\ , *coeffs*\ , *styles*\ , *time*\ , *accelerator*\ , or *configuration*
* *out* values = *screen*\ , *log*\ , *append* filename, *overwrite* filename * *out* values = *screen*\ , *log*\ , *append* filename, *overwrite* filename
* *styles* values = *all*\ , *angle*\ , *atom*\ , *bond*\ , *compute*\ , *command*\ , *dump*\ , *dihedral*\ , *fix*\ , *improper*\ , *integrate*\ , *kspace*\ , *minimize*\ , *pair*\ , *region* * *styles* values = *all*\ , *angle*\ , *atom*\ , *bond*\ , *compute*\ , *command*\ , *dump*\ , *dihedral*\ , *fix*\ , *improper*\ , *integrate*\ , *kspace*\ , *minimize*\ , *pair*\ , *region*
@ -88,6 +88,10 @@ The *coeffs* category prints a list for each defined force style
corresponding coefficients have been set. This can be very helpful corresponding coefficients have been set. This can be very helpful
to debug error messages like "All pair coeffs are not set". to debug error messages like "All pair coeffs are not set".
The *accelerator* category prints out information about compile time
settings of included accelerator support for the GPU, KOKKOS, USER-INTEL,
and USER-OMP packages.
The *styles* category prints the list of styles available in the The *styles* category prints the list of styles available in the
current LAMMPS binary. It supports one of the following options current LAMMPS binary. It supports one of the following options
to control which category of styles is printed out: to control which category of styles is printed out: