cp_output_handling_openpmd Module Reference

routines to handle the output, The idea is to remove the decision of wheter to output and what to output from the code that does the output, and centralize it here. More...

Data Types
type	cp_openpmd_per_call_value_type

Functions/Subroutines
type(cp_openpmd_per_call_value_type) function, public	cp_openpmd_get_value_unit_nr (key)
subroutine, public	cp_openpmd_output_finalize ()
	Close all outputs.
integer function, public	cp_openpmd_print_key_unit_nr (logger, basis_section, print_key_path, middle_name, ignore_should_output, mpi_io, fout, openpmd_basename, openpmd_unit_dimension, openpmd_unit_si, sim_time)
	...
subroutine, public	cp_openpmd_print_key_finished_output (unit_nr, logger, basis_section, print_key_path, local, ignore_should_output, mpi_io)
	should be called after you finish working with a unit obtained with cp_openpmd_print_key_unit_nr, so that the file that might have been opened can be closed.
subroutine, public	cp_openpmd_close_iterations ()
character(len=default_string_length) function, public	cp_openpmd_get_default_extension ()

Detailed Description

routines to handle the output, The idea is to remove the decision of wheter to output and what to output from the code that does the output, and centralize it here.

Note

These were originally together with the log handling routines, but have been spawned off. Some dependencies are still there, and some of the comments about log handling also applies to output handling:

See also

cp_log_handling

Function/Subroutine Documentation

cp_openpmd_get_value_unit_nr()

type(cp_openpmd_per_call_value_type) function, public cp_output_handling_openpmd::cp_openpmd_get_value_unit_nr

(

integer, intent(in)

key

)

Definition at line 622 of file cp_output_handling_openpmd.F.

cp_openpmd_output_finalize()

subroutine, public cp_output_handling_openpmd::cp_openpmd_output_finalize

Close all outputs.

Definition at line 637 of file cp_output_handling_openpmd.F.

Here is the caller graph for this function:

cp_openpmd_print_key_unit_nr()

integer function, public cp_output_handling_openpmd::cp_openpmd_print_key_unit_nr	(	type(cp_logger_type), pointer	logger,
		type(section_vals_type), intent(in)	basis_section,
		character(len=*), intent(in), optional	print_key_path,
		character(len=*), intent(in), optional	middle_name,
		logical, intent(in), optional	ignore_should_output,
		logical, intent(inout), optional	mpi_io,
		character(len=default_path_length), intent(out), optional	fout,
		character(len=*), intent(in), optional	openpmd_basename,
		real(kind=dp), dimension(7), intent(in), optional	openpmd_unit_dimension,
		real(kind=dp), intent(in), optional	openpmd_unit_si,
		real(kind=dp), intent(in), optional	sim_time
	)

...

Parameters

logger	...
basis_section	...
print_key_path	...
extension	...
middle_name	...
local	...
log_filename	...
ignore_should_output	...
do_backup	...
is_new_file	true if this rank created a new (or rewound) file, false otherwise
mpi_io	True if the file should be opened in parallel on all processors belonging to the communicator group. Automatically disabled if the file form or access mode is unsuitable for MPI IO. Return value indicates whether MPI was actually used and therefore the flag must also be passed to the file closing directive.
fout	Name of the actual file where the output will be written. Needed mainly for MPI IO because inquiring the filename from the MPI filehandle does not work across all MPI libraries.
openpmd_basename	Used to associate an identifier to each callsite of this module
use_openpmd	...
sim_time	Current simulation time in atomic units (used for timeOffset)

Returns

...

Definition at line 675 of file cp_output_handling_openpmd.F.

Here is the call graph for this function:

Here is the caller graph for this function:

cp_openpmd_print_key_finished_output()

subroutine, public cp_output_handling_openpmd::cp_openpmd_print_key_finished_output	(	integer, intent(inout)	unit_nr,
		type(cp_logger_type), pointer	logger,
		type(section_vals_type), intent(in)	basis_section,
		character(len=*), intent(in), optional	print_key_path,
		logical, intent(in), optional	local,
		logical, intent(in), optional	ignore_should_output,
		logical, intent(in), optional	mpi_io
	)

should be called after you finish working with a unit obtained with cp_openpmd_print_key_unit_nr, so that the file that might have been opened can be closed.

the inputs should be exactly the same of the corresponding cp_openpmd_print_key_unit_nr

Parameters

unit_nr	...
logger	...
basis_section	...
print_key_path	...
local	...
ignore_should_output	...
mpi_io	True if file was opened in parallel with MPI
use_openpmd	...

Note

closes if the corresponding filename of the printkey is not STD_OUT

Definition at line 813 of file cp_output_handling_openpmd.F.

Here is the caller graph for this function:

cp_openpmd_close_iterations()

subroutine, public cp_output_handling_openpmd::cp_openpmd_close_iterations

Definition at line 865 of file cp_output_handling_openpmd.F.

Here is the caller graph for this function:

cp_openpmd_get_default_extension()

character(len=default_string_length) function, public cp_output_handling_openpmd::cp_openpmd_get_default_extension

Definition at line 885 of file cp_output_handling_openpmd.F.

Here is the caller graph for this function: