FLASH-X
Doxygen Generated Documentation From Interface Source Code
Functions/Subroutines
Logfile_stamp.F90 File Reference

Go to the source code of this file.

Functions/Subroutines

subroutine Logfile_stampInt (intVal, tag, attrib)
 
subroutine Logfile_stampIntArray (intArr, len, tag, attrib)
 
subroutine Logfile_stampReal (realVal, tag, attrib)
 
subroutine Logfile_stampRealArray (realArr, len, tag, attrib)
 
subroutine Logfile_stampStr (string, tag, attrib)
 
subroutine Logfile_stampStrArray (strArr, len, tag, attrib)
 
subroutine Logfile_stampStrPair (strArr, len, dimen, tag, attrib)
 

Function/Subroutine Documentation

◆ Logfile_stampInt()

subroutine Logfile_stampInt ( integer  intVal,
character(len=*), intent(in)  tag,
character(len=*), intent(in)  attrib 
)

Logfile_stamp is an overloaded subroutine and includes Logfile_stampInt Logfile_stampReal Logfile_stampStr Logfile_stampIntArray Logfile_stampRealArray Logfile_stampStrArray Logfile_stampStrPair

Each subroutine stamps the date and time along with a value and message into the logfile. Typical uses are when the grid package stamps the logfile if it refines or derefines the grid. The IO unit will call Logfile_stamp when it reads or writes data to a checkpoint file.

Arguments vary slightly for the routines but in general val - int_val, real_val, intArrayVal, a value to put into the logfile tag - string identifier, often of the routine stamping the logfile. (see example below) attrib - !!DEV! optional argument, not currently implemented.

NOTES

Because Logfile_stamp is an overloaded subroutine _and_ also has optional arguments, most compilers require that any routine calling Logfile_stamp must include the header file Logfile.h.

Variables that begin with "log_" are defined in the fortran module Logfile_data. The prefix "log_" is meant to indicate that these variables have Logfile unit scope. Other variables are local to the individual subroutines

EXAMPLE example call for stamping a string call Logfile_stamp( 'read 159 blocks from file', '[IO_readCheckpoint]')

Definition at line 62 of file Logfile_stamp.F90.

◆ Logfile_stampIntArray()

subroutine Logfile_stampIntArray ( integer  intArr,
integer, intent(in)  len,
character(len=*), intent(in)  tag,
character(len=*), intent(in)  attrib 
)

Definition at line 73 of file Logfile_stamp.F90.

◆ Logfile_stampReal()

subroutine Logfile_stampReal ( real  realVal,
character(len=*), intent(in)  tag,
character(len=*), intent(in)  attrib 
)

Definition at line 86 of file Logfile_stamp.F90.

◆ Logfile_stampRealArray()

subroutine Logfile_stampRealArray ( real  realArr,
integer, intent(in)  len,
character(len=*), intent(in)  tag,
character(len=*), intent(in)  attrib 
)

Definition at line 97 of file Logfile_stamp.F90.

◆ Logfile_stampStr()

subroutine Logfile_stampStr ( character(len=*), intent(in)  string,
character(len=*), intent(in)  tag,
character(len=*), intent(in)  attrib 
)

Definition at line 109 of file Logfile_stamp.F90.

◆ Logfile_stampStrArray()

subroutine Logfile_stampStrArray ( character(len=*)  strArr,
integer, intent(in)  len,
character(len=*), intent(in)  tag,
character(len=*), intent(in)  attrib 
)

Definition at line 119 of file Logfile_stamp.F90.

◆ Logfile_stampStrPair()

subroutine Logfile_stampStrPair ( character(len=*)  strArr,
integer, intent(in)  len,
integer, intent(in)  dimen,
character(len=*), intent(in)  tag,
character(len=*), intent(in)  attrib 
)

Definition at line 132 of file Logfile_stamp.F90.