monitor_obj Derived Type

type, private :: monitor_obj

A monitor object made of a collection of columns.


Inherits

type~~monitor_obj~~InheritsGraph type~monitor_obj monitor_obj type~column_obj column_obj type~monitor_obj->type~column_obj col

Inherited by

type~~monitor_obj~~InheritedByGraph type~monitor_obj monitor_obj type~monitor_set monitor_set type~monitor_set->type~monitor_obj m type~cdifs_obj cdifs_obj type~cdifs_obj->type~monitor_set monitors, pmonitor type~collision_obj collision_obj type~cdifs_obj->type~collision_obj collisions type~marker_set marker_set type~cdifs_obj->type~marker_set IB type~respart_set ResPart_set type~cdifs_obj->type~respart_set RP type~collision_obj->type~monitor_set monitors type~collision_obj->type~marker_set IB type~particle_set particle_set type~collision_obj->type~particle_set PP type~collision_obj->type~respart_set RP type~grans_obj grans_obj type~grans_obj->type~monitor_set monitors type~grans_obj->type~collision_obj collisions type~grans_obj->type~marker_set IB type~grans_obj->type~particle_set PP type~grans_obj->type~respart_set RP type~marker_set->type~monitor_set monitors type~particle_set->type~monitor_set monitors type~respart_set->type~monitor_set monitors type~respart_set->type~marker_set ib type~solid_obj solid_obj type~solid_obj->type~marker_set type~solid_set solid_set type~solid_set->type~solid_obj p

Components

Type Visibility Attributes Name Initial
character(len=16), public :: FMT(4)

Format specifiers
type(column_obj), public, allocatable :: col(:)

Columns
integer, public :: fid

Monitor IO unit
character(len=monSize), public :: name

Name of the monitor file
character(len=1), public :: sep

Column seperator
logical, public :: stdout

Print to stdout

Type-Bound Procedures

procedure, public :: Finalize => monitor_obj_Final

Finalize a monitor object

  • private impure subroutine monitor_obj_Final(this)

    Finalizes the object and frees memory.

    Arguments

    Type IntentOptional Attributes Name
    class(monitor_obj), intent(inout) :: this

    A monitor object

procedure, public :: Formats => monitor_obj_Formats

Define the format specifiers

  • private pure subroutine monitor_obj_Formats(this)

    Defines how to print values. Format specifier for an integer Format specifier for a real Format specifier for a logical Format specifier for a full line

    Arguments

    Type IntentOptional Attributes Name
    class(monitor_obj), intent(inout) :: this

    A monitor object

procedure, public :: Initialize => monitor_obj_Init

Intialize a monitor object

  • private impure subroutine monitor_obj_Init(this, name, ncol, sep)

    Intializes a single monitor.

    Arguments

    Type IntentOptional Attributes Name
    class(monitor_obj), intent(inout) :: this

    A monitor object
    character(len=*), intent(in) :: name

    Name of the monitor
    integer, intent(in) :: ncol

    Number of columns
    character(len=*), intent(in), optional :: sep

    Column separator

procedure, public :: Print => monitor_obj_Print

Print the content of this monitor

  • private impure subroutine monitor_obj_Print(this, print_labels)

    Prints to file or stdout content of the monitor

    Arguments

    Type IntentOptional Attributes Name
    class(monitor_obj), intent(inout) :: this

    A monitor object
    logical, intent(in) :: print_labels

    True if we want to print labels

procedure, public :: SetVal => monitor_obj_SetVal

Set the value

  • private impure subroutine monitor_obj_SetVal(this, n, value)

    Sets the value in the nth column of a monitor.

    Arguments

    Type IntentOptional Attributes Name
    class(monitor_obj), intent(inout) :: this

    A monitor object
    integer, intent(in) :: n

    Column index
    class(*), intent(in) :: value

    Value

Source Code

  type :: monitor_obj
    !> A monitor object made of a collection of columns.
    type(column_obj),   &
           allocatable :: col(:)                                               !! Columns
    integer            :: fid                                                  !! Monitor IO unit
    character(monSize) :: name                                                 !! Name of the monitor file
    logical            :: stdout                                               !! Print to stdout
    character(len=1)   :: sep                                                  !! Column seperator
    character(len=16)  :: FMT(4)                                               !! Format specifiers
    contains
      procedure :: Initialize => monitor_obj_Init                              !! Intialize a monitor object
      procedure :: Finalize   => monitor_obj_Final                             !! Finalize a monitor object
      procedure :: Print      => monitor_obj_Print                             !! Print the content of this monitor
      procedure :: Formats    => monitor_obj_Formats                           !! Define the format specifiers
      procedure :: SetVal     => monitor_obj_SetVal                            !! Set the value
  end type monitor_obj