SABER
type_mpl Module Reference

MPI parameters derived type. More...

Data Types

type  mpl_type
 

Functions/Subroutines

subroutine mpl_newunit (mpl, lunit)
 Find a free unit. More...
 
subroutine mpl_init (mpl, f_comm)
 Initialize MPL object. More...
 
subroutine mpl_final (mpl)
 Finalize MPI. More...
 
subroutine mpl_flush (mpl, advance_flag)
 Flush listings. More...
 
subroutine mpl_abort (mpl, subr, message)
 Clean MPI abort. More...
 
subroutine mpl_warning (mpl, subr, message)
 Print warning message. More...
 
subroutine mpl_update_tag (mpl, add)
 Update MPI tag. More...
 
subroutine mpl_broadcast_string_1d (mpl, var, root)
 Broadcast 1d string array. More...
 
subroutine mpl_dot_prod_1d (mpl, fld1, fld2, dp)
 Global dot product over local fields, 1d. More...
 
subroutine mpl_dot_prod_2d (mpl, fld1, fld2, dp)
 Global dot product over local fields, 2d. More...
 
subroutine mpl_dot_prod_3d (mpl, fld1, fld2, dp)
 Global dot product over local fields, 3d. More...
 
subroutine mpl_dot_prod_4d (mpl, fld1, fld2, dp)
 Global dot product over local fields, 4d. More...
 
subroutine mpl_glb_to_loc_index (mpl, n_loc, loc_to_glb, n_glb, glb_to_loc, glb_to_proc, rootproc, pool)
 Communicate global index to local index. More...
 
subroutine mpl_glb_to_loc_integer_1d (mpl, n_loc, n_glb, loc_to_glb, glb, loc)
 Global to local, 1d array. More...
 
subroutine mpl_glb_to_loc_integer_2d (mpl, nl, n_loc, n_glb, loc_to_glb, glb, loc, rootproc, pool)
 Global to local, 2d array. More...
 
subroutine mpl_glb_to_loc_real_1d (mpl, n_loc, n_glb, loc_to_glb, glb, loc)
 Global to local, 1d array. More...
 
subroutine mpl_glb_to_loc_real_2d (mpl, nl, n_loc, n_glb, loc_to_glb, glb, loc, rootproc, pool)
 Global to local, 2d array. More...
 
subroutine mpl_glb_to_loc_logical_1d (mpl, n_loc, n_glb, loc_to_glb, glb, loc)
 Global to local, 1d array. More...
 
subroutine mpl_glb_to_loc_logical_2d (mpl, nl, n_loc, n_glb, loc_to_glb, glb, loc, rootproc, pool)
 Global to local, 2d array. More...
 
subroutine mpl_loc_to_glb_integer_1d (mpl, n_loc, n_glb, loc_to_glb, loc, glb, bcast)
 Local to global, 1d array. More...
 
subroutine mpl_loc_to_glb_integer_2d (mpl, nl, n_loc, n_glb, loc_to_glb, loc, glb, bcast)
 Local to global, 2d array. More...
 
subroutine mpl_loc_to_glb_real_1d (mpl, n_loc, n_glb, loc_to_glb, loc, glb, bcast)
 Local to global, 1d array. More...
 
subroutine mpl_loc_to_glb_real_2d (mpl, nl, n_loc, n_glb, loc_to_glb, loc, glb, bcast)
 Local to global, 2d array. More...
 
subroutine mpl_loc_to_glb_logical_1d (mpl, n_loc, n_glb, loc_to_glb, loc, glb, bcast)
 Local to global, 1d array. More...
 
subroutine mpl_loc_to_glb_logical_2d (mpl, nl, n_loc, n_glb, loc_to_glb, loc, glb, bcast)
 Local to global for a logical, 2d array. More...
 
subroutine mpl_prog_init (mpl, nprog)
 Initialize progression display. More...
 
subroutine mpl_prog_print (mpl, i)
 Print progression display. More...
 
subroutine mpl_prog_final (mpl, advance_flag)
 Finalize progression display. More...
 
integer function mpl_nc_file_create_or_open (mpl, subr, filename, f_comm)
 Create or open NetCDF file. More...
 
integer function mpl_nc_group_define_or_get (mpl, subr, ncid, grpname)
 Define or get group. More...
 
integer function mpl_nc_dim_define_or_get (mpl, subr, ncid, dimname, dimsize)
 Define or get (and check) NetCDF dimension. More...
 
