io_collect

Module

Description

$Id$

I/O via MPI root rank by collecting data from all processors. (storing data into one file, e.g. data/allprocs/var.dat)

The file written by output_snap() (and used e.g. for ‘var.dat’) consists of the followinig records (not using record markers):

1. data(mxgrid,mygrid,mzgrid,nvar)

2. t(1), x(mxgrid), y(mygrid), z(mzgrid), dx(1), dy(1), dz(1)

Where nvar denotes the number of variables to be saved. In the case of MHD with entropy, nvar is 8 for a ‘var.dat’ file. Only outer ghost-layers are written, so mzlocal is between nz and mz, depending on the corresponding ipz-layer.

To read these snapshots in IDL, the parameter allprocs needs to be set: IDL> pc_read_var, obj=vars, /allprocs or in a much more efficient way by reading into an array: IDL> pc_read_var_raw, obj=data, tags=tags, grid=grid, /allprocs

13-Jan-2012/PABourdin: adapted from io_dist.f90

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

• cdata: $Id$

• cparam (intlen(), fnlen(), max_int()): $Id$

• file_io (file_exists()): $Id$

• general (find_proc()): $Id$

• messages (fatal_error(), svn_id(), warning()): $Id$

Variables

• io/distribute_grid [private]

• io/gen_in_snapname [private]

• io/id_block_persistent [integer,private/parameter/optional/default=2000]

• io/id_record_dt_gw [integer,private/parameter/optional/default=350]

• io/id_record_eps_rkf [integer,private/parameter/optional/default=331]

• io/id_record_forcing_location [integer,private/parameter/optional/default=270]

• io/id_record_forcing_torus [integer,private/parameter/optional/default=272]

• io/id_record_forcing_tsforce [integer,private/parameter/optional/default=271]

• io/id_record_hydro_ampl [integer,private/parameter/optional/default=286]

• io/id_record_hydro_avec_gb [integer,private/parameter/optional/default=289]

• io/id_record_hydro_location [integer,private/parameter/optional/default=285]

• io/id_record_hydro_phase1 [integer,private/parameter/optional/default=281]

• io/id_record_hydro_phase2 [integer,private/parameter/optional/default=282]

• io/id_record_hydro_qvec_gb [integer,private/parameter/optional/default=288]

• io/id_record_hydro_tphase [integer,private/parameter/optional/default=280]

• io/id_record_hydro_tsforce [integer,private/parameter/optional/default=284]

• io/id_record_hydro_wavenumber [integer,private/parameter/optional/default=287]

• io/id_record_ism_bold_mass [integer,private/parameter/optional/default=252]

• io/id_record_ism_pos_next_old [integer,private/parameter/optional/default=251]

• io/id_record_ism_snrs [integer,private/parameter/optional/default=259]

• io/id_record_ism_snrs_old [integer,private/parameter/optional/default=1002]

• io/id_record_ism_t_cluster [integer,private/parameter/optional/default=261]

• io/id_record_ism_t_next_old [integer,private/parameter/optional/default=250]

• io/id_record_ism_t_next_sni [integer,private/parameter/optional/default=253]

• io/id_record_ism_t_next_snii [integer,private/parameter/optional/default=254]

• io/id_record_ism_toggle_old [integer,private/parameter/optional/default=1001]

• io/id_record_ism_toggle_sni [integer,private/parameter/optional/default=257]

• io/id_record_ism_toggle_snii [integer,private/parameter/optional/default=258]

• io/id_record_ism_x_cluster [integer,private/parameter/optional/default=255]

• io/id_record_ism_y_cluster [integer,private/parameter/optional/default=256]

• io/id_record_ism_z_cluster [integer,private/parameter/optional/default=260]

• io/id_record_iteration_number [integer,private/parameter/optional/default=100]

• io/id_record_magnetic_ampl [integer,private/parameter/optional/default=312]

• io/id_record_magnetic_phase [integer,private/parameter/optional/default=311]

• io/id_record_random_seeds [integer,private/parameter/optional/default=1]

• io/id_record_random_seeds2 [integer,private/parameter/optional/default=2]

• io/id_record_shear_delta_y [integer,private/parameter/optional/default=320]

• io/id_record_special_lnkmin0 [integer,private/parameter/optional/default=340]

• io/id_record_time_step [integer,private/parameter/optional/default=330]

• 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="collect"]

