The primary purpose of this module is to output the grid and the conservative variables data at the chosen time-step interval. In addition, this module is also in charge of outputting a run-time information file which summarizes the time-dependent behavior !of the stability criteria. The latter include the inviscid Courant– Friedrichs–Lewy (ICFL), viscous CFL (VCFL), capillary CFL (CCFL) and cell Reynolds (Rc) numbers. More...

Functions/Subroutines
impure subroutine, public	s_write_data_files (q_cons_vf, q_t_sf, q_prim_vf, t_step, bc_type, beta)
	Write data files. Dispatch subroutine that replaces procedure pointer.

impure subroutine, public	s_open_run_time_information_file
	The purpose of this subroutine is to open a new or pre- existing run-time information file and append to it the basic header information relevant to current simulation. In general, this requires generating a table header for those stability criteria which will be written at every time-step.

impure subroutine, public	s_open_com_files ()
	This opens a formatted data file where the root processor can write out the CoM information.

impure subroutine, public	s_open_probe_files
	This opens a formatted data file where the root processor can write out flow probe information.

impure subroutine, public	s_write_run_time_information (q_prim_vf, t_step)
	The goal of the procedure is to output to the run-time information file the stability criteria extrema in the entire computational domain and at the given time-step. Moreover, the subroutine is also in charge of tracking these stability criteria extrema over all time-steps.

impure subroutine, public	s_write_serial_data_files (q_cons_vf, q_t_sf, q_prim_vf, t_step, bc_type, beta)
	The goal of this subroutine is to output the grid and conservative variables data files for given time-step.

impure subroutine, public	s_write_parallel_data_files (q_cons_vf, t_step, bc_type, beta)
	The goal of this subroutine is to output the grid and conservative variables data files for given time-step.

impure subroutine, public	s_write_com_files (t_step, c_mass_in)
	This writes a formatted data file where the root processor can write out the CoM information.

impure subroutine, public	s_write_probe_files (t_step, q_cons_vf, accel_mag)
	This writes a formatted data file for the flow probe information.

impure subroutine, public	s_close_run_time_information_file
	The goal of this subroutine is to write to the run-time information file basic footer information applicable to the current computation and to close the file when done. The footer contains the stability criteria extrema over all of the time-steps and the simulation run-time.

impure subroutine, public	s_close_com_files ()
	Closes communication files.

impure subroutine, public	s_close_probe_files
	Closes probe files.

impure subroutine, public	s_initialize_data_output_module
	The computation of parameters, the allocation of memory, the association of pointers and/or the execution of any other procedures that are necessary to setup the module.

impure subroutine, public	s_finalize_data_output_module
	Module deallocation and/or disassociation procedures.

Variables
real(wp), dimension(:, :, :), allocatable	icfl_sf
	ICFL stability criterion.

real(wp), dimension(:, :, :), allocatable	vcfl_sf
	VCFL stability criterion.

real(wp), dimension(:, :, :), allocatable	ccfl_sf
	CCFL stability criterion.

real(wp), dimension(:, :, :), allocatable	rc_sf
	Rc stability criterion.

real(wp), dimension(:, :), allocatable, public	c_mass

real(wp)	icfl_max_loc

real(wp)	icfl_max_glb
	ICFL stability extrema on local and global grids.

real(wp)	vcfl_max_loc

real(wp)	vcfl_max_glb
	VCFL stability extrema on local and global grids.

real(wp)	ccfl_max_loc

real(wp)	ccfl_max_glb
	CCFL stability extrema on local and global grids.

real(wp)	rc_min_loc

real(wp)	rc_min_glb
	Rc stability extrema on local and global grids.

type(scalar_field), dimension(:), allocatable	q_cons_temp_ds

ICFL, VCFL, CCFL and Rc stability criteria extrema over all the time-steps
real(wp)	icfl_max
	ICFL criterion maximum.

real(wp)	vcfl_max
	VCFL criterion maximum.

real(wp)	ccfl_max
	CCFL criterion maximum.

real(wp)	rc_min
	Rc criterion maximum.

Detailed Description

