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

Fixed a typo in library.cpp (documentation) and adjusted spacing to be consistent

Browse Source
This commit is contained in:
Karl Hammond
2022-10-04 14:35:24 -05:00
parent fcf415d0b1
commit 8fd19fe7fe
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/library.cpp
View File

@ -1145,7 +1145,7 @@ int lammps_extract_setting(void *handle, const char *keyword)
This function returns an integer that encodes the data type of the global This function returns an integer that encodes the data type of the global
property with the specified name. See :cpp:enum:`_LMP_DATATYPE_CONST` for valid property with the specified name. See :cpp:enum:`_LMP_DATATYPE_CONST` for valid
values. Callers of :cpp:func:`lammps_extract_global` can use this information values. Callers of :cpp:func:`lammps_extract_global` can use this information
to then decide how to cast the (void*) pointer and access the data. to then decide how to cast the ``void *`` pointer and access the data.
.. versionadded:: 18Sep2020 .. versionadded:: 18Sep2020
@ -1622,7 +1622,7 @@ void *lammps_extract_global(void *handle, const char *name)
This function returns an integer that encodes the data type of the per-atom This function returns an integer that encodes the data type of the per-atom
property with the specified name. See :cpp:enum:`_LMP_DATATYPE_CONST` for valid property with the specified name. See :cpp:enum:`_LMP_DATATYPE_CONST` for valid
values. Callers of :cpp:func:`lammps_extract_atom` can use this information values. Callers of :cpp:func:`lammps_extract_atom` can use this information
to then decide how to cast the (void*) pointer and access the data. to then decide how to cast the ``void *`` pointer and access the data.
.. versionadded:: 18Sep2020 .. versionadded:: 18Sep2020
@ -2080,7 +2080,7 @@ For *vector*\ -style variables, the returned pointer is to actual LAMMPS data.
The pointer should not be deallocated. Its length depends on the variable, The pointer should not be deallocated. Its length depends on the variable,
compute, or fix data used to construct the *vector*\ -style variable. compute, or fix data used to construct the *vector*\ -style variable.
This length can be fetched by calling this function with *group* set to the This length can be fetched by calling this function with *group* set to the
constant "LMP_SIZE_VECTOR", which returns a ``void\*`` pointer that can be constant "LMP_SIZE_VECTOR", which returns a ``void *`` pointer that can be
dereferenced to an integer that is the length of the vector. This pointer dereferenced to an integer that is the length of the vector. This pointer
needs to be deallocated when finished with it to avoid memory leaks. needs to be deallocated when finished with it to avoid memory leaks.
@ -2157,7 +2157,7 @@ void *lammps_extract_variable(void *handle, const char *name, const char *group)
This function returns an integer that encodes the data type of the variable This function returns an integer that encodes the data type of the variable
with the specified name. See :cpp:enum:`_LMP_VAR_CONST` for valid values. with the specified name. See :cpp:enum:`_LMP_VAR_CONST` for valid values.
Callers of :cpp:func:`lammps_extract_variable` can use this information to Callers of :cpp:func:`lammps_extract_variable` can use this information to
decide how to cast the (void*) pointer and access the data. decide how to cast the ``void *`` pointer and access the data.
.. versionadded:: TBD .. versionadded:: TBD