• io/lcollective_io [logical,public/optional/default=.true.]

• io/lread_add [logical,private/optional/default=.true.]

• io/lun_input [integer,parameter=88]

• io/lun_output [integer,parameter=91]

• io/lwrite_add [logical,private/optional/default=.true.]

• io/persist_initialized [logical,private/optional/default=.false.]

• io/persist_last_id [integer,private/optional/default=-max_int]

• io/read_persist [public]

• io/snaplink [character,private/optional/default='']

• 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

identify version number

Call to:

svn_id(), fatal_error(), warning(), globalize_xy(), collect_grid(), output_ode(), hdf5_output_slice_position(), hdf5_output_slice(), not_implemented(), islink(), localize_xy(), input_ode(), 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()

Call to:

fatal_error(), globalize_xy(), collect_grid(), output_ode(), hdf5_output_slice_position(), hdf5_output_slice(), not_implemented(), islink(), localize_xy(), input_ode(), 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

Use :

general (directory_names_std())

Call to:

fatal_error(), globalize_xy(), collect_grid(), output_ode(), hdf5_output_slice_position(), hdf5_output_slice(), not_implemented(), islink(), localize_xy(), input_ode(), 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]]]])

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

10-Feb-2012/PABourdin: coded 13-feb-2014/MR: made file optional (prep for downsampled output)

Parameters:

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

• nv1 [integer,in,]

• nv2 [integer,in,]

• file [character,in,]

• mode [integer,in,]

Use :

mpicomm (globalize_xy(), collect_grid()), general (ioptest())

Call to:

fatal_error(), globalize_xy(), collect_grid(), output_ode(), hdf5_output_slice_position(), hdf5_output_slice(), not_implemented(), islink(), localize_xy(), input_ode(), 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.

11-Feb-2012/PABourdin: coded

Call to:

