FLASH4.5 API

Generated from /asc/asci2/site/flashcode/secure/release_4p5/source/monitors/Logfile/Logfile_stamp.F90 with ROBODoc v4.99.8 on Tue Mar 05 16:16:16 2019

TABLE OF CONTENTS


[Functions] source/monitors/Logfile/Logfile_stamp

[top][index]

NAME

 Logfile_stamp

SYNOPSIS

  Logfile_stamp(int/real/str/log(in) :: val,
                char*(in)            :: tag,
                char*(in)            :: attrib)

DESCRIPTION

   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

  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]')