MPI-AMRVAC  3.1
The MPI - Adaptive Mesh Refinement - Versatile Advection Code (development version)
Functions/Subroutines | Variables
mod_input_output_helper Module Reference

Functions/Subroutines

character(len=name_len) function, dimension(1:nwc), public get_names_from_string (aux_variable_names, nwc)
 
pure integer function, public count_ix (ixOL)
 Compute number of elements in index range. More...
 
subroutine, public block_shape_io (igrid, n_ghost, ixOL, n_values)
 Determine the shape of a block for output (whether to include ghost cells, and on which sides) More...
 
subroutine, public create_output_file (fh, ix, extension, suffix)
 Standard method for creating a new output file. More...
 
subroutine, public snapshot_write_header1 (fh, offset_tree, offset_block, dataset_names, nw_vars)
 Write header for a snapshot, generalize cons_wnames and nw. More...
 

Variables

logical save_now
 whether a manually inserted snapshot is saved More...
 
integer, parameter version_number = 5
 Version number of the .dat file output. More...
 

Function/Subroutine Documentation

◆ block_shape_io()

subroutine, public mod_input_output_helper::block_shape_io ( integer, intent(in)  igrid,
integer, dimension(2*ndim), intent(out)  n_ghost,
integer, intent(out)  ixO,
integer, intent(out)  L,
integer, intent(out)  n_values 
)

Determine the shape of a block for output (whether to include ghost cells, and on which sides)

Parameters
[out]n_ghostnghost(1:ndim) contains the number of ghost cells on the block's minimum boundaries, and nghost(ndim+1:2*ndim) on the block's maximum boundaries
[out]ixoIndex range on output block
[out]lIndex range on output block
[out]n_valuesNumber of cells/values in output

Definition at line 54 of file mod_input_output_helper.t.

Here is the call graph for this function:

◆ count_ix()

pure integer function, public mod_input_output_helper::count_ix ( integer, intent(in)  ixO,
integer, intent(in)  L 
)

Compute number of elements in index range.

Definition at line 46 of file mod_input_output_helper.t.

◆ create_output_file()

subroutine, public mod_input_output_helper::create_output_file ( integer, intent(out)  fh,
integer, intent(in)  ix,
character(len=*), intent(in)  extension,
character(len=*), intent(in), optional  suffix 
)

Standard method for creating a new output file.

Parameters
[out]fhFile handle
[in]ixIndex of file
[in]extensionExtension of file
[in]suffixOptional suffix

Definition at line 87 of file mod_input_output_helper.t.

Here is the call graph for this function:

◆ get_names_from_string()

character(len=name_len) function, dimension(1:nwc), public mod_input_output_helper::get_names_from_string ( character(len=*), intent(in)  aux_variable_names,
integer, intent(in)  nwc 
)

Definition at line 18 of file mod_input_output_helper.t.

◆ snapshot_write_header1()

subroutine, public mod_input_output_helper::snapshot_write_header1 ( integer, intent(in)  fh,
integer(kind=mpi_offset_kind), intent(in)  offset_tree,
integer(kind=mpi_offset_kind), intent(in)  offset_block,
character(len=*), dimension(:), intent(in)  dataset_names,
integer, intent(in)  nw_vars 
)

Write header for a snapshot, generalize cons_wnames and nw.

If you edit the header, don't forget to update: snapshot_write_header(), snapshot_read_header(), doc/fileformat.md, tools/python/dat_reader.py

Parameters
[in]fhFile handle
[in]offset_treeOffset of tree info
[in]offset_blockOffset of block data

Definition at line 127 of file mod_input_output_helper.t.

Variable Documentation

◆ save_now

logical mod_input_output_helper::save_now

whether a manually inserted snapshot is saved

Definition at line 13 of file mod_input_output_helper.t.

◆ version_number

integer, parameter mod_input_output_helper::version_number = 5

Version number of the .dat file output.

Definition at line 15 of file mod_input_output_helper.t.