fatal_error(), hdf5_output_slice_position(), hdf5_output_slice(), not_implemented(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

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

Output 2D average to a file.

01-dec-2022/ccyang: stub

Parameters:

• label [character,in]

• nc [integer,in,]

• name (nc) [character,in]

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

• time [real,in]

• lwrite [logical,in]

• header (*) [real,in,]

Use :

general (keep_compiler_quiet())

Call to:

fatal_error(), hdf5_output_slice_position(), hdf5_output_slice(), not_implemented(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

subroutine  io/output_slice_position()

Record slice positions.

13-nov-20/ccyang: wrapper

Use :

hdf5_io (hdf5_output_slice_position())

Call to:

hdf5_output_slice_position(), hdf5_output_slice(), fatal_error(), not_implemented(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

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]

Use :

hdf5_io (hdf5_output_slice())

Call to:

hdf5_output_slice(), fatal_error(), not_implemented(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

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

Write particle snapshot file, always write mesh and time.

23-Oct-2018/PABourdin: adapted from output_snap

Parameters:

• ipar (mv) [integer,in]

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

• mv [integer,in,]

• nv [integer,in]

• file [character,in]

• label [character,in,]

• ltruncate [logical,in,]

Use :

general (keep_compiler_quiet())

Call to:

fatal_error(), not_implemented(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

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()), messages (not_implemented())

Call to:

not_implemented(), fatal_error(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

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

Open stalker particle snapshot file and initialize with snapshot time.

03-May-2019/PABourdin: coded

Parameters:

• num [integer,in]

• nv [integer,in,]

• snap [integer,in]

• id (nv) [integer,in]

Use :

general (keep_compiler_quiet())

Call to:

fatal_error(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

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

Write stalker particle quantity to snapshot file.

03-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:

fatal_error(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

subroutine  io/output_part_finalize()

Close particle snapshot file.

03-May-2019/PABourdin: coded

Call to:

fatal_error(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

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

Write pointmass snapshot file with time.

26-Oct-2018/PABourdin: adapted from output_snap

Parameters:

• file [character,in]

• labels (mqarray) [character,in]

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

• mv [integer,in,]

• nc [integer,in]

Use :

general (keep_compiler_quiet())

Call to:

fatal_error(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

subroutine  io/input_snap(file_, a, nv[, mode])

read snapshot file, possibly with mesh and time (if mode=1) 10-Feb-2012/PABourdin: coded 13-jan-2015/MR: avoid use of fseek; if necessary comment the calls to fseek in fseek_pos

Parameters:

• file [character,in]

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

• nv [integer,in]

• mode [integer,in,]

Use :

file_io (backskip_to_time()), mpicomm (localize_xy(), mpibcast_real(), mpi_comm_pencil()), syscalls (islink())

Call to:

fatal_error(), islink(), localize_xy(), input_ode(), 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(), collect_grid()

subroutine  io/input_snap_finalize()

Close snapshot file.

11-Feb-2012/PABourdin: coded

Use :

syscalls (system_cmd())

Call to:

system_cmd(), fatal_error(), 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(), collect_grid()

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’.

25-Oct-2018/PABourdin: apadpted and moved to IO module

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 :

general (keep_compiler_quiet())

Call to:

fatal_error(), 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(), collect_grid()

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 :

general (keep_compiler_quiet())

Call to:

fatal_error(), 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(), collect_grid()

function  io/init_write_persist([file])

Initialize writing of persistent data to persistent file.

13-Dec-2011/PABourdin: coded

Parameters:

file [character,in,]

Return:

init_write_persist [logical]

Call to:

write_persist_id(), init_write_persist(), write_persist_logical_0d(), fatal_error(), 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(), collect_grid()

function  io/write_persist_id(label, id)

Write persistent data to snapshot file.

13-Dec-2011/PABourdin: coded

Parameters:

• label [character,in]

• id [integer,in]

Return:

write_persist_id [logical]

Call to:

init_write_persist(), write_persist_logical_0d(), write_persist_id(), fatal_error(), 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(), collect_grid()

function  io/write_persist_logical_0d(label, id, value)

Write persistent data to snapshot file.

12-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• id [integer,in]

• value [logical,in]

Return:

write_persist_logical_0d [logical]

Use :

mpicomm (mpisend_logical(), mpirecv_logical())

Call to:

write_persist_id(), fatal_error(), 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(), collect_grid()

function  io/write_persist_logical_1d(label, id, value)

Write persistent data to snapshot file.

12-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• id [integer,in]

• value (*) [logical,in]

Return:

write_persist_logical_1d [logical]

Use :

mpicomm (mpisend_logical(), mpirecv_logical())

Call to:

write_persist_id(), fatal_error(), 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(), collect_grid()

function  io/write_persist_int_0d(label, id, value)

Write persistent data to snapshot file.

12-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• id [integer,in]

• value [integer,in]

Return:

write_persist_int_0d [logical]

Use :

mpicomm (mpisend_int(), mpirecv_int())

Call to:

write_persist_id(), fatal_error(), 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(), collect_grid()

function  io/write_persist_int_1d(label, id, value)

Write persistent data to snapshot file.

12-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• id [integer,in]

• value (*) [integer,in]

Return:

write_persist_int_1d [logical]

Use :

mpicomm (mpisend_int(), mpirecv_int())

Call to:

write_persist_id(), fatal_error(), 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(), collect_grid()

function  io/write_persist_real_0d(label, id, value)

Write persistent data to snapshot file.

12-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• id [integer,in]

• value [real,in]

Return:

write_persist_real_0d [logical]

Use :

mpicomm (mpisend_real(), mpirecv_real())

Call to:

write_persist_id(), fatal_error(), 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(), collect_grid()

function  io/write_persist_real_1d(label, id, value)

Write persistent data to snapshot file.

12-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• id [integer,in]

• value (*) [real,in]

Return:

write_persist_real_1d [logical]

Use :

mpicomm (mpisend_real(), mpirecv_real())

Call to:

write_persist_id(), fatal_error(), 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(), collect_grid()

function  io/write_persist_torus_rect(label, id, value)

Write persistent data to snapshot file.

16-May-2020/MR: coded

Parameters:

• label [character,in]

• id [integer,in]

• value [torus_rect,in]

Return:

write_persist_torus_rect [logical]

Use :

general (keep_compiler_quiet()), geometrical_types

Call to:

write_persist_id(), init_read_persist(), persist_exists(), read_persist_id(), read_persist_logical_0d(), fatal_error(), 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(), collect_grid()

function  io/init_read_persist([file])

Initialize reading of persistent data from persistent file.

13-Dec-2011/PABourdin: coded

Parameters:

file [character,in,]

Return:

init_read_persist [logical]

Use :

file_io (file_exists()), mpicomm (mpibcast_logical(), mpi_comm_pencil())

Call to:

persist_exists(), read_persist_id(), read_persist_logical_0d(), fatal_error(), 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(), collect_grid()

function  io/persist_exists(label)

Dummy routine

12-Oct-2019/PABourdin: coded

Parameters:

label [character,in]

Return:

persist_exists [logical]

Use :

general (keep_compiler_quiet())

Call to:

read_persist_id(), read_persist_logical_0d(), fatal_error(), 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(), collect_grid()

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

Read persistent block ID from snapshot file.

17-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• id [integer,out]

• lerror_prone [logical,in,]

Return:

read_persist_id [logical]

Use :

mpicomm (mpibcast_int(), mpi_comm_pencil())

Call to:

read_persist_logical_0d(), fatal_error(), 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(), collect_grid()

function  io/read_persist_logical_0d(label, value)

Read persistent data from snapshot file.

11-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• value [logical,out]

Return:

read_persist_logical_0d [logical]

Use :

mpicomm (mpisend_logical(), mpirecv_logical())

Call to:

fatal_error(), 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(), collect_grid()

function  io/read_persist_logical_1d(label, value)

Read persistent data from snapshot file.

11-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• value (*) [logical,out]

Return:

read_persist_logical_1d [logical]

Use :

mpicomm (mpisend_logical(), mpirecv_logical())

Call to:

fatal_error(), 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(), collect_grid()

function  io/read_persist_int_0d(label, value)

Read persistent data from snapshot file.

11-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• value [integer,out]

Return:

read_persist_int_0d [logical]

Use :

mpicomm (mpisend_int(), mpirecv_int())

Call to:

fatal_error(), 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(), collect_grid()

function  io/read_persist_int_1d(label, value)

Read persistent data from snapshot file.

11-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• value (*) [integer,out]

Return:

read_persist_int_1d [logical]

Use :

mpicomm (mpisend_int(), mpirecv_int())

Call to:

fatal_error(), read_persist_real_0d(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), collect_grid()

function  io/read_persist_real_0d(label, value)

Read persistent data from snapshot file.

11-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• value [real,out]

Return:

read_persist_real_0d [logical]

Use :

mpicomm (mpisend_real(), mpirecv_real())

Call to:

fatal_error(), read_persist_real_1d(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), collect_grid()

function  io/read_persist_real_1d(label, value)

Read persistent data from snapshot file.

11-Feb-2012/PABourdin: coded

Parameters:

• label [character,in]

• value (*) [real,out]

Return:

read_persist_real_1d [logical]

Use :

mpicomm (mpisend_real(), mpirecv_real())

Call to:

fatal_error(), read_persist_torus_rect(), output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), collect_grid()

function  io/read_persist_torus_rect(label, value)

Read persistent data from snapshot file.

16-May-2020/MR: coded

Parameters:

• label [character,in]

• value [torus_rect,out]

Return:

read_persist_torus_rect [logical]

Use :

general (keep_compiler_quiet()), geometrical_types

Call to:

output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), fatal_error(), collect_grid()

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

Write snapshot file of globals, ignore time and mesh.

10-Feb-2012/PABourdin: coded

Parameters:

• file [character]

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

• nv [integer]

• label [character,in,]

Use :

general (keep_compiler_quiet())

Call to:

output_snap(), output_snap_finalize(), input_snap(), input_snap_finalize(), mpibarrier(), fatal_error(), collect_grid()

subroutine  io/input_globals(file, a, nv)

Read globals snapshot file, ignore time and mesh.

10-Feb-2012/PABourdin: coded

Parameters:

• file [character]

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

• nv [integer]

Call to:

input_snap(), input_snap_finalize(), mpibarrier(), fatal_error(), collect_grid()

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(), fatal_error(), collect_grid()

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

Write grid coordinates.

10-Feb-2012/PABourdin: adapted for collective IO

Parameters:

• file [character]

• mxout [integer]

• myout [integer]

• mzout [integer]

• lwrite [logical]

Use :

mpicomm (collect_grid()), general (loptest(), keep_compiler_quiet())

Call to:

fatal_error(), collect_grid()

subroutine  io/rgrid(file)

Read grid coordinates.

21-jan-02/wolf: coded 15-jun-03/axel: Lx,Ly,Lz are now read in from file (Tony noticed the mistake) 10-Feb-2012/PABourdin: adapted for collective IO

Parameters:

file [character]

Use :

mpicomm (mpibcast_real(), mpi_comm_pencil())

Call to:

fatal_error()

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())