m_start_up Module Reference

The purpose of the module is primarily to read in the files that contain the inputs, the initial condition data and the grid data that are provided by the user. The module is additionally tasked with verifying the consistency of the user inputs and completing the grid variablesThe purpose of the module is primarily to read in the files that contain the inputs, the initial condition data and the grid data that are provided by the user. The module is additionally tasked with verifying the consistency of the user inputs and completing the grid variables. This module also also allocating, initializing I/O, and deallocating the relevant variables on both cpus and gpus as well as setting up the time stepping, domain decomposition and I/O procedures. More...

Functions/Subroutines
subroutine, public	s_read_data_files (q_cons_vf)
	Read data files. Dispatch subroutine that replaces procedure pointer.
subroutine, public	s_read_input_file
	The purpose of this procedure is to first verify that an input file has been made available by the user. Provided that this is so, the input file is then read in.
subroutine, public	s_check_input_file
	The goal of this procedure is to verify that each of the user provided inputs is valid and that their combination constitutes a meaningful configuration for the simulation.
subroutine, public	s_read_serial_data_files (q_cons_vf)
subroutine, public	s_read_parallel_data_files (q_cons_vf)
subroutine, public	s_populate_grid_variables_buffers
	The purpose of this subroutine is to populate the buffers of the grid variables, which are constituted of the cell- boundary locations and cell-width distributions, based on the boundary conditions.
subroutine, public	s_initialize_internal_energy_equations (v_vf)
	The purpose of this procedure is to initialize the values of the internal-energy equations of each phase from the mass of each phase, the mixture momentum and mixture-total-energy equations.
subroutine, public	s_perform_time_step (t_step, time_avg, time_final, io_time_avg, io_time_final, proc_time, io_proc_time, file_exists, start, finish, nt)
subroutine, public	s_save_performance_metrics (t_step, time_avg, time_final, io_time_avg, io_time_final, proc_time, io_proc_time, file_exists, start, finish, nt)
subroutine, public	s_save_data (t_step, start, finish, io_time_avg, nt)
subroutine, public	s_initialize_modules
subroutine, public	s_initialize_mpi_domain
subroutine, public	s_initialize_gpu_vars
subroutine, public	s_finalize_modules

Variables
type(scalar_field), dimension(:), allocatable	grad_x_vf
type(scalar_field), dimension(:), allocatable	grad_y_vf
type(scalar_field), dimension(:), allocatable	grad_z_vf
type(scalar_field), dimension(:), allocatable	norm_vf
real(wp)	dt_init

Detailed Description

The purpose of the module is primarily to read in the files that contain the inputs, the initial condition data and the grid data that are provided by the user. The module is additionally tasked with verifying the consistency of the user inputs and completing the grid variablesThe purpose of the module is primarily to read in the files that contain the inputs, the initial condition data and the grid data that are provided by the user. The module is additionally tasked with verifying the consistency of the user inputs and completing the grid variables. This module also also allocating, initializing I/O, and deallocating the relevant variables on both cpus and gpus as well as setting up the time stepping, domain decomposition and I/O procedures.

Function/Subroutine Documentation

s_check_input_file()

subroutine, public m_start_up::s_check_input_file

The goal of this procedure is to verify that each of the user provided inputs is valid and that their combination constitutes a meaningful configuration for the simulation.

Here is the call graph for this function:

Here is the caller graph for this function:

s_finalize_modules()

subroutine, public m_start_up::s_finalize_modules

Here is the call graph for this function:

Here is the caller graph for this function:

s_initialize_gpu_vars()

subroutine, public m_start_up::s_initialize_gpu_vars

Here is the caller graph for this function:

s_initialize_internal_energy_equations()

subroutine, public m_start_up::s_initialize_internal_energy_equations

(

type(scalar_field), dimension(sys_size), intent(inout)

v_vf

)

The purpose of this procedure is to initialize the values of the internal-energy equations of each phase from the mass of each phase, the mixture momentum and mixture-total-energy equations.

