tem_timeformatter_module Module

Formatting of time points.

The formatters alllow the specification of how time-stamps for given time objects are to be formatted.



Variables

Type Visibility Attributes Name Initial
character(len=8), private, parameter :: default_form = '(EN12.3)'

Abstract Interfaces

abstract interface

  • private function timestamp(formatter, time) result(stamp)

    Arguments

    Type IntentOptional Attributes Name
    class(tem_timeformatter_type), intent(in) :: formatter
    type(tem_time_type), intent(in) :: time

    Return Value character(len=LabelLen)


Derived Types

type, public ::  tem_timeformatter_type

Components

Type Visibility Attributes Name Initial
character(len=labelLen), public :: timeform = default_form
procedure(timestamp), public, pointer, pass(formatter) :: stamp => null()

Functions

public function tem_timeformatter_init(timeform, stamp) result(formatter)

Reading a timeformatter description from a Lua script given by conf.

Read more…

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in), optional :: timeform
procedure(timestamp), optional :: stamp

Return Value type(tem_timeformatter_type)

private function tem_timeformatter_sim_stamp(formatter, time) result(timeStamp)

Generate a time stamp from the simulation time in the given time definition.

Read more…

Arguments

Type IntentOptional Attributes Name
class(tem_timeformatter_type), intent(in) :: formatter

Formatting object to generate the time stamp

type(tem_time_type), intent(in) :: time

Time definition to create the stamp off.

Return Value character(len=labelLen)

String representation of the given simulation time.

private function tem_timeformatter_iter_stamp(formatter, time) result(timeStamp)

Generate a time stamp from the iteration in the given time definition.

Arguments

Type IntentOptional Attributes Name
class(tem_timeformatter_type), intent(in) :: formatter

Formatting object to generate the time stamp

type(tem_time_type), intent(in) :: time

Time definition to create the stamp off.

Return Value character(len=labelLen)

String representation of the given simulation time.


Subroutines

public subroutine tem_timeformatter_load(me, conf, key, parent, use_iter_default)

Reading a timeformatter description from a Lua script given by conf.

Read more…

Arguments

Type IntentOptional Attributes Name
type(tem_timeformatter_type), intent(out) :: me

Time to be read from the Lua script

type(flu_State), intent(inout) :: conf

Handle to the Lua script.

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

Name of the table containing the time definition. Default: 'time'.

integer, intent(in), optional :: parent

Handle to the parent table.

logical, intent(in), optional :: use_iter_default

Default for the use_iter setting