fix some broken links

This commit is contained in:
Axel Kohlmeyer
2022-02-14 11:55:04 -05:00
parent fbf95c2cbc
commit 1a436c5aa9

View File

@ -21,18 +21,21 @@ In that case, the functions will stop with an error message, indicating
the name of the problematic file, if possible unless the *error* argument the name of the problematic file, if possible unless the *error* argument
is a NULL pointer. is a NULL pointer.
The :cpp:func:`fgets_trunc` function will work similar for ``fgets()`` The :cpp:func:`utils::fgets_trunc() <LAMMPS_NS::utils::fgets_trunc>`
but it will read in a whole line (i.e. until the end of line or end function will work similar for ``fgets()`` but it will read in a whole
of file), but store only as many characters as will fit into the buffer line (i.e. until the end of line or end of file), but store only as many
including a final newline character and the terminating NULL byte. characters as will fit into the buffer including a final newline
If the line in the file is longer it will thus be truncated in the buffer. character and the terminating NULL byte. If the line in the file is
This function is used by :cpp:func:`read_lines_from_file` to read individual longer it will thus be truncated in the buffer. This function is used
lines but make certain they follow the size constraints. by :cpp:func:`utils::read_lines_from_file()
<LAMMPS_NS::utils::read_lines_from_file>` to read individual lines but
make certain they follow the size constraints.
The :cpp:func:`read_lines_from_file` function will read the requested The :cpp:func:`utils::read_lines_from_file()
number of lines of a maximum length into a buffer and will return 0 <LAMMPS_NS::utils::read_lines_from_file>` function will read the
if successful or 1 if not. It also guarantees that all lines are requested number of lines of a maximum length into a buffer and will
terminated with a newline character and the entire buffer with a return 0 if successful or 1 if not. It also guarantees that all lines
are terminated with a newline character and the entire buffer with a
NULL character. NULL character.
---------- ----------
@ -62,7 +65,7 @@ silently returning the result of a partial conversion or zero in cases
where the string is not a valid number. This behavior improves where the string is not a valid number. This behavior improves
detecting typos or issues when processing input files. detecting typos or issues when processing input files.
Similarly the :cpp:func:`logical() <LAMMPS_NS::utils::logical>` function Similarly the :cpp:func:`utils::logical() <LAMMPS_NS::utils::logical>` function
will convert a string into a boolean and will only accept certain words. will convert a string into a boolean and will only accept certain words.
The *do_abort* flag should be set to ``true`` in case this function The *do_abort* flag should be set to ``true`` in case this function
@ -70,8 +73,8 @@ is called only on a single MPI rank, as that will then trigger the
a call to ``Error::one()`` for errors instead of ``Error::all()`` a call to ``Error::one()`` for errors instead of ``Error::all()``
and avoids a "hanging" calculation when run in parallel. and avoids a "hanging" calculation when run in parallel.
Please also see :cpp:func:`is_integer() <LAMMPS_NS::utils::is_integer>` Please also see :cpp:func:`utils::is_integer() <LAMMPS_NS::utils::is_integer>`
and :cpp:func:`is_double() <LAMMPS_NS::utils::is_double>` for testing and :cpp:func:`utils::is_double() <LAMMPS_NS::utils::is_double>` for testing
strings for compliance without conversion. strings for compliance without conversion.
---------- ----------
@ -393,21 +396,26 @@ A typical code segment would look like this:
---------- ----------
.. file-reader-classes:
File reader classes File reader classes
------------------- -------------------
The purpose of the file reader classes is to simplify the recurring task The purpose of the file reader classes is to simplify the recurring task
of reading and parsing files. They can use the of reading and parsing files. They can use the
:cpp:class:`LAMMPS_NS::ValueTokenizer` class to process the read in :cpp:class:`ValueTokenizer <LAMMPS_NS::ValueTokenizer>` class to process
text. The :cpp:class:`LAMMPS_NS::TextFileReader` is a more general the read in text. The :cpp:class:`TextFileReader
version while :cpp:class:`LAMMPS_NS::PotentialFileReader` is specialized <LAMMPS_NS::TextFileReader>` is a more general version while
to implement the behavior expected for looking up and reading/parsing :cpp:class:`PotentialFileReader <LAMMPS_NS::PotentialFileReader>` is
files with potential parameters in LAMMPS. The potential file reader specialized to implement the behavior expected for looking up and
class requires a LAMMPS instance, requires to be run on MPI rank 0 only, reading/parsing files with potential parameters in LAMMPS. The
will use the :cpp:func:`LAMMPS_NS::utils::get_potential_file_path` potential file reader class requires a LAMMPS instance, requires to be
function to look up and open the file, and will call the run on MPI rank 0 only, will use the
:cpp:class:`LAMMPS_NS::Error` class in case of failures to read or to :cpp:func:`utils::get_potential_file_path
convert numbers, so that LAMMPS will be aborted. <LAMMPS_NS::utils::get_potential_file_path>` function to look up and
open the file, and will call the :cpp:class:`LAMMPS_NS::Error` class in
case of failures to read or to convert numbers, so that LAMMPS will be
aborted.
.. code-block:: C++ .. code-block:: C++
:caption: Use of PotentialFileReader class in pair style coul/streitz :caption: Use of PotentialFileReader class in pair style coul/streitz
@ -482,10 +490,10 @@ provided, as that is used to determine whether a new page of memory
must be used. must be used.
The :cpp:class:`MyPage <LAMMPS_NS::MyPage>` class offers two ways to The :cpp:class:`MyPage <LAMMPS_NS::MyPage>` class offers two ways to
reserve a chunk: 1) with :cpp:func:`get() <LAMMPS_NS::MyPage::get>` the reserve a chunk: 1) with :cpp:func:`MyPage::get() <LAMMPS_NS::MyPage::get>` the
chunk size needs to be known in advance, 2) with :cpp:func:`vget() chunk size needs to be known in advance, 2) with :cpp:func:`MyPage::vget()
<LAMMPS_NS::MyPage::vget>` a pointer to the next chunk is returned, but <LAMMPS_NS::MyPage::vget>` a pointer to the next chunk is returned, but
its size is registered later with :cpp:func:`vgot() its size is registered later with :cpp:func:`MyPage::vgot()
<LAMMPS_NS::MyPage::vgot>`. <LAMMPS_NS::MyPage::vgot>`.
.. code-block:: C++ .. code-block:: C++
@ -588,4 +596,3 @@ the communication buffers.
.. doxygenunion:: LAMMPS_NS::ubuf .. doxygenunion:: LAMMPS_NS::ubuf
:project: progguide :project: progguide