Parameters

v_vf	conservative variables

Here is the call graph for this function:

Here is the caller graph for this function:

s_initialize_modules()

subroutine, public m_start_up::s_initialize_modules

Here is the call graph for this function:

Here is the caller graph for this function:

s_initialize_mpi_domain()

subroutine, public m_start_up::s_initialize_mpi_domain

Here is the call graph for this function:

Here is the caller graph for this function:

s_perform_time_step()

subroutine, public m_start_up::s_perform_time_step	(	integer, intent(inout)	t_step,
		real(wp), intent(inout)	time_avg,
		real(wp), intent(inout)	time_final,
		real(wp), intent(inout)	io_time_avg,
		real(wp), intent(inout)	io_time_final,
		real(wp), dimension(:), intent(inout)	proc_time,
		real(wp), dimension(:), intent(inout)	io_proc_time,
		logical, intent(inout)	file_exists,
		real(wp), intent(inout)	start,
		real(wp), intent(inout)	finish,
		integer, intent(inout)	nt )

Here is the call graph for this function:

Here is the caller graph for this function:

s_populate_grid_variables_buffers()

subroutine, public m_start_up::s_populate_grid_variables_buffers

The purpose of this subroutine is to populate the buffers of the grid variables, which are constituted of the cell- boundary locations and cell-width distributions, based on the boundary conditions.

Here is the call graph for this function:

Here is the caller graph for this function:

s_read_data_files()

subroutine, public m_start_up::s_read_data_files

(

type(scalar_field), dimension(sys_size), intent(inout)

q_cons_vf

)

Read data files. Dispatch subroutine that replaces procedure pointer.

Parameters

q_cons_vf

Conservative variables

Here is the call graph for this function:

Here is the caller graph for this function:

s_read_input_file()

subroutine, public m_start_up::s_read_input_file

The purpose of this procedure is to first verify that an input file has been made available by the user. Provided that this is so, the input file is then read in.

Here is the call graph for this function:

Here is the caller graph for this function:

s_read_parallel_data_files()

subroutine, public m_start_up::s_read_parallel_data_files

(

type(scalar_field), dimension(sys_size), intent(inout)

q_cons_vf

)

Here is the call graph for this function:

Here is the caller graph for this function:

s_read_serial_data_files()

subroutine, public m_start_up::s_read_serial_data_files

(

type(scalar_field), dimension(sys_size), intent(inout)

q_cons_vf

)

Here is the call graph for this function:

Here is the caller graph for this function:

s_save_data()

subroutine, public m_start_up::s_save_data	(	integer, intent(inout)	t_step,
		real(wp), intent(inout)	start,
		real(wp), intent(inout)	finish,
		real(wp), intent(inout)	io_time_avg,
		integer, intent(inout)	nt )

Here is the call graph for this function:

Here is the caller graph for this function:

s_save_performance_metrics()

subroutine, public m_start_up::s_save_performance_metrics	(	integer, intent(inout)	t_step,
		real(wp), intent(inout)	time_avg,
		real(wp), intent(inout)	time_final,
		real(wp), intent(inout)	io_time_avg,
		real(wp), intent(inout)	io_time_final,
		real(wp), dimension(:), intent(inout)	proc_time,
		real(wp), dimension(:), intent(inout)	io_proc_time,
		logical, intent(inout)	file_exists,
		real(wp), intent(inout)	start,
		real(wp), intent(inout)	finish,
		integer, intent(inout)	nt )

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

dt_init

real(wp) m_start_up::dt_init

grad_x_vf

type(scalar_field), dimension(:), allocatable m_start_up::grad_x_vf

grad_y_vf

type(scalar_field), dimension(:), allocatable m_start_up::grad_y_vf

grad_z_vf

type(scalar_field), dimension(:), allocatable m_start_up::grad_z_vf

norm_vf

type(scalar_field), dimension(:), allocatable m_start_up::norm_vf