integer function mpl_nc_dim_inquire (mpl, subr, ncid, dimname)
 Inquire NetCDF file dimension size. More...
 
subroutine mpl_nc_dim_check (mpl, subr, ncid, dimname, dimsize)
 Check if NetCDF file dimension exists and has the right size. More...
 
integer function mpl_nc_var_define_or_get (mpl, subr, ncid, varname, varkind, varshape, unitname)
 Define or get NetCDF variable. More...
 
subroutine mpl_ncerr (mpl, subr, info)
 Handle NetCDF error. More...
 
subroutine mpl_write_integer (mpl, ncid, prefix, variables, var)
 Write integer into a log file or into a NetCDF file. More...
 
subroutine mpl_write_integer_array (mpl, ncid, prefix, variables, n, var)
 Write integer array into a log file or into a NetCDF file. More...
 
subroutine mpl_write_real (mpl, ncid, prefix, variables, var)
 Write real into a log file or into a NetCDF file. More...
 
subroutine mpl_write_real_array (mpl, ncid, prefix, variables, n, var)
 Write real array into a log file or into a NetCDF file. More...
 
subroutine mpl_write_logical (mpl, ncid, prefix, variables, var)
 Write logical into a log file or into a NetCDF file. More...
 
subroutine mpl_write_logical_array (mpl, ncid, prefix, variables, n, var)
 Write logical array into a log file or into a NetCDF file. More...
 
subroutine mpl_write_string (mpl, ncid, prefix, variables, var)
 Write string into a log file or into a NetCDF file. More...
 
subroutine mpl_write_string_array (mpl, ncid, prefix, variables, n, var)
 Write string array into a log file or into a NetCDF file. More...
 

Variables

integer, parameter lunit_min =10
 Minimum unit number. More...
 
integer, parameter lunit_max =1000
 Maximum unit number. More...
 
integer, parameter ddis = 5
 Progression display step. More...
 

Detailed Description

MPI parameters derived type.

Function/Subroutine Documentation

◆ mpl_abort()

subroutine type_mpl::mpl_abort ( class(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  subr,
character(len=*), intent(in)  message 
)
private

Clean MPI abort.

Parameters
[in,out]mplMPI data
[in]subrCalling subroutine

Definition at line 344 of file type_mpl.F90.

◆ mpl_broadcast_string_1d()

subroutine type_mpl::mpl_broadcast_string_1d ( class(mpl_type), intent(in)  mpl,
character(len=*), dimension(:), intent(inout)  var,
integer, intent(in)  root 
)
private

Broadcast 1d string array.

Parameters
[in]mplMPI data
[in,out]varLogical array, 1d
[in]rootRoot task

Definition at line 406 of file type_mpl.F90.

◆ mpl_dot_prod_1d()

subroutine type_mpl::mpl_dot_prod_1d ( class(mpl_type), intent(in)  mpl,
real(kind_real), dimension(:), intent(in)  fld1,
real(kind_real), dimension(:), intent(in)  fld2,
real(kind_real), intent(out)  dp 
)
private

Global dot product over local fields, 1d.

Parameters
[in]mplMPI data
[in]fld1Field 1
[in]fld2Field 2
[out]dpGlobal dot product

Definition at line 429 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_dot_prod_2d()

subroutine type_mpl::mpl_dot_prod_2d ( class(mpl_type), intent(in)  mpl,
real(kind_real), dimension(:,:), intent(in)  fld1,
real(kind_real), dimension(:,:), intent(in)  fld2,
real(kind_real), intent(out)  dp 
)
private

Global dot product over local fields, 2d.

Parameters
[in]mplMPI data
[in]fld1Field 1
[in]fld2Field 2
[out]dpGlobal dot product

Definition at line 460 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_dot_prod_3d()

subroutine type_mpl::mpl_dot_prod_3d ( class(mpl_type), intent(in)  mpl,
real(kind_real), dimension(:,:,:), intent(in)  fld1,
real(kind_real), dimension(:,:,:), intent(in)  fld2,
real(kind_real), intent(out)  dp 
)
private

Global dot product over local fields, 3d.

Parameters
[in]mplMPI data
[in]fld1Field 1
[in]fld2Field 2
[out]dpGlobal dot product

Definition at line 491 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_dot_prod_4d()

subroutine type_mpl::mpl_dot_prod_4d ( class(mpl_type), intent(in)  mpl,
real(kind_real), dimension(:,:,:,:), intent(in)  fld1,
real(kind_real), dimension(:,:,:,:), intent(in)  fld2,
real(kind_real), intent(out)  dp 
)
private

Global dot product over local fields, 4d.

Parameters
[in]mplMPI data
[in]fld1Field 1
[in]fld2Field 2
[out]dpGlobal dot product

Definition at line 522 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_final()

subroutine type_mpl::mpl_final ( class(mpl_type), intent(inout)  mpl)
private

Finalize MPI.

Parameters
[in,out]mplMPI data

Definition at line 213 of file type_mpl.F90.

◆ mpl_flush()

subroutine type_mpl::mpl_flush ( class(mpl_type), intent(inout)  mpl,
logical, intent(in), optional  advance_flag 
)
private

Flush listings.

Parameters
[in,out]mplMPI data
[in]advance_flagAdvance flag

Definition at line 229 of file type_mpl.F90.

◆ mpl_glb_to_loc_index()

subroutine type_mpl::mpl_glb_to_loc_index ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  n_loc,
integer, dimension(n_loc), intent(in)  loc_to_glb,
integer, intent(in)  n_glb,
integer, dimension(:), intent(out)  glb_to_loc,
integer, dimension(:), intent(out)  glb_to_proc,
integer, intent(in), optional  rootproc,
logical, dimension(mpl%nproc), intent(in), optional  pool 
)
private

