standard_header Module

Contains functions for creating a standard header for files and output


Uses


Contents


Interfaces

public interface standard_header_type

  • public function make_standard_header() result(this)

    Constructor for standard_header_type.

    Stores the date using date_is08601 and the UUID using simulation_run_uuid. Note that this may involve collective communication, so all processors should be involved in construction.

    Arguments

    None

    Return Value type(standard_header_type)


Derived Types

type, public ::  standard_header_type

A header for files and output.

Read more…

Components

Type Visibility Attributes Name Initial
character(len=:), public, allocatable :: date_time
character(len=uuid_len), public :: run_uuid

Constructor

public function make_standard_header ()

Constructor for standard_header_type.

Read more…

Type-Bound Procedures

procedure , public , :: to_string => standard_header_to_string Function

Functions

public function simulation_run_uuid()

Return the UUID for this run

Read more…

Arguments

None

Return Value character(len=uuid_len)

public function date_iso8601()

Return the current date and time in ISO8601 format: YYYY-MM-DDThh:mm:ss.ssssZhh:mm

Arguments

None

Return Value character(len=:), allocatable

public function make_standard_header() result(this)

Constructor for standard_header_type.

Read more…

Arguments

None

Return Value type(standard_header_type)

public function standard_header_to_string(this, comment_character, file_description) result(header)

Return a multiline string with a standard header of the form:

Read more…

Arguments

Type IntentOptional Attributes Name
class(standard_header_type), intent(in) :: this
character(len=*), intent(in), optional :: comment_character

Optional character(s) to start each line. Whitespace is not stripped or added. Default is empty string

character(len=*), intent(in), optional :: file_description

Optional file description. Treated as a single line, that is, new lines in this string will not begin with comment_character

Return Value character(len=:), allocatable