LoggingModule Module

  1. LoggingModule.F90
  2. LoggingModule

A module for writing data to the log file.


Uses


Contents

Interfaces

Subroutines


Interfaces

public interface WriteListElement

  • private subroutine WriteListElement_bool(key, VALUE)

    Write out a list element.

    Arguments

    Type IntentOptional AttributesName
    character(len=*), intent(in) :: key

    Some text to write.
    logical, intent(in) :: VALUE

    A bool value to write.

  • private subroutine WriteListElement_float(key, VALUE)

    Write out a list element.

    Arguments

    Type IntentOptional AttributesName
    character(len=*), intent(in) :: key

    Some text to write.
    real(kind=NTReal), intent(in) :: VALUE

    A float value to write.

  • private subroutine WriteListElement_int(key, VALUE)

    Write out a list element.

    Arguments

    Type IntentOptional AttributesName
    character(len=*), intent(in) :: key

    Some text to write.
    integer, intent(in) :: VALUE

    An integer value to write.

  • private subroutine WriteListElement_string(key, VALUE)

    Write out a list element.

    Arguments

    Type IntentOptional AttributesName
    character(len=*), intent(in) :: key

    Some text to write.
    character(len=*), intent(in), optional :: VALUE

    A text value to write.

public interface WriteElement

  • private subroutine WriteElement_bool(key, VALUE)

    Write out a element.

    Arguments

    Type IntentOptional AttributesName
    character(len=*), intent(in) :: key

    Some text to write.
    logical, intent(in) :: VALUE

    An integer value to write.

  • private subroutine WriteElement_float(key, VALUE)

    Write out a element.

    Arguments

    Type IntentOptional AttributesName
    character(len=*), intent(in) :: key

    Some text to write.
    real(kind=NTReal), intent(in) :: VALUE

    A float value to write.

  • private subroutine WriteElement_int(key, VALUE)

    Write out a element.

    Arguments

    Type IntentOptional AttributesName
    character(len=*), intent(in) :: key

    Some text to write.
    integer, intent(in) :: VALUE

    An integer value to write.

  • private subroutine WriteElement_string(key, VALUE)

    Write out a element.

    Arguments

    Type IntentOptional AttributesName
    character(len=*), intent(in) :: key

    Some text to write.
    character(len=*), intent(in), optional :: VALUE

    A text value to write.

Subroutines

public subroutine ActivateLogger(start_document_in, file_name_in, unit_in)

Activate the logger.

Arguments

Type IntentOptional AttributesName
logical, intent(in), optional :: start_document_in

If this is a new document we can write the start document marker.
character(len=*), intent(in), optional :: file_name_in

An optional file name for writing to.
integer, intent(in), optional :: unit_in

An optional fortran i/o unit override.

public subroutine DeactivateLogger()

Deactivate the logger.

Arguments

None

public subroutine EnterSubLog()

Call this subroutine when you enter into a section with verbose output

Arguments

None

public subroutine ExitSubLog()

Call this subroutine when you exit a section with verbose output

Arguments

None

public subroutine SetInitialOffset(offset)

Set a manual initial offset spacing.

Arguments

Type IntentOptional AttributesName
integer, intent(in) :: offset

Number of spaces to offset

public subroutine WriteHeader(header_value)

Write out a header to the log.

Arguments

Type IntentOptional AttributesName
character(len=*), intent(in) :: header_value

The text of the header.