Communicate global index to local index.

Parameters
[in,out]mplMPI data
[in]n_locLocal dimension
[in]loc_to_glbLocal to global index
[in]n_glbGlobal dimension
[out]glb_to_locGlobal to local index
[out]glb_to_procGlobal to processor
[in]rootprocRoot task
[in]poolTasks pool

Definition at line 553 of file type_mpl.F90.

◆ mpl_glb_to_loc_integer_1d()

subroutine type_mpl::mpl_glb_to_loc_integer_1d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
integer, dimension(:), intent(in)  glb,
integer, dimension(n_loc), intent(out)  loc 
)
private

Global to local, 1d array.

Parameters
[in,out]mplMPI data
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]glbGlobal array
[out]locLocal array

Definition at line 642 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_glb_to_loc_integer_2d()

subroutine type_mpl::mpl_glb_to_loc_integer_2d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  nl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
integer, dimension(:,:), intent(in)  glb,
integer, dimension(n_loc,nl), intent(out)  loc,
integer, intent(in), optional  rootproc,
logical, dimension(mpl%nproc), intent(in), optional  pool 
)
private

Global to local, 2d array.

Parameters
[in,out]mplMPI data
[in]nlNumber of levels
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]glbGlobal array
[out]locLocal array
[in]rootprocRoot task
[in]poolTasks pool

Definition at line 719 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_glb_to_loc_logical_1d()

subroutine type_mpl::mpl_glb_to_loc_logical_1d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
logical, dimension(:), intent(in)  glb,
logical, dimension(n_loc), intent(out)  loc 
)
private

Global to local, 1d array.

Parameters
[in,out]mplMPI data
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]glbGlobal array
[out]locLocal array

Definition at line 1018 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_glb_to_loc_logical_2d()

subroutine type_mpl::mpl_glb_to_loc_logical_2d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  nl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
logical, dimension(:,:), intent(in)  glb,
logical, dimension(n_loc,nl), intent(out)  loc,
integer, intent(in), optional  rootproc,
logical, dimension(mpl%nproc), intent(in), optional  pool 
)
private

Global to local, 2d array.

Parameters
[in,out]mplMPI data
[in]nlNumber of levels
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]glbGlobal array
[out]locLocal array
[in]rootprocRoot task
[in]poolTasks pool

Definition at line 1096 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_glb_to_loc_real_1d()

subroutine type_mpl::mpl_glb_to_loc_real_1d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
real(kind_real), dimension(:), intent(in)  glb,
real(kind_real), dimension(n_loc), intent(out)  loc 
)
private

Global to local, 1d array.

Parameters
[in,out]mplMPI data
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]glbGlobal array
[out]locLocal array

Definition at line 829 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_glb_to_loc_real_2d()

