document removal of Error::message()

This commit is contained in:
Axel Kohlmeyer
2025-06-26 18:43:14 -04:00
parent 77ea2b3af0
commit a02eff6e40
2 changed files with 25 additions and 0 deletions

View File

@ -30,6 +30,7 @@ Available topics in mostly chronological order are:
- `Use Output::get_dump_by_id() instead of Output::find_dump()`_
- `Refactored grid communication using Grid3d/Grid2d classes instead of GridComm`_
- `FLERR as first argument to minimum image functions in Domain class`_
- `Use utils::logmesg() instead of error->warning()`_
----
@ -655,3 +656,26 @@ New:
double r2 = sqrt(delx2 * delx2 + dely2 * dely2 + delz2 * delz2);
This change is **required** or else the code will not compile.
Use utils::logmesg() instead of error->warning()
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. versionchanged:: TBD
The ``Error::message()`` method has been removed since its functionality
has been superseded by the :cpp:func:`utils::logmesg` function.
Old:
.. code-block:: c++
if (comm->me == 0) {
error->message(FLERR, "INFO: About to read data file: {}", filename);
}
New:
.. code-block:: c++
if (comm->me == 0) utils::logmesg(lmp, "INFO: About to read data file: {}\n", filename);

View File

@ -2094,6 +2094,7 @@ Loewen
logfile
logfreq
logicals
logmesg
loID
Lomdahl
Lond