monitor_set Derived Type

type, public :: monitor_set

A utility that manages and writes a collection of monitors.


Inherits

type~~monitor_set~~InheritsGraph type~monitor_set monitor_set type~hashtbl_obj hashtbl_obj type~monitor_set->type~hashtbl_obj tbl type~monitor_obj monitor_obj type~monitor_set->type~monitor_obj m type~parallel_obj parallel_obj type~monitor_set->type~parallel_obj parallel type~sllist_obj sllist_obj type~hashtbl_obj->type~sllist_obj vec type~column_obj column_obj type~monitor_obj->type~column_obj col MPI_Datatype MPI_Datatype type~parallel_obj->MPI_Datatype REAL_SP, REAL_DP, REAL_WP, COMPLEX_SP, COMPLEX_DP, COMPLEX_WP, INTEGER, INT8, LOGICAL type~communicators communicators type~parallel_obj->type~communicators comm type~patch patch type~parallel_obj->type~patch rank MPI_Comm MPI_Comm type~communicators->MPI_Comm w, g type~sllist_obj->type~sllist_obj child

Inherited by

type~~monitor_set~~InheritedByGraph type~monitor_set monitor_set 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
class(monitor_obj), public, allocatable :: m(:)

Array of monitors
type(parallel_obj), public, pointer :: parallel => null()

Associated parallel structure
type(hashtbl_obj), private :: tbl

Hash table

Type-Bound Procedures

procedure, public :: Create => monitor_set_Create

Create a new monitor

  • private impure subroutine monitor_set_Create(this, name, ncol, stdout, sep)

    Creates a new monitor.

    Arguments

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

    Set of monitor objects
    character(len=*), intent(in) :: name

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

    Number of columns
    logical, intent(in), optional :: stdout

    Switch to write to the stdout
    character(len=*), intent(in), optional :: sep

    Number of columns

procedure, public :: Expand => monitor_set_Expand

Add a new monitor slot

  • private pure subroutine monitor_set_Expand(this)

    Changes the size of monitors arrays to add 1 element.

    Arguments

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

    Set of monitor objects

procedure, public :: Finalize => monitor_set_Final

Finalize the structure

  • private impure subroutine monitor_set_Final(this)

    Finalizes object and frees memory.

    Arguments

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

    A set of monitor objects

procedure, public :: GetIndex => monitor_set_GetIndex

Return the index of a monitor

  • private impure function monitor_set_GetIndex(this, name) result(loc)

    Returns the ID of a monitor identified by name.

    Arguments

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

    Set of monitor objects
    character(len=*), intent(in) :: name

    Name of the monitor

    Return Value integer

    Monitor ID

procedure, public :: Info => monitor_set_Info

Print a number of diagnostics information

  • private impure subroutine monitor_set_Info(this)

    Print a number of diagnostics information.

    Arguments

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

    Set of monitor objects

procedure, public :: Initialize => monitor_set_Init

Initialize the structure

  • private impure subroutine monitor_set_Init(this, parallel)

    Initializes a set of monitors.

    Arguments

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

    A set of monitor objects
    type(parallel_obj), intent(in), target :: parallel

    Parallel structure to link with

procedure, public :: Print => monitor_set_Print

Print the content of the monitors

  • private impure subroutine monitor_set_Print(this, print_labels)

    Prints content of monitors.

    Arguments

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

    Set of monitor objects
    logical, intent(in), optional :: print_labels

    True if we want to print the labels

procedure, public :: Set => monitor_set_Set

Set the label or value of a monitor

  • private impure subroutine monitor_set_Set(this, name, colID, value, label)

    Sets the label or value of a column ofa a monitor given by name.

    Arguments

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

    Set of monitor objects
    character(len=*), intent(in) :: name

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

    Number of columns
    class(*), intent(in), optional :: value

    Value
    character(len=*), intent(in), optional :: label

    Column label

Source Code

  type :: monitor_set
    !> A utility that manages and writes a collection of monitors.
    class(monitor_obj), allocatable :: m(:)                                    !! Array of monitors
    type(parallel_obj), pointer     :: parallel=>null()                        !! Associated parallel structure
    type(hashtbl_obj),  private     :: tbl                                     !! Hash table
    contains
      procedure :: Initialize => monitor_set_Init                              !! Initialize the structure
      procedure :: Finalize   => monitor_set_Final                             !! Finalize the structure
      procedure :: Expand     => monitor_set_Expand                            !! Add a new monitor slot
      procedure :: Create     => monitor_set_Create                            !! Create a new monitor
      procedure :: Set        => monitor_set_Set                               !! Set the label or value of a monitor
      procedure :: GetIndex   => monitor_set_GetIndex                          !! Return the index of a monitor
      procedure :: Print      => monitor_set_Print                             !! Print the content of the monitors
      procedure :: Info       => monitor_set_Info                              !! Print a number of diagnostics information
  end type monitor_set