subroutine type_mpl::mpl_glb_to_loc_real_2d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  nl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
real(kind_real), dimension(:,:), intent(in)  glb,
real(kind_real), dimension(n_loc,nl), intent(out)  loc,
integer, intent(in), optional  rootproc,
logical, dimension(mpl%nproc), intent(in), optional  pool 
)
private

Global to local, 2d array.

Parameters
[in,out]mplMPI data
[in]nlNumber of levels
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]glbGlobal array
[out]locLocal array
[in]rootprocRoot task
[in]poolTasks pool

Definition at line 907 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_init()

subroutine type_mpl::mpl_init ( class(mpl_type), intent(inout)  mpl,
type(fckit_mpi_comm), intent(in), target  f_comm 
)
private

Initialize MPL object.

Parameters
[in,out]mplMPI data
[in]f_commFCKIT MPI communicator wrapper

Definition at line 154 of file type_mpl.F90.

◆ mpl_loc_to_glb_integer_1d()

subroutine type_mpl::mpl_loc_to_glb_integer_1d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
integer, dimension(n_loc), intent(in)  loc,
integer, dimension(:), intent(out)  glb,
logical, intent(in), optional  bcast 
)
private

Local to global, 1d array.

Parameters
[in,out]mplMPI data
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]locLocal array
[out]glbGlobal array
[in]bcastBroadcast option

Definition at line 1207 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_loc_to_glb_integer_2d()

subroutine type_mpl::mpl_loc_to_glb_integer_2d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  nl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
integer, dimension(n_loc,nl), intent(in)  loc,
integer, dimension(:,:), intent(out)  glb,
logical, intent(in), optional  bcast 
)
private

Local to global, 2d array.

Parameters
[in,out]mplMPI data
[in]nlNumber of levels
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]locLocal array
[out]glbGlobal array
[in]bcastBroadcast option

Definition at line 1293 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_loc_to_glb_logical_1d()

subroutine type_mpl::mpl_loc_to_glb_logical_1d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
logical, dimension(n_loc), intent(in)  loc,
logical, dimension(:), intent(out)  glb,
logical, intent(in), optional  bcast 
)
private

Local to global, 1d array.

Parameters
[in,out]mplMPI data
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]locLocal array
[out]glbGlobal array
[in]bcastBroadcast option

Definition at line 1583 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_loc_to_glb_logical_2d()

subroutine type_mpl::mpl_loc_to_glb_logical_2d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  nl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
logical, dimension(n_loc,nl), intent(in)  loc,
logical, dimension(:,:), intent(out)  glb,
logical, intent(in), optional  bcast 
)
private

Local to global for a logical, 2d array.

Parameters
[in,out]mplMPI data
[in]nlNumber of levels
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]locLocal array
[out]glbGlobal array
[in]bcastBroadcast option

Definition at line 1670 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_loc_to_glb_real_1d()

subroutine type_mpl::mpl_loc_to_glb_real_1d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
real(kind_real), dimension(n_loc), intent(in)  loc,
real(kind_real), dimension(:), intent(out)  glb,
logical, intent(in), optional  bcast 
)
private

Local to global, 1d array.

Parameters
[in,out]mplMPI data
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]locLocal array
[out]glbGlobal array
[in]bcastBroadcast option

Definition at line 1394 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_loc_to_glb_real_2d()

subroutine type_mpl::mpl_loc_to_glb_real_2d ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  nl,
integer, intent(in)  n_loc,
integer, intent(in)  n_glb,
integer, dimension(n_loc), intent(in)  loc_to_glb,
real(kind_real), dimension(n_loc,nl), intent(in)  loc,
real(kind_real), dimension(:,:), intent(out)  glb,
logical, intent(in), optional  bcast 
)
private

Local to global, 2d array.

Parameters
[in,out]mplMPI data
[in]nlNumber of levels
[in]n_locLocal array size
[in]n_glbGlobal array size
[in]loc_to_glbLocal to global
[in]locLocal array
[out]glbGlobal array
[in]bcastBroadcast option

Definition at line 1481 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_nc_dim_check()

