% $Id$

% Earth System Modeling Framework
% Copyright (c) 2002-2023, University Corporation for Atmospheric Research, 
% Massachusetts Institute of Technology, Geophysical Fluid Dynamics 
% Laboratory, University of Michigan, National Centers for Environmental 
% Prediction, Los Alamos National Laboratory, Argonne National Laboratory, 
% NASA Goddard Space Flight Center.
% Licensed under the University of Illinois-NCSA License.

%TODO: This file started as an exact copy of the Fortran version of this file.
%TODO: Changes were made to correctly reflect the current status of the C API.
%TODO: Eventually this file should be removed again and replaced by a single
%TODO: generic version that can be included for both Fortran and C refdocs.

%\subsection{Description}
\label{sec:Log}

The Log class consists of a variety of methods for writing error, warning, and
informational messages to files.  A default Log is created at ESMF
initialization.

When ESMF is started with {\tt ESMC\_Initialize()}, multiple Log files will
be created by PET number.  The PET number (in the format
{\tt PETx.}) will be prepended to each file name where x is the PET number.
The {\tt ESMC\_LogWrite()} call is used to issue messages to the log.  As
part of the call, a message can be tagged as either an informational,
warning, or error message.

The messages may be buffered within ESMF before appearing in the log.
All messages will be properly flushed to the log files when {\tt ESMC\_Finalize()}
is called.