The primary purpose of this module is to output the grid and the conservative variables data at the chosen time-step interval. In addition, this module is also in charge of outputting a run-time information file which summarizes the time-dependent behavior !of the stability criteria. The latter include the inviscid Courant– Friedrichs–Lewy (ICFL), viscous CFL (VCFL), capillary CFL (CCFL) and cell Reynolds (Rc) numbers.

Function/Subroutine Documentation

◆ s_close_com_files()

impure subroutine, public m_data_output::s_close_com_files

Closes communication files.

◆ s_close_probe_files()

impure subroutine, public m_data_output::s_close_probe_files

Closes probe files.

◆ s_close_run_time_information_file()

impure subroutine, public m_data_output::s_close_run_time_information_file

The goal of this subroutine is to write to the run-time information file basic footer information applicable to the current computation and to close the file when done. The footer contains the stability criteria extrema over all of the time-steps and the simulation run-time.

◆ s_finalize_data_output_module()

impure subroutine, public m_data_output::s_finalize_data_output_module

Module deallocation and/or disassociation procedures.

Here is the caller graph for this function:

◆ s_initialize_data_output_module()

impure subroutine, public m_data_output::s_initialize_data_output_module

The computation of parameters, the allocation of memory, the association of pointers and/or the execution of any other procedures that are necessary to setup the module.

Here is the caller graph for this function:

◆ s_open_com_files()

impure subroutine, public m_data_output::s_open_com_files

This opens a formatted data file where the root processor can write out the CoM information.

◆ s_open_probe_files()

impure subroutine, public m_data_output::s_open_probe_files

This opens a formatted data file where the root processor can write out flow probe information.

◆ s_open_run_time_information_file()

impure subroutine, public m_data_output::s_open_run_time_information_file

The purpose of this subroutine is to open a new or pre- existing run-time information file and append to it the basic header information relevant to current simulation. In general, this requires generating a table header for those stability criteria which will be written at every time-step.

◆ s_write_com_files()

impure subroutine, public m_data_output::s_write_com_files	(	integer, intent(in)	t_step,
		real(wp), dimension(num_fluids, 5), intent(in)	c_mass_in )

This writes a formatted data file where the root processor can write out the CoM information.

Parameters

t_step	Current time-step
q_com	Center of mass information
moments	Higher moment information

◆ s_write_data_files()

impure subroutine, public m_data_output::s_write_data_files	(	type(scalar_field), dimension(sys_size), intent(inout)	q_cons_vf,
		type(scalar_field), intent(inout)	q_t_sf,
		type(scalar_field), dimension(sys_size), intent(inout)	q_prim_vf,
		integer, intent(in)	t_step,
		type(integer_field), dimension(1:num_dims, -1:1), intent(in)	bc_type,
		type(scalar_field), intent(inout), optional	beta )

Write data files. Dispatch subroutine that replaces procedure pointer.

Parameters

q_cons_vf	Conservative variables
q_prim_vf	Primitive variables
t_step	Current time step

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_write_parallel_data_files()

impure subroutine, public m_data_output::s_write_parallel_data_files	(	type(scalar_field), dimension(sys_size), intent(inout)	q_cons_vf,
		integer, intent(in)	t_step,
		type(integer_field), dimension(1:num_dims, -1:1), intent(in)	bc_type,
		type(scalar_field), intent(inout), optional	beta )

The goal of this subroutine is to output the grid and conservative variables data files for given time-step.

Parameters

q_cons_vf	Cell-average conservative variables
t_step	Current time-step
beta	Eulerian void fraction from lagrangian bubbles

Here is the call graph for this function:

Here is the caller graph for this function:

◆ s_write_probe_files()

impure subroutine, public m_data_output::s_write_probe_files	(	integer, intent(in)	t_step,
		type(scalar_field), dimension(sys_size), intent(in)	q_cons_vf,
		real(wp), dimension(0:m, 0:n, 0:p), intent(in)	accel_mag )

This writes a formatted data file for the flow probe information.

Parameters

t_step	Current time-step
q_cons_vf	Conservative variables
accel_mag	Acceleration magnitude information

Here is the call graph for this function:

◆ s_write_run_time_information()

impure subroutine, public m_data_output::s_write_run_time_information	(	type(scalar_field), dimension(sys_size), intent(in)	q_prim_vf,
		integer, intent(in)	t_step )

