Module for reading input and writing output. More...

Functions/Subroutines
subroutine	read_arguments ()
	Read the command line arguments passed to amrvac. More...

subroutine	read_par_files ()
	Read in the user-supplied parameter-file. More...

subroutine	get_fields_string (line, delims, n_max, fields, n_found, fully_read)
	Routine to find entries in a string. More...

subroutine	saveamrfile (ifile)

subroutine, public	create_output_file (fh, ix, extension, suffix)
	Standard method for creating a new output file. More...

logical function	snapshot_exists (ix)

integer function	get_snapshot_index (filename)

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

subroutine, public	snapshot_write_header (fh, offset_tree, offset_block)
	Write header for a snapshot. More...

subroutine	snapshot_read_header (fh, offset_tree, offset_block)
	Read header for a snapshot. More...

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	write_snapshot

subroutine	read_snapshot
	Routine to read in snapshots (.dat files). When it cannot recognize the file version, it will automatically try the 'old' reader. More...

subroutine	read_snapshot_old ()

subroutine	printlog_default
	Write volume-averaged values and other information to the log file. More...

subroutine	printlog_regression_test ()
	Print a log that can be used to check whether the code still produces the same output (regression test) More...

subroutine	get_volume_average (power, mode, volume)
	Compute mean(w**power) over the leaves of the grid. The first mode (power=1) corresponds to the mean, the second to the mean squared values and so on. More...

subroutine	get_volume_coverage (vol_cov)
	Compute how much of the domain is covered by each grid level. This routine does not take a non-Cartesian geometry into account. More...

subroutine	get_volume_average_func (func, f_avg, volume)
	Compute the volume average of func(w) over the leaves of the grid. More...

subroutine	get_global_maxima (wmax)
	Compute global maxima of iw variables over the leaves of the grid. More...

subroutine	get_global_minima (wmin)
	Compute global minima of iw variables over the leaves of the grid. More...

Variables
integer, parameter	version_number = 5
	Version number of the .dat file output. More...

integer, dimension(3), parameter	compatible_versions = [3, 4, 5]
	List of compatible versions. More...

integer	nw_found
	number of w found in dat files More...

logical	save_now
	whether a manually inserted snapshot is saved More...

character(len= *), parameter	fmt_r = 'es16.8'

character(len= *), parameter	fmt_r2 = 'es10.2'

character(len= *), parameter	fmt_i = 'i8'

Detailed Description

Module for reading input and writing output.

Function/Subroutine Documentation

◆ block_shape_io()

subroutine, public mod_input_output::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_ghost	nghost(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]	ixo	Index range on output block
[out]	l	Index range on output block
[out]	n_values	Number of cells/values in output

Definition at line 2088 of file mod_input_output.t.

Here is the call graph for this function:

◆ count_ix()

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

Compute number of elements in index range.

Definition at line 2080 of file mod_input_output.t.

◆ create_output_file()

subroutine, public mod_input_output::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]	fh	File handle
[in]	ix	Index of file
[in]	extension	Extension of file
[in]	suffix	Optional suffix

Definition at line 1754 of file mod_input_output.t.

Here is the call graph for this function:

◆ get_fields_string()

subroutine mod_input_output::get_fields_string	(	character(len=*), intent(in)	line,
		character(len=*), intent(in)	delims,
		integer, intent(in)	n_max,
		character(len=*), dimension(n_max), intent(inout)	fields,
		integer, intent(inout)	n_found,
		logical, intent(out), optional	fully_read
	)

Routine to find entries in a string.

Parameters

[in]	line	The line from which we want to read
[in]	delims	A string with delimiters. For example delims = " ,'"""//char(9)
[in]	n_max	Maximum number of entries to read in
[in,out]	n_found	Number of entries found
[in,out]	fields	Fields in the strings

Definition at line 1652 of file mod_input_output.t.

◆ get_global_maxima()

subroutine mod_input_output::get_global_maxima ( double precision, dimension(nw), intent(out) wmax )

Compute global maxima of iw variables over the leaves of the grid.

Parameters

[out] wmax The global maxima

Definition at line 2899 of file mod_input_output.t.

◆ get_global_minima()

subroutine mod_input_output::get_global_minima ( double precision, dimension(nw), intent(out) wmin )

Compute global minima of iw variables over the leaves of the grid.

Parameters

[out] wmin The global maxima

Definition at line 2926 of file mod_input_output.t.

◆ get_snapshot_index()

integer function mod_input_output::get_snapshot_index ( character(len=*), intent(in) filename )

Definition at line 1799 of file mod_input_output.t.

◆ get_volume_average()

subroutine mod_input_output::get_volume_average	(	integer, intent(in)	power,
		double precision, dimension(nw), intent(out)	mode,
		double precision, intent(out)	volume
	)

Compute mean(w**power) over the leaves of the grid. The first mode (power=1) corresponds to the mean, the second to the mean squared values and so on.

Parameters

[in]	power	Which mode to compute
[out]	mode	The computed mode
[out]	volume	The total grid volume

Definition at line 2792 of file mod_input_output.t.

◆ get_volume_average_func()

subroutine mod_input_output::get_volume_average_func	(		func,
		double precision, intent(out)	f_avg,
		double precision, intent(out)	volume
	)

Compute the volume average of func(w) over the leaves of the grid.

Parameters

[out]	f_avg	The volume average of func
[out]	volume	The total grid volume

Definition at line 2856 of file mod_input_output.t.

◆ get_volume_coverage()

subroutine mod_input_output::get_volume_coverage ( double precision, dimension(1:refine_max_level), intent(out) vol_cov )

