From 702de49f59f9464a95f691985fa9238af3f622ac Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Tue, 12 Jan 2021 20:11:38 -0500 Subject: [PATCH] add documentation for added keyword and library interface functions --- doc/src/Library_config.rst | 6 ++++++ doc/src/Python_config.rst | 4 +++- doc/src/info.rst | 6 +++++- 3 files changed, 14 insertions(+), 2 deletions(-) diff --git a/doc/src/Library_config.rst b/doc/src/Library_config.rst index 24c412a23d..a5b87e23a7 100644 --- a/doc/src/Library_config.rst +++ b/doc/src/Library_config.rst @@ -14,6 +14,7 @@ This section documents the following functions: - :cpp:func:`lammps_config_has_package` - :cpp:func:`lammps_config_package_count` - :cpp:func:`lammps_config_package_name` +- :cpp:func:`lammps_config_accelerator` - :cpp:func:`lammps_has_style` - :cpp:func:`lammps_style_count` - :cpp:func:`lammps_style_name` @@ -126,6 +127,11 @@ approach. ----------------------- +.. doxygenfunction:: lammps_config_accelerator + :project: progguide + +----------------------- + .. doxygenfunction:: lammps_has_style :project: progguide diff --git a/doc/src/Python_config.rst b/doc/src/Python_config.rst index 2803b041c5..38f0ef0baf 100644 --- a/doc/src/Python_config.rst +++ b/doc/src/Python_config.rst @@ -39,7 +39,9 @@ about compile time settings and included packages and styles. * :py:attr:`lammps.has_jpeg_support ` * :py:attr:`lammps.has_ffmpeg_support ` -* :py:attr:`lammps.installed_packages ` +* :py:attr:`lammps.installed_packages ` + +* :py:meth:`lammps.get_accelerator_config ` * :py:meth:`lammps.has_style() ` * :py:meth:`lammps.available_styles() ` diff --git a/doc/src/info.rst b/doc/src/info.rst index 77d430ea66..395bc2c1f4 100644 --- a/doc/src/info.rst +++ b/doc/src/info.rst @@ -10,7 +10,7 @@ Syntax 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 * *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 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 current LAMMPS binary. It supports one of the following options to control which category of styles is printed out: