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

Fixed spacing on type lammps fields

Browse Source
This commit is contained in:
Karl Hammond
2022-10-21 00:09:17 -05:00
parent 112d616e57
commit 7ce04c8fe1
1 changed files with 108 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

162
doc/src/Fortran.rst
View File

@ -230,67 +230,121 @@ Below is an example demonstrating some of the possible uses.
The ``LIBLAMMPS`` module API The ``LIBLAMMPS`` module API
**************************** ****************************
**Module** :f:mod:`LIBLAMMPS`
Below are the detailed descriptions of definitions and interfaces Below are the detailed descriptions of definitions and interfaces
of the contents of the ``LIBLAMMPS`` Fortran interface to LAMMPS. of the contents of the ``LIBLAMMPS`` Fortran interface to LAMMPS.
.. f:type:: lammps .. f:type:: lammps
Derived type that is the general class of the Fortran interface. It Derived type that is the general class of the Fortran interface.
holds a reference to the :cpp:class:`LAMMPS <LAMMPS_NS::LAMMPS>` It holds a reference to the :cpp:class:`LAMMPS <LAMMPS_NS::LAMMPS>`
class instance that any of the included calls are forwarded to. class instance to which any of the included calls are forwarded.
:f c_ptr handle: reference to the LAMMPS class :f handle: reference to the LAMMPS class
:f type(lammps_style) style: derived type to access lammps style constants :ftype handle: c_ptr
:f type(lammps_type) type: derived type to access lammps type constants :f style: derived type to access lammps style constants
:f subroutine close: :f:func:`close` :ftype style: type(lammps_style)
:f subroutine error: :f:func:`error` :f type: derived type to access lammps type constants
:f subroutine file: :f:func:`file` :ftype type: type(lammps_type)
:f subroutine command: :f:func:`command` :f close: :f:subr:`close`
:f subroutine commands_list: :f:func:`commands_list` :ftype close: subroutine
:f subroutine commands_string: :f:func:`commands_string` :f subroutine error: :f:subr:`error`
:f function get_natoms: :f:func:`get_natoms` :ftype error: subroutine
:f function get_thermo: :f:func:`get_thermo` :f file: :f:subr:`file`
:f subroutine extract_box: :f:func:`extract_box` :ftype file: subroutine
:f subroutine reset_box: :f:func:`reset_box` :f command: :f:subr:`command`
:f subroutine memory_usage: :f:func:`memory_usage` :ftype command: subroutine
:f function get_mpi_comm: :f:func:`get_mpi_comm` :f commands_list: :f:subr:`commands_list`
:f function extract_setting: :f:func:`extract_setting` :ftype commands_list: subroutine
:f function extract_global: :f:func:`extract_global` :f commands_string: :f:subr:`commands_string`
:ftype commands_string: subroutine
:f get_natoms: :f:func:`get_natoms`
:ftype get_natoms: function
:f get_thermo: :f:func:`get_thermo`
:ftype get_thermo: function
:f extract_box: :f:subr:`extract_box`
:ftype extract_box: subroutine
:f reset_box: :f:subr:`reset_box`
:ftype reset_box: subroutine
:f memory_usage: :f:subr:`memory_usage`
:ftype memory_usage: subroutine
:f get_mpi_comm: :f:func:`get_mpi_comm`
:ftype get_mpi_comm: function
:f extract_setting: :f:func:`extract_setting`
:ftype extract_setting: function
:f extract_global: :f:func:`extract_global`
:ftype extract_global: function
:f function extract_atom: :f:func:`extract_atom` :f function extract_atom: :f:func:`extract_atom`
:f function extract_compute: :f:func:`extract_compute` :ftype extract_atom: function
:f function extract_fix: :f:func:`extract_fix` :f extract_compute: :f:func:`extract_compute`
:f function extract_variable: :f:func:`extract_variable` :ftype extract_compute: function
:f subroutine gather_atoms: :f:func:`gather_atoms` :f extract_fix: :f:func:`extract_fix`
:f subroutine gather_atoms_concat: :f:func:`gather_atoms_concat` :ftype extract_fix: function
:f subroutine gather_atoms_subset: :f:func:`gather_atoms_subset` :f extract_variable: :f:func:`extract_variable`
:f subroutine scatter_atoms: :f:func:`scatter_atoms` :ftype extract_variable: function
:f subroutine scatter_atoms_subset: :f:func:`scatter_atoms_subset` :f gather_atoms: :f:subr:`gather_atoms`
:f subroutine create_atoms: :f:func:`create_atoms` :ftype gather_atoms: subroutine
:f function version: :f:func:`version` :f gather_atoms_concat: :f:subr:`gather_atoms_concat`
:f subroutine get_os_info: :f:func:`get_os_info` :ftype gather_atoms_concat: subroutine
:f function config_has_mpi_support: :f:func:`config_has_mpi_support` :f gather_atoms_subset: :f:subr:`gather_atoms_subset`
:f function config_has_gzip_support: :f:func:`config_has_gzip_support` :ftype gather_atoms_subset: subroutine
:f function config_has_png_support: :f:func:`config_has_png_support` :f scatter_atoms: :f:subr:`scatter_atoms`
:f function config_has_jpeg_support: :f:func:`config_has_jpeg_support` :ftype scatter_atoms: subroutine
:f function config_has_ffmpeg_support: :f:func:`config_has_ffmpeg_support` :f scatter_atoms_subset: :f:subr:`scatter_atoms_subset`
:f function config_has_exceptions: :f:func:`config_has_exceptions` :ftype scatter_atoms_subset: subroutine
:f function config_has_package: :f:func:`config_has_package` :f create_atoms: :f:subr:`create_atoms`
:f function config_package_count: :f:func:`config_package_count` :ftype create_atoms: subroutine
:f function config_package_name: :f:func:`config_package_name` :f version: :f:func:`version`
:f subroutine installed_packages: :f:func:`installed_packages` :ftype version: function
:f function config_accelerator: :f:func:`config_accelerator` :f get_os_info: :f:subr:`get_os_info`
:f function has_gpu_device: :f:func:`has_gpu_device` :ftype get_os_info: subroutine
:f subroutine get_gpu_device_info: :f:func:`get_gpu_device_info` :f config_has_mpi_support: :f:func:`config_has_mpi_support`
:f function has_style: :f:func:`has_style` :ftype config_has_mpi_support: function
:f function style_count: :f:func:`style_count` :f config_has_gzip_support: :f:func:`config_has_gzip_support`
:f function style_name: :f:func:`style_name` :ftype config_has_gzip_support: function
:f function encode_image_flags: :f:func:`encode_image_flags` :f config_has_png_support: :f:func:`config_has_png_support`
:f subroutine decode_image_flags: :f:func:`decode_image_flags` :ftype config_has_png_support: function
:f subroutine flush_buffers: :f:func:`flush_buffers` :f config_has_jpeg_support: :f:func:`config_has_jpeg_support`
:f function is_running: :f:func:`is_running` :ftype config_has_jpeg_support: function
:f function force_timeout: :f:func:`force_timeout` :f config_has_ffmpeg_support: :f:func:`config_has_ffmpeg_support`
:f function has_error: :f:func:`has_error` :ftype config_has_ffmpeg_support: function
:f subroutine get_last_error_message: :f:func:`get_last_error_message` :f config_has_exceptions: :f:func:`config_has_exceptions`
:ftype config_has_exceptions: function
:f config_has_package: :f:func:`config_has_package`
:ftype config_has_package: function
:f config_package_count: :f:func:`config_package_count`
:ftype config_package_count: function
:f config_package_name: :f:func:`config_package_name`
:ftype config_package_name: function
:f installed_packages: :f:subr:`installed_packages`
:ftype installed_packages: subroutine
:f config_accelerator: :f:func:`config_accelerator`
:ftype config_accelerator: function
:f has_gpu_device: :f:func:`has_gpu_device`
:ftype has_gpu_device: function
:f get_gpu_device_info: :f:subr:`get_gpu_device_info`
:ftype get_gpu_device_info: subroutine
:f has_style: :f:func:`has_style`
:ftype has_style: function
:f style_count: :f:func:`style_count`
:ftype style_count: function
:f style_name: :f:func:`style_name`
:ftype style_name: function
:f encode_image_flags: :f:func:`encode_image_flags`
:ftype encode_image_flags: function
:f decode_image_flags: :f:subr:`decode_image_flags`
:ftype decode_image_flags: subroutine
:f flush_buffers: :f:subr:`flush_buffers`
:ftype flush_buffers: subroutine
:f is_running: :f:func:`is_running`
:ftype is_running: function
:f force_timeout: :f:subr:`force_timeout`
:ftype force_timeout: subroutine
:f has_error: :f:func:`has_error`
:ftype has_error: function
:f get_last_error_message: :f:subr:`get_last_error_message`
:ftype get_last_error_message: subroutine
-------- --------