subroutine type_mpl::mpl_nc_dim_check ( class(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  subr,
integer, intent(in)  ncid,
character(len=*), intent(in)  dimname,
integer, intent(in)  dimsize 
)
private

Check if NetCDF file dimension exists and has the right size.

Parameters
[in,out]mplMPI data
[in]subrCalling subroutine
[in]ncidNetCDF file ID
[in]dimnameDimension name
[in]dimsizeExpected dimension size

Definition at line 2027 of file type_mpl.F90.

◆ mpl_nc_dim_define_or_get()

integer function type_mpl::mpl_nc_dim_define_or_get ( class(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  subr,
integer, intent(in)  ncid,
character(len=*), intent(in)  dimname,
integer, intent(in)  dimsize 
)
private

Define or get (and check) NetCDF dimension.

Parameters
[in,out]mplMPI data
[in]subrCalling subroutine
[in]ncidNetCDF file ID
[in]dimnameDimension name
[in]dimsizeDimension size

Definition at line 1960 of file type_mpl.F90.

◆ mpl_nc_dim_inquire()

integer function type_mpl::mpl_nc_dim_inquire ( class(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  subr,
integer, intent(in)  ncid,
character(len=*), intent(in)  dimname 
)
private

Inquire NetCDF file dimension size.

Parameters
[in,out]mplMPI data
[in]subrCalling subroutine
[in]ncidNetCDF file ID
[in]dimnameDimension name

Definition at line 1997 of file type_mpl.F90.

◆ mpl_nc_file_create_or_open()

integer function type_mpl::mpl_nc_file_create_or_open ( class(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  subr,
character(len=*), intent(in)  filename,
type(fckit_mpi_comm), intent(in), optional  f_comm 
)
private

Create or open NetCDF file.

Parameters
[in,out]mplMPI data
[in]subrCalling subroutine
[in]filenameFile name
[in]f_commCommunicator

Definition at line 1885 of file type_mpl.F90.

◆ mpl_nc_group_define_or_get()

integer function type_mpl::mpl_nc_group_define_or_get ( class(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  subr,
integer, intent(in)  ncid,
character(len=*), intent(in)  grpname 
)
private

Define or get group.

Parameters
[in,out]mplMPI data
[in]subrCalling subroutine
[in]ncidNetCDF file ID
[in]grpnameGroup name

Definition at line 1932 of file type_mpl.F90.

◆ mpl_nc_var_define_or_get()

integer function type_mpl::mpl_nc_var_define_or_get ( class(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  subr,
integer, intent(in)  ncid,
character(len=*), intent(in)  varname,
integer, intent(in)  varkind,
integer, dimension(:), intent(in)  varshape,
character(len=*), intent(in), optional  unitname 
)
private

Define or get NetCDF variable.

Parameters
[in,out]mplMPI data
[in]subrCalling subroutine
[in]ncidNetCDF file ID
[in]varnameVariable name
[in]varkindVariable kind
[in]varshapeVariable shape
[in]unitnameUnit name

Definition at line 2056 of file type_mpl.F90.

◆ mpl_ncerr()

subroutine type_mpl::mpl_ncerr ( class(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  subr,
integer, intent(in)  info 
)
private

Handle NetCDF error.

Parameters
[in,out]mplMPI data
[in]subrCalling subroutine
[in]infoInfo index

Definition at line 2101 of file type_mpl.F90.

◆ mpl_newunit()

subroutine type_mpl::mpl_newunit ( class(mpl_type), intent(inout)  mpl,
integer, intent(out)  lunit 
)
private

Find a free unit.

Parameters
[in,out]mplMPI data
[out]lunitNew unit

Definition at line 123 of file type_mpl.F90.

◆ mpl_prog_final()

subroutine type_mpl::mpl_prog_final ( class(mpl_type), intent(inout)  mpl,
logical, intent(in), optional  advance_flag 
)
private

Finalize progression display.

Parameters
[in,out]mplMPI data
[in]advance_flagAdvance flag

Definition at line 1842 of file type_mpl.F90.

◆ mpl_prog_init()

subroutine type_mpl::mpl_prog_init ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  nprog 
)
private

Initialize progression display.

Parameters
[in,out]mplMPI data
[in]nprogArray size

Definition at line 1772 of file type_mpl.F90.

◆ mpl_prog_print()

subroutine type_mpl::mpl_prog_print ( class(mpl_type), intent(inout)  mpl,
integer, intent(in), optional  i 
)
private

Print progression display.

Parameters
[in,out]mplMPI data
[in]iIndex

Definition at line 1805 of file type_mpl.F90.

◆ mpl_update_tag()

subroutine type_mpl::mpl_update_tag ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  add 
)
private

Update MPI tag.

Parameters
[in,out]mplMPI data
[in]addTag update incrememnt

Definition at line 385 of file type_mpl.F90.

◆ mpl_warning()

subroutine type_mpl::mpl_warning ( class(mpl_type), intent(inout)  mpl,
character(len=*), intent(in)  subr,
character(len=*), intent(in)  message 
)
private

Print warning message.

Parameters
[in,out]mplMPI data
[in]subrCalling subroutine

Definition at line 366 of file type_mpl.F90.

◆ mpl_write_integer()

subroutine type_mpl::mpl_write_integer ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  prefix,
character(len=*), intent(in)  variables,
integer, intent(in)  var 
)
private

Write integer into a log file or into a NetCDF file.

Parameters
[in,out]mplMPI data
[in]ncidNetCDF file id
[in]variablesVariable name
[in]varInteger

Definition at line 2119 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_write_integer_array()

subroutine type_mpl::mpl_write_integer_array ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  prefix,
character(len=*), intent(in)  variables,
integer, intent(in)  n,
integer, dimension(n), intent(in)  var 
)
private

Write integer array into a log file or into a NetCDF file.

Parameters
[in,out]mplMPI data
[in]ncidNetCDF file id
[in]variablesVariable name
[in]nInteger array size
[in]varInteger array

Definition at line 2158 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_write_logical()

subroutine type_mpl::mpl_write_logical ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  prefix,
character(len=*), intent(in)  variables,
logical, intent(in)  var 
)
private

Write logical into a log file or into a NetCDF file.

Parameters
[in,out]mplMPI data
[in]ncidNetCDF file id
[in]variablesVariable name
[in]varLogical

Definition at line 2292 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_write_logical_array()

subroutine type_mpl::mpl_write_logical_array ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  prefix,
character(len=*), intent(in)  variables,
integer, intent(in)  n,
logical, dimension(n), intent(in)  var 
)
private

Write logical array into a log file or into a NetCDF file.

Parameters
[in,out]mplMPI data
[in]ncidNetCDF file id
[in]variablesVariable name
[in]nReal array size
[in]varLogical array

Definition at line 2327 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_write_real()

subroutine type_mpl::mpl_write_real ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  prefix,
character(len=*), intent(in)  variables,
real(kind_real), intent(in)  var 
)
private

