appendix.rst

Appendix

Slic Application Code Example

Below is the complete :ref:`SlicApplicationCodeExample` presented in the :ref:`sections/getting_started` section. The code can be found in the Axom source code under src/axom/slic/examples/basic/logging.cpp.

.. literalinclude:: ../../../examples/basic/logging.cpp
  :start-after: SPHINX_SLIC_BASIC_EXAMPLE_BEGIN
  :end-before: SPHINX_SLIC_BASIC_EXAMPLE_END
  :language: C++
  :linenos:

axom::utilities::processAbort()

The :ref:`axomProcessAbort` function gracefully aborts the application by:

1. Calling abort() if it is a serial application.
2. Calls MPI_Abort() if the `Axom Toolkit`_ is compiled with MPI and the application has initialized MPI, i.e., it's a distributed MPI application.

Slic Macros Used in Axom

Slic provides a set of convenience macros that can be used to streamline logging within an application.

Note

The :ref:`SlicMacros` are not the only interface to log messages with Slic. They are used within the `Axom Toolkit`_ for convenience. Applications or libraries that adopt Slic, typically, use the C++ API directly, e.g., call slic::logMessage() and wrap the functionality in application specific macros to better suit the requirements of the application.

Collective Slic Macros

A subset of SLIC macros are collective operations when used with MPI-aware :ref:`LogStream` instances such as :ref:`SynchronizedStream` or :ref:`LumberjackStream`.

Additionally, macros such as SLIC_WARNING and SLIC_CHECK become collective operations when certain flags are toggled on or functions are called. Other macros such as SLIC_ERROR and SLIC_ASSERT can be made not collective when certain functions are called.

The table below details which SLIC macros are collective:

Macro	Collective
SLIC_ASSERT SLIC_ASSERT_MSG	Collective by default. Collective after calling slic::enableAbortOnError(). No longer collective after calling slic::disableAbortOnError().
SLIC_CHECK SLIC_CHECK_MSG	Not collective by default. Collective after slic::debug::checksAreErrors is set to true, defaults to false.
SLIC_DEBUG SLIC_DEBUG_IF SLIC_DEBUG_ROOT SLIC_DEBUG_ROOT_IF	Never
SLIC_INFO SLIC_INFO_IF SLIC_INFO_ROOT SLIC_INFO_ROOT_IF	Never
SLIC_ERROR SLIC_ERROR_IF SLIC_ERROR_ROOT SLIC_ERROR_ROOT_IF	Collective by default. Collective after calling slic::enableAbortOnError(). No longer collective after calling slic::disableAbortOnError()
SLIC_WARNING SLIC_WARNING_IF SLIC_WARNING_ROOT SLIC_WARNING_ROOT_IF	Not collective by default. Collective after calling slic::enableAbortOnWarning(). No longer collective after calling slic::disableAbortOnWarning()

Doxygen generated API documentation on Macros can be found here: SLIC Macros