Compute how much of the domain is covered by each grid level. This routine does not take a non-Cartesian geometry into account.

Definition at line 2830 of file mod_input_output.t.

◆ printlog_default()

subroutine mod_input_output::printlog_default

Write volume-averaged values and other information to the log file.

Definition at line 2631 of file mod_input_output.t.

Here is the call graph for this function:

◆ printlog_regression_test()

subroutine mod_input_output::printlog_regression_test

Print a log that can be used to check whether the code still produces the same output (regression test)

Definition at line 2762 of file mod_input_output.t.

Here is the call graph for this function:

◆ read_arguments()

subroutine mod_input_output::read_arguments

Read the command line arguments passed to amrvac.

Definition at line 40 of file mod_input_output.t.

Here is the call graph for this function:

◆ read_par_files()

subroutine mod_input_output::read_par_files

Read in the user-supplied parameter-file.

How to apply dimensional splitting to the source terms, see Discretization

Which flux scheme of spatial discretization to use (per grid level)

Which type of the maximal bound speed of Riemann fan to use

Which time stepper to use

Which time integrator to use

type of curl operator

Limiter used for prolongation to refined grids and ghost cells

How to compute the CFL-limited time step. Options are 'maxsum': max(sum(c/dx)); 'summax': sum(max(c/dx)) and 'minimum: max(c/dx), where the summations loop over the grid dimensions and c is the velocity. The default 'maxsum' is the conventiontal way of computing CFL-limited time steps.

Definition at line 179 of file mod_input_output.t.

Here is the call graph for this function:

◆ read_snapshot()

subroutine mod_input_output::read_snapshot

Routine to read in snapshots (.dat files). When it cannot recognize the file version, it will automatically try the 'old' reader.

Definition at line 2292 of file mod_input_output.t.

Here is the call graph for this function:

◆ read_snapshot_old()

subroutine mod_input_output::read_snapshot_old

Definition at line 2492 of file mod_input_output.t.

Here is the call graph for this function:

◆ saveamrfile()

subroutine mod_input_output::saveamrfile ( integer ifile )

Definition at line 1700 of file mod_input_output.t.

Here is the call graph for this function:

◆ snapshot_exists()

logical function mod_input_output::snapshot_exists ( integer, intent(in) ix )

Parameters

[in] ix Index of snapshot

Definition at line 1790 of file mod_input_output.t.

◆ snapshot_read_header()

subroutine mod_input_output::snapshot_read_header	(	integer, intent(in)	fh,
		integer(mpi_offset_kind), intent(out)	offset_tree,
		integer(mpi_offset_kind), intent(out)	offset_block
	)

Read header for a snapshot.

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]	fh	File handle
[out]	offset_tree	Offset of tree info
[out]	offset_block	Offset of block data

Definition at line 1908 of file mod_input_output.t.

Here is the call graph for this function:

◆ snapshot_write_header()

subroutine, public mod_input_output::snapshot_write_header	(	integer, intent(in)	fh,
		integer(kind=mpi_offset_kind), intent(in)	offset_tree,
		integer(kind=mpi_offset_kind), intent(in)	offset_block
	)

Write header for a snapshot.

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]	fh	File handle
[in]	offset_tree	Offset of tree info
[in]	offset_block	Offset of block data

Definition at line 1893 of file mod_input_output.t.

Here is the call graph for this function:

◆ snapshot_write_header1()

subroutine, public mod_input_output::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]	fh	File handle
[in]	offset_tree	Offset of tree info
[in]	offset_block	Offset of block data

Definition at line 1813 of file mod_input_output.t.

◆ write_snapshot()

subroutine mod_input_output::write_snapshot

Definition at line 2120 of file mod_input_output.t.

Here is the call graph for this function:

Variable Documentation

◆ compatible_versions

integer, dimension(3), parameter mod_input_output::compatible_versions = [3, 4, 5]

List of compatible versions.

Definition at line 11 of file mod_input_output.t.

◆ fmt_i

character(len=*), parameter mod_input_output::fmt_i = 'i8'

Definition at line 28 of file mod_input_output.t.

◆ fmt_r

character(len=*), parameter mod_input_output::fmt_r = 'es16.8'

Definition at line 26 of file mod_input_output.t.

◆ fmt_r2

character(len=*), parameter mod_input_output::fmt_r2 = 'es10.2'

Definition at line 27 of file mod_input_output.t.

◆ nw_found

integer mod_input_output::nw_found

number of w found in dat files

Definition at line 14 of file mod_input_output.t.

◆ save_now

logical mod_input_output::save_now

whether a manually inserted snapshot is saved

Definition at line 23 of file mod_input_output.t.

◆ version_number

integer, parameter mod_input_output::version_number = 5

Version number of the .dat file output.

Definition at line 8 of file mod_input_output.t.

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ block_shape_io()

◆ count_ix()

◆ create_output_file()

◆ get_fields_string()

◆ get_global_maxima()

◆ get_global_minima()

◆ get_snapshot_index()

◆ get_volume_average()

◆ get_volume_average_func()

◆ get_volume_coverage()

◆ printlog_default()

◆ printlog_regression_test()

◆ read_arguments()

◆ read_par_files()

◆ read_snapshot()

◆ read_snapshot_old()

◆ saveamrfile()

◆ snapshot_exists()

◆ snapshot_read_header()

◆ snapshot_write_header()

◆ snapshot_write_header1()

◆ write_snapshot()

Variable Documentation

◆ compatible_versions

◆ fmt_i

◆ fmt_r

◆ fmt_r2

◆ nw_found

◆ save_now

◆ version_number