Write real into a log file or into a NetCDF file.

Parameters
[in,out]mplMPI data
[in]ncidNetCDF file id
[in]variablesVariable name
[in]varReal

Definition at line 2210 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_write_real_array()

subroutine type_mpl::mpl_write_real_array ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  prefix,
character(len=*), intent(in)  variables,
integer, intent(in)  n,
real(kind_real), dimension(n), intent(in)  var 
)
private

Write real array into a log file or into a NetCDF file.

Parameters
[in,out]mplMPI data
[in]ncidNetCDF file id
[in]variablesVariable name
[in]nReal array size
[in]varReal array

Definition at line 2244 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_write_string()

subroutine type_mpl::mpl_write_string ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  prefix,
character(len=*), intent(in)  variables,
character(len=*), intent(in)  var 
)
private

Write string into a log file or into a NetCDF file.

Parameters
[in,out]mplMPI data
[in]ncidNetCDF file id
[in]variablesVariable name
[in]varString

Definition at line 2381 of file type_mpl.F90.

Here is the caller graph for this function:

◆ mpl_write_string_array()

subroutine type_mpl::mpl_write_string_array ( class(mpl_type), intent(inout)  mpl,
integer, intent(in)  ncid,
character(len=*), intent(in)  prefix,
character(len=*), intent(in)  variables,
integer, intent(in)  n,
character(len=*), dimension(n), intent(in)  var 
)
private

Write string array into a log file or into a NetCDF file.

Parameters
[in,out]mplMPI data
[in]ncidNetCDF file id
[in]variablesVariable name
[in]nString array size
[in]varString array

Definition at line 2417 of file type_mpl.F90.

Here is the caller graph for this function:

Variable Documentation

◆ ddis

integer, parameter type_mpl::ddis = 5

Progression display step.

Definition at line 22 of file type_mpl.F90.

◆ lunit_max

integer, parameter type_mpl::lunit_max =1000

Maximum unit number.

Definition at line 21 of file type_mpl.F90.

◆ lunit_min

integer, parameter type_mpl::lunit_min =10

Minimum unit number.

Definition at line 20 of file type_mpl.F90.