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

update documentation for the extract_global() method of the lammps.lammps class

Browse Source
This commit is contained in:
Axel Kohlmeyer
2021-04-01 09:31:54 -04:00
parent 029db1413e
commit c9652f3aa6
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
python/lammps/core.py
View File

@ -729,12 +729,11 @@ class lammps(object):
def extract_global(self, name, dtype=LAMMPS_AUTODETECT): def extract_global(self, name, dtype=LAMMPS_AUTODETECT):
"""Query LAMMPS about global settings of different types. """Query LAMMPS about global settings of different types.
This is a wrapper around the :cpp:func:`lammps_extract_global` This is a wrapper around the :cpp:func:`lammps_extract_global` function
function of the C-library interface. Unlike the C function of the C-library interface. Since there are no pointers in Python, this
this method returns the value and not a pointer and thus can method will - unlike the C function - return the value or a list of
only return the first value for keywords representing a list values. The :cpp:func:`lammps_extract_global` documentation includes a
of values. The :cpp:func:`lammps_extract_global` documentation list of the supported keywords and their data types.
includes a list of the supported keywords and their data types.
Since Python needs to know the data type to be able to interpret Since Python needs to know the data type to be able to interpret
the result, by default, this function will try to auto-detect the data type the result, by default, this function will try to auto-detect the data type
by asking the library. You can also force a specific data type. For that by asking the library. You can also force a specific data type. For that