io_hdf5

Module

Description

$Id$

I/O via the HDF5 hyperslab-by-chunk IO routines. (storing data into one file, e.g. data/allprocs/VAR#.h5)

The data format is self-contained. Only outer ghost-layers are stored.

19-Sep-2012/PABourdin: adapted from io_mpi2.f90 28-Oct-2016/PABourdin: first fully working version 28-Nov-2018/PABourdin: first beta-test version

Quick access

Variables:

check_consistency, check_success, check_success_local, dead_beef, displacement, distribute_grid, gen_in_snapname, get_dimensions, get_disp_to_par_real, global_size, global_start, global_type, input_grid, input_grid_double, input_grid_single, input_proc_bounds, input_proc_bounds_double, input_proc_bounds_single, input_slice, io_dims, io_info, io_strategy, lcollective_io, local_size, local_start, local_type, lread_add, lswitched_to_out, lwr_grid, lwrite_add, maxt, mint, mpi_err, order, persist_initialized, persist_last_id, read_globals, read_globals_double, read_globals_single, read_part, read_part_double, read_part_single, read_persist, read_snap, read_snap_double, read_snap_single, record_marker, snaplink, subsize, switch_io, varfile_name, wdim_default, wdim_default_grid, write_persist

Routines:

directory_names(), finalize_io(), init_read_persist(), init_write_persist(), input_globals(), input_ode(), input_part_snap(), input_pointmass(), input_snap(), input_snap_finalize(), log_filename_to_file(), output_average_2d(), output_globals(), output_ode(), output_part_finalize(), output_part_rmv(), output_part_snap(), output_pointmass(), output_slice(), output_slice_position(), output_snap(), output_snap_finalize(), output_stalker(), output_stalker_init(), persist_exists(), read_persist_id(), read_persist_int_0d(), read_persist_int_1d(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), read_precision(), read_profile(), register_io(), rgrid(), rproc_bounds(), wdim(), wgrid(), wproc_bounds(), write_persist_id(), write_persist_int_0d(), write_persist_int_1d(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect()

Needed modules

Variables

  • io/distribute_grid [private]
  • io/gen_in_snapname [private]
  • io/input_proc_bounds [private]
  • io/input_proc_bounds_double [private]
  • io/input_proc_bounds_single [private]
  • io/input_slice [public]
  • io/input_slice_real_arr [private]
  • io/input_slice_scat_arr [private]
  • io/io_strategy [character,public/optional/default="hdf5"]
  • io/lcollective_io [logical,public/optional/default=.true.]
  • io/lread_add [logical,private]
  • io/lun_input [integer,parameter=88]
  • io/lun_output [integer,parameter=91]
  • io/persist_initialized [logical,private/optional/default=.false.]
  • io/read_persist [public]
  • io/varfile_name [character,private]
  • io/wdim_default [private]
  • io/wdim_default_grid [private]
  • io/write_persist [public]

Subroutines and functions

subroutine  io/register_io()

dummy routine, generates separate directory for each processor. VAR#-files are written to the directory directory_snap which will be the same as directory, unless specified otherwise.

04-Jul-2011/Boudin.KIS: coded

Call to:

svn_id(), warning(), finalize_hdf5(), fatal_error(), file_open_hdf5(), create_group_hdf5(), index_get(), file_close_hdf5(), output_settings(), output_ode(), exists_in_hdf5(), hdf5_output_slice_position(), hdf5_output_slice(), not_implemented(), islink(), input_ode(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier()

subroutine  io/finalize_io()

close the HDF5 library

Call to:

finalize_hdf5(), fatal_error(), file_open_hdf5(), create_group_hdf5(), index_get(), file_close_hdf5(), output_settings(), output_ode(), exists_in_hdf5(), hdf5_output_slice_position(), hdf5_output_slice(), not_implemented(), islink(), input_ode(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier()

subroutine  io/directory_names()

Set up the directory names: set directory name for the output (one subdirectory for each processor) if datadir_snap (where var.dat, VAR# go) is empty, initialize to datadir

02-oct-2002/wolf: coded 28-Oct-2016/PABourdin: redesigned

Use :

general (directory_names_std())

Call to:

fatal_error(), file_open_hdf5(), create_group_hdf5(), index_get(), file_close_hdf5(), output_settings(), output_ode(), exists_in_hdf5(), hdf5_output_slice_position(), hdf5_output_slice(), not_implemented(), islink(), input_ode(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier()

subroutine  io/output_snap(a[, nv1[, nv2, file[, mode[, ltruncate[, label]]]]])

Write snapshot file, always write mesh and time, could add other things.

19-Sep-2012/Bourdin.KIS: adapted from io_mpi2 13-feb-2014/MR: made file optional (prep for downsampled output) 28-Oct-2016/PABourdin: redesigned

Parameters:
  • a (,,*,*) [real,in]

  • nv1 [integer,in,]

  • nv2 [integer,in,]

  • file [character,in]

  • mode [integer,in,]

  • ltruncate [logical,in,]

  • label [character,in,]

Use :

general (coptest(), ioptest(), itoa()), file_io (parallel_file_exists())

Call to:

fatal_error(), file_open_hdf5(), create_group_hdf5(), index_get(), file_close_hdf5(), output_settings(), output_ode(), exists_in_hdf5(), hdf5_output_slice_position(), hdf5_output_slice(), not_implemented(), islink(), input_ode(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier()

subroutine  io/output_snap_finalize()

Close snapshot file.

19-Sep-2012/Bourdin.KIS: adapted from io_mpi2 28-Oct-2016/PABourdin: redesigned

Call to:

file_close_hdf5(), file_open_hdf5(), exists_in_hdf5(), create_group_hdf5(), fatal_error(), hdf5_output_slice_position(), hdf5_output_slice(), output_settings(), not_implemented(), islink(), index_get(), input_ode(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier()

subroutine  io/output_average_2d(label, nc, name, data, time, lwrite[, header])

Output average to a file.

16-Nov-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • nc [integer,in,]

  • name (nc) [character,in]

  • data (,,*) [real,in,target]

  • time [real,in]

  • lwrite [logical,in]

  • header (*) [real,in,]

Use :

file_io (parallel_file_exists()), general (itoa()), mpicomm (mpibcast_int())

Call to:

file_open_hdf5(), exists_in_hdf5(), file_close_hdf5(), create_group_hdf5(), fatal_error(), hdf5_output_slice_position(), hdf5_output_slice(), output_settings(), not_implemented(), islink(), index_get(), input_ode(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier()

subroutine  io/output_slice_position()

Record slice positions.

13-nov-20/ccyang: wrapper

Call to:

hdf5_output_slice_position(), hdf5_output_slice(), file_open_hdf5(), create_group_hdf5(), file_close_hdf5(), output_settings(), not_implemented(), islink(), index_get(), input_ode(), fatal_error(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier()

subroutine  io/output_slice(lwrite, time, label, suffix, pos, grid_pos, data)

Append to a slice file

13-nov-20/ccyang: wrapper

Parameters:
  • lwrite [logical,in]

  • time [real,in]

  • label [character,in]

  • suffix [character,in]

  • pos [real,in]

  • grid_pos [integer,in]

  • data (,) [real,pointer]

Call to:

hdf5_output_slice(), file_open_hdf5(), create_group_hdf5(), file_close_hdf5(), output_settings(), not_implemented(), islink(), index_get(), input_ode(), fatal_error(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier()

subroutine  io/output_part_snap(ipar, ap, mv, nv, file[, label[, ltruncate]])

Write particle snapshot file, always write mesh and time.

22-Oct-2018/PABourdin: adapted from output_snap

Parameters:
  • ipar (mv) [integer,in]

  • ap (mv,mparray) [real,in]

  • mv [integer,in,]

  • nv [integer,in]

  • file [character,in]

  • label [character,in,]

  • ltruncate [logical,in,]

Use :

file_io (parallel_file_exists())

Call to:

file_open_hdf5(), create_group_hdf5(), file_close_hdf5(), output_settings(), not_implemented(), islink(), index_get(), input_ode(), fatal_error(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier()

subroutine  io/output_part_rmv(ipar_rmv, ipar_sink, fp_rmv, fp_sink, nrmv)

Writes the log of removed particles to a file.

21-jan-24/ccyang: stub

Parameters:
  • ipar_rmv (*) [integer,in]

  • ipar_sink (*) [integer,in]

  • fp_rmv (,) [real,in]

  • fp_sink (,) [real,in]

  • nrmv [integer,in]

Use :

general (keep_compiler_quiet())

Call to:

not_implemented(), file_open_hdf5(), create_group_hdf5(), file_close_hdf5(), islink(), index_get(), input_ode(), fatal_error(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings()

subroutine  io/output_stalker_init(num, nv, snap, id)

Open stalker particle snapshot file and initialize with snapshot time.

02-May-2019/PABourdin: coded

Parameters:
  • num [integer,in]

  • nv [integer,in,]

  • snap [integer,in]

  • id (nv) [integer,in]

Use :

general (itoa(), keep_compiler_quiet())

Call to:

file_open_hdf5(), create_group_hdf5(), file_close_hdf5(), islink(), index_get(), input_ode(), fatal_error(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings()

subroutine  io/output_stalker(label, mv, nv, data[, nvar[, lfinalize]])

Write stalker particle quantity to snapshot file.

02-May-2019/PABourdin: coded

Parameters:
  • label [character,in]

  • mv [integer,in,]

  • nv [integer,in]

  • data (mv) [real,in]

  • nvar [integer,in,]

  • lfinalize [logical,in,]

Use :

general (keep_compiler_quiet())

Call to:

file_close_hdf5(), file_open_hdf5(), create_group_hdf5(), islink(), index_get(), input_ode(), fatal_error(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings()

subroutine  io/output_part_finalize()

Close particle snapshot file.

02-May-2019/PABourdin: coded

Call to:

file_close_hdf5(), file_open_hdf5(), create_group_hdf5(), islink(), index_get(), input_ode(), fatal_error(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings()

subroutine  io/output_pointmass(file, labels, fq, mv, nc)

Write pointmass snapshot file with time.

26-Oct-2018/PABourdin: coded

Parameters:
  • file [character,in]

  • labels (mqarray) [character,in]

  • fq (mv,mparray) [real,in]

  • mv [integer,in,]

  • nc [integer,in]

Call to:

file_open_hdf5(), create_group_hdf5(), file_close_hdf5(), islink(), index_get(), input_ode(), fatal_error(), warning(), rgrid(), system_cmd(), init_write_persist(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings()

subroutine  io/input_snap(file, a, nv[, mode[, label[, ivar0[, data_label]]]])

Read snapshot file. Also read mesh and time, if mode==1.

19-Sep-2012/Bourdin.KIS: adapted from io_mpi2 10-Mar-2015/MR: avoided use of fseek;

this subroutine seems not yet to be adapted to HDF5

28-Oct-2016/PABourdin: redesigned 12-Oct-2023/Fred: ivar0 optional start parameter for handling change of labels

e.g. rho2lnrho

Parameters:
  • file [character]

  • a (mx,my,mz,nv) [real,out]

  • nv [integer,in]

  • mode [integer,in,]

  • label [character]

  • ivar0 [integer,in,]

  • data_label [character]

Use :

general (ioptest()), syscalls (islink())

Call to:

islink(), file_open_hdf5(), index_get(), input_ode(), file_close_hdf5(), fatal_error(), warning(), rgrid(), system_cmd(), init_write_persist(), create_group_hdf5(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings()

subroutine  io/input_snap_finalize()

Close snapshot file.

12-Oct-2019/PABourdin: moved code from ‘input_snap’

Use :

mpicomm (mpibcast_real(), mpibcast_logical(), mpi_comm_pencil()), syscalls (system_cmd())

Call to:

file_close_hdf5(), file_open_hdf5(), fatal_error(), warning(), rgrid(), system_cmd(), init_write_persist(), create_group_hdf5(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings()

subroutine  io/input_part_snap(ipar, ap, mv, nv, npar_total, file[, label])

Read particle snapshot file, mesh and time are read in ‘input_snap’.

24-Oct-2018/PABourdin: coded

Parameters:
  • ipar (mv) [integer,out]

  • ap (mv,mparray) [real,out]

  • mv [integer,in]

  • nv [integer,out]

  • npar_total [integer,out]

  • file [character,in]

  • label [character,in,]

Use :

mpicomm (mpireduce_sum_int(), mpibcast())

Call to:

file_open_hdf5(), file_close_hdf5(), fatal_error(), init_write_persist(), create_group_hdf5(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings()

subroutine  io/input_pointmass(file, labels, fq, mv, nc)

Read pointmass snapshot file.

26-Oct-2018/PABourdin: coded

Parameters:
  • file [character,in]

  • labels (nc) [character,in]

  • fq (mv,nc) [real,out]

  • mv [integer,in]

  • nc [integer,in,]

Use :

mpicomm (mpibcast_real())

Call to:

file_open_hdf5(), fatal_error(), file_close_hdf5(), init_write_persist(), create_group_hdf5(), write_persist_id(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings()

function  io/init_write_persist([file])

Initialize writing of persistent data to persistent file.

26-Oct-2018/PABourdin: coded

Parameters:

file [character,in,]

Return:

init_write_persist [logical]

Call to:

file_close_hdf5(), file_open_hdf5(), create_group_hdf5(), write_persist_id(), init_write_persist(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings(), fatal_error()

function  io/write_persist_id(label, id)

Write persistent data to snapshot file.

19-Sep-2012/Bourdin.KIS: adapted from io_mpi2

Parameters:
  • label [character,in]

  • id [integer,in]

Return:

write_persist_id [logical]

Use :

general (keep_compiler_quiet())

Call to:

init_write_persist(), write_persist_logical_0d(), write_persist_logical_1d(), write_persist_id(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), file_close_hdf5(), file_open_hdf5(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings(), fatal_error()

function  io/write_persist_logical_0d(label, id, value)

Write persistent data to snapshot file.

26-Oct-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • id [integer,in]

  • value [logical,in]

Return:

write_persist_logical_0d [logical]

Call to:

write_persist_logical_1d(), write_persist_id(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), file_close_hdf5(), file_open_hdf5(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings(), fatal_error()

function  io/write_persist_logical_1d(label, id, value)

Write persistent data to snapshot file.

26-Oct-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • id [integer,in]

  • value (*) [logical,in]

Return:

write_persist_logical_1d [logical]

Use :

general (lower_case())

Call to:

write_persist_id(), write_persist_int_0d(), write_persist_int_1d(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), file_close_hdf5(), file_open_hdf5(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings(), fatal_error()

function  io/write_persist_int_0d(label, id, value)

Write persistent data to snapshot file.

26-Oct-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • id [integer,in]

  • value [integer,in]

Return:

write_persist_int_0d [logical]

Call to:

write_persist_int_1d(), write_persist_id(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), file_close_hdf5(), file_open_hdf5(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings(), fatal_error()

function  io/write_persist_int_1d(label, id, value)

Write persistent data to snapshot file.

26-Oct-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • id [integer,in]

  • value (*) [integer,in]

Return:

write_persist_int_1d [logical]

Use :

general (lower_case())

Call to:

write_persist_id(), write_persist_real_0d(), write_persist_real_1d(), write_persist_torus_rect(), init_read_persist(), file_close_hdf5(), file_open_hdf5(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings(), fatal_error()

function  io/write_persist_real_0d(label, id, value)

Write persistent data to snapshot file.

26-Oct-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • id [integer,in]

  • value [real,in]

Return:

write_persist_real_0d [logical]

Call to:

write_persist_real_1d(), write_persist_id(), write_persist_torus_rect(), init_read_persist(), file_close_hdf5(), file_open_hdf5(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings(), fatal_error()

function  io/write_persist_real_1d(label, id, value)

Write persistent data to snapshot file.

26-Oct-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • id [integer,in]

  • value (*) [real,in]

Return:

write_persist_real_1d [logical]

Use :

general (lower_case())

Call to:

write_persist_id(), write_persist_torus_rect(), init_read_persist(), file_close_hdf5(), file_open_hdf5(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings(), fatal_error()

function  io/write_persist_torus_rect(label, id, value)

Write persistent data to snapshot file.

13-May-2020/MR: coded

Parameters:
  • label [character,in]

  • id [integer,in]

  • value [torus_rect,in]

Return:

write_persist_torus_rect [logical]

Use :

geometrical_types, general (lower_case())

Call to:

write_persist_id(), init_read_persist(), file_close_hdf5(), file_open_hdf5(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings(), fatal_error()

function  io/init_read_persist([file])

Initialize reading of persistent data from persistent file.

27-Oct-2018/PABourdin: coded

Parameters:

file [character,in,]

Return:

init_read_persist [logical]

Use :

file_io (parallel_file_exists())

Call to:

file_close_hdf5(), file_open_hdf5(), persist_exists(), exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), output_settings(), fatal_error()

function  io/persist_exists(label)

Check if a persistent variable exists.

12-Oct-2019/PABourdin: coded

Parameters:

label [character,in]

Return:

persist_exists [logical]

Use :

general (lower_case()), mpicomm (mpibcast())

Call to:

exists_in_hdf5(), read_persist_id(), read_persist_logical_0d(), read_persist_logical_1d(), persist_exists(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

function  io/read_persist_id(label, id[, lerror_prone])

Read persistent block ID from snapshot file.

27-Oct-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • id [integer,out]

  • lerror_prone [logical,in,]

Return:

read_persist_id [logical]

Use :

general (lower_case())

Call to:

exists_in_hdf5(), read_persist_logical_0d(), read_persist_logical_1d(), persist_exists(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

function  io/read_persist_logical_0d(label, value)

Read persistent data from snapshot file.

27-Oct-2018/PABourdin: coded 15-feb-2025/Kishore: avoid overwriting value with uninitialized variable in case of unsuccessful read.

Parameters:
  • label [character,in]

  • value [logical,out]

Return:

read_persist_logical_0d [logical]

Call to:

read_persist_logical_1d(), persist_exists(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

function  io/read_persist_logical_1d(label, value)

Read persistent data from snapshot file.

27-Oct-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • value (*) [logical,out]

Return:

read_persist_logical_1d [logical]

Use :

general (lower_case()), mpicomm (mpibcast())

Call to:

persist_exists(), read_persist_int_0d(), read_persist_int_1d(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

function  io/read_persist_int_0d(label, value)

Read persistent data from snapshot file.

27-Oct-2018/PABourdin: coded 15-feb-2025/Kishore: avoid overwriting value with uninitialized variable in case of unsuccessful read.

Parameters:
  • label [character,in]

  • value [integer,out]

Return:

read_persist_int_0d [logical]

Call to:

read_persist_int_1d(), persist_exists(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

function  io/read_persist_int_1d(label, value)

Read persistent data from snapshot file.

27-Oct-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • value (*) [integer,out]

Return:

read_persist_int_1d [logical]

Use :

general (lower_case()), mpicomm (mpibcast())

Call to:

persist_exists(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

function  io/read_persist_real_0d(label, value)

Read persistent data from snapshot file.

27-Oct-2018/PABourdin: coded 15-feb-2025/Kishore: avoid overwriting value with uninitialized variable in case of unsuccessful read.

Parameters:
  • label [character,in]

  • value [real,out]

Return:

read_persist_real_0d [logical]

Call to:

read_persist_real_1d(), persist_exists(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

function  io/read_persist_real_1d(label, value)

Read persistent data from snapshot file.

27-Oct-2018/PABourdin: coded

Parameters:
  • label [character,in]

  • value (*) [real,out]

Return:

read_persist_real_1d [logical]

Use :

general (lower_case()), mpicomm (mpibcast())

Call to:

persist_exists(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

function  io/read_persist_torus_rect(label, value)

Read persistent data from snapshot file.

16-May-2020/MR: coded

Parameters:
Return:

read_persist_torus_rect [logical]

Use :

geometrical_types, general (keep_compiler_quiet())

Call to:

output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

subroutine  io/output_globals(file, a, nv[, label])

Write snapshot file of globals, ignore time and mesh.

19-Sep-2012/Bourdin.KIS: adapted from io_mpi2 29-Nov-2018/PABourdin: extended for output of time averages

Parameters:
  • file [character]

  • a (mx,my,mz,nv) [real]

  • nv [integer]

  • label [character,in,]

Use :

general (coptest())

Call to:

output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

subroutine  io/input_globals(file, a, nv)

Read globals snapshot file, ignore time and mesh.

19-Sep-2012/Bourdin.KIS: adapted from io_mpi2

Parameters:
  • file [character]

  • a (mx,my,mz,nv) [real]

  • nv [integer]

Call to:

input_snap(), input_snap_finalize(), mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

subroutine  io/log_filename_to_file(filename, flist)

In the directory containing ‘filename’, append one line to file ‘flist’ containing the file part of filename

Parameters:
  • filename [character]

  • flist [character]

Use :

general (parse_filename(), safe_character_assign()), mpicomm (mpibarrier())

Call to:

mpibarrier(), file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

subroutine  io/wgrid(file[, mxout[, myout[, mzout[, lwrite]]]])

Write grid coordinates.

27-Oct-2018/PABourdin: coded

Parameters:
  • file [character,in]

  • mxout [integer,in,]

  • myout [integer,in,]

  • mzout [integer,in,]

  • lwrite [logical]

Use :

file_io (file_exists()), general (loptest(), keep_compiler_quiet())

Call to:

file_open_hdf5(), output_settings(), file_close_hdf5(), fatal_error()

subroutine  io/rgrid(file)

Read grid coordinates.

27-Oct-2018/PABourdin: coded

Parameters:

file [character]

Use :

mpicomm (mpibcast_real(), mpi_comm_pencil()), general (keep_compiler_quiet())

Call to:

fatal_error(), file_open_hdf5(), file_close_hdf5()

subroutine  io/wdim(file, mx_out, my_out, mz_out, mxgrid_out, mygrid_out, mzgrid_out, mvar_out, maux_out)
Parameters:
  • file [character,in]

  • mx_out [integer,in]

  • my_out [integer,in]

  • mz_out [integer,in]

  • mxgrid_out [integer,in]

  • mygrid_out [integer,in]

  • mzgrid_out [integer,in]

  • mvar_out [integer,in]

  • maux_out [integer,in]

Use :

hdf5_io (output_dim())

function  io/read_precision()
Return:

res [character]

Use :

hdf5_io (input_dim()), mpicomm (mpibcast())

subroutine  io/rproc_bounds(file)
Parameters:

file [character]

Use :

mpicomm (mpibcast())

subroutine  io/wproc_bounds(file)
Parameters:

file [character,in]

subroutine  io/output_ode(file)
Parameters:

file [character]

Use :

farraymanager (farray_retrieve_metadata_ode())

subroutine  io/input_ode(file)
Parameters:

file [character,in]

Use :

farraymanager (farray_retrieve_metadata_ode()), file_io (file_exists()), general (rtoa()), mpicomm (mpibcast())

subroutine  io/read_profile(fname, type, a, np[, lhas_ghost])
Parameters:
  • fname [character,in]

  • type [character,in]

  • a (np) [real,out]

  • np [integer,in]

  • lhas_ghost [logical]

Use :

hdf5_io (input_profile())