The goal of the procedure is to output to the run-time information file the stability criteria extrema in the entire computational domain and at the given time-step. Moreover, the subroutine is also in charge of tracking these stability criteria extrema over all time-steps.

Parameters

q_prim_vf	Cell-average primitive variables
t_step	Current time step

Here is the call graph for this function:

◆ s_write_serial_data_files()

impure subroutine, public m_data_output::s_write_serial_data_files	(	type(scalar_field), dimension(sys_size), intent(inout)	q_cons_vf,
		type(scalar_field), intent(inout)	q_t_sf,
		type(scalar_field), dimension(sys_size), intent(inout)	q_prim_vf,
		integer, intent(in)	t_step,
		type(integer_field), dimension(1:num_dims, -1:1), intent(in)	bc_type,
		type(scalar_field), intent(inout), optional	beta )

The goal of this subroutine is to output the grid and conservative variables data files for given time-step.

Parameters

q_cons_vf	Cell-average conservative variables
q_prim_vf	Cell-average primitive variables
t_step	Current time-step

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ c_mass

real(wp), dimension(:, :), allocatable, public m_data_output::c_mass

◆ ccfl_max

real(wp) m_data_output::ccfl_max

CCFL criterion maximum.

◆ ccfl_max_glb

real(wp) m_data_output::ccfl_max_glb

CCFL stability extrema on local and global grids.

◆ ccfl_max_loc

real(wp) m_data_output::ccfl_max_loc

◆ ccfl_sf

real(wp), dimension(:, :, :), allocatable m_data_output::ccfl_sf

CCFL stability criterion.

◆ icfl_max

real(wp) m_data_output::icfl_max

ICFL criterion maximum.

◆ icfl_max_glb

real(wp) m_data_output::icfl_max_glb

ICFL stability extrema on local and global grids.

◆ icfl_max_loc

real(wp) m_data_output::icfl_max_loc

◆ icfl_sf

real(wp), dimension(:, :, :), allocatable m_data_output::icfl_sf

ICFL stability criterion.

◆ q_cons_temp_ds

type(scalar_field), dimension(:), allocatable m_data_output::q_cons_temp_ds

◆ rc_min

real(wp) m_data_output::rc_min

Rc criterion maximum.

◆ rc_min_glb

real(wp) m_data_output::rc_min_glb

Rc stability extrema on local and global grids.

◆ rc_min_loc

real(wp) m_data_output::rc_min_loc

◆ rc_sf

real(wp), dimension(:, :, :), allocatable m_data_output::rc_sf

Rc stability criterion.

◆ vcfl_max

real(wp) m_data_output::vcfl_max

VCFL criterion maximum.

◆ vcfl_max_glb

real(wp) m_data_output::vcfl_max_glb

VCFL stability extrema on local and global grids.

◆ vcfl_max_loc

real(wp) m_data_output::vcfl_max_loc

◆ vcfl_sf

real(wp), dimension(:, :, :), allocatable m_data_output::vcfl_sf

VCFL stability criterion.

Functions/Subroutines

Variables

Detailed Description

Function/Subroutine Documentation

◆ s_close_com_files()

◆ s_close_probe_files()

◆ s_close_run_time_information_file()

◆ s_finalize_data_output_module()

◆ s_initialize_data_output_module()

◆ s_open_com_files()

◆ s_open_probe_files()

◆ s_open_run_time_information_file()

◆ s_write_com_files()

◆ s_write_data_files()

◆ s_write_parallel_data_files()

◆ s_write_probe_files()

◆ s_write_run_time_information()

◆ s_write_serial_data_files()

Variable Documentation

◆ c_mass

◆ ccfl_max

◆ ccfl_max_glb

◆ ccfl_max_loc

◆ ccfl_sf

◆ icfl_max

◆ icfl_max_glb

◆ icfl_max_loc

◆ icfl_sf

◆ q_cons_temp_ds

◆ rc_min

◆ rc_min_glb

◆ rc_min_loc

◆ rc_sf

◆ vcfl_max

◆ vcfl_max_glb

◆ vcfl_max_loc

◆ vcfl_sf