m_start_up Module Reference

This module contains subroutines that read, and check consistency of, the user provided inputs, grid and data. This module also allocates and initializes the relevant variables sets up the mpi decomposition and initial condition procedures. More...

Data Types
interface	s_read_abstract_grid_data_files
interface	s_read_abstract_ic_data_files

Functions/Subroutines
subroutine, public	s_read_input_file
	Reads the configuration file pre_process.inp, in order to populate the parameters in module m_global_parameters.f90 with the user provided inputs.
subroutine, public	s_check_input_file
	Checking that the user inputs make sense, i.e. that the individual choices are compatible with the code's options and that the combination of these choices results into a valid configuration for the pre-process.
subroutine, public	s_read_serial_grid_data_files
	The goal of this subroutine is to read in any preexisting grid data as well as based on the imported grid, complete the necessary global computational domain parameters.
subroutine, public	s_check_grid_data_files
	Cell-boundary data are checked for consistency by looking at the (non-)uniform cell-width distributions for all the active coordinate directions and making sure that all of the cell-widths are positively valued.
subroutine, public	s_read_serial_ic_data_files (q_cons_vf, ib_markers)
	The goal of this subroutine is to read in any preexisting initial condition data files so that they may be used by the pre-process as a starting point in the creation of an all new initial condition.
subroutine, public	s_read_parallel_grid_data_files
	Cell-boundary data are checked for consistency by looking at the (non-)uniform cell-width distributions for all the active coordinate directions and making sure that all of the cell-widths are positively valued.
subroutine, public	s_read_parallel_ic_data_files (q_cons_vf, ib_markers)
	The goal of this subroutine is to read in any preexisting initial condition data files so that they may be used by the pre-process as a starting point in the creation of an all new initial condition.
subroutine, public	s_initialize_modules
subroutine, public	s_read_grid ()
subroutine, public	s_apply_initial_condition (start, finish, proc_time, time_avg, time_final, file_exists)
subroutine, public	s_save_data (proc_time, time_avg, time_final, file_exists)
subroutine, public	s_initialize_mpi_domain
subroutine, public	s_finalize_modules

Variables
character(len=path_len+name_len)	proc_rank_dir
	Location of the folder associated with the rank of the local processor.
character(len=path_len+2 *name_len), private	t_step_dir
	Possible location of time-step folder containing preexisting grid and/or conservative variables data to be used as starting point for pre-process.
procedure(s_read_abstract_grid_data_files), pointer, public	s_read_grid_data_files => null()
procedure(s_read_abstract_ic_data_files), pointer, public	s_read_ic_data_files => null()

Detailed Description

This module contains subroutines that read, and check consistency of, the user provided inputs, grid and data. This module also allocates and initializes the relevant variables sets up the mpi decomposition and initial condition procedures.

Function/Subroutine Documentation

s_apply_initial_condition()

subroutine, public m_start_up::s_apply_initial_condition	(	real(wp), intent(inout)	start,
		real(wp), intent(inout)	finish,
		real(wp), dimension(:), intent(inout)	proc_time,
		real(wp), intent(inout)	time_avg,
		real(wp), intent(inout)	time_final,
		logical, intent(inout)	file_exists )

Here is the call graph for this function:

Here is the caller graph for this function:

s_check_grid_data_files()

subroutine, public m_start_up::s_check_grid_data_files

Cell-boundary data are checked for consistency by looking at the (non-)uniform cell-width distributions for all the active coordinate directions and making sure that all of the cell-widths are positively valued.

Here is the call graph for this function:

Here is the caller graph for this function:

s_check_input_file()

subroutine, public m_start_up::s_check_input_file

Checking that the user inputs make sense, i.e. that the individual choices are compatible with the code's options and that the combination of these choices results into a valid configuration for the pre-process.

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_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_read_grid()

subroutine, public m_start_up::s_read_grid

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

Reads the configuration file pre_process.inp, in order to populate the parameters in module m_global_parameters.f90 with the user provided inputs.

Here is the call graph for this function:

Here is the caller graph for this function:

s_read_parallel_grid_data_files()

subroutine, public m_start_up::s_read_parallel_grid_data_files

Cell-boundary data are checked for consistency by looking at the (non-)uniform cell-width distributions for all the active coordinate directions and making sure that all of the cell-widths are positively valued.

Here is the call graph for this function:

Here is the caller graph for this function:

s_read_parallel_ic_data_files()

subroutine, public m_start_up::s_read_parallel_ic_data_files	(	type(scalar_field), dimension(sys_size), intent(inout)	q_cons_vf,
		type(integer_field), intent(inout)	ib_markers )

The goal of this subroutine is to read in any preexisting initial condition data files so that they may be used by the pre-process as a starting point in the creation of an all new initial condition.

Parameters

q_cons_vf	Conservative variables
ib_markers	track if a cell is within the immersed boundary

Here is the call graph for this function:

Here is the caller graph for this function:

s_read_serial_grid_data_files()

subroutine, public m_start_up::s_read_serial_grid_data_files

The goal of this subroutine is to read in any preexisting grid data as well as based on the imported grid, complete the necessary global computational domain parameters.

Here is the call graph for this function:

Here is the caller graph for this function:

s_read_serial_ic_data_files()

subroutine, public m_start_up::s_read_serial_ic_data_files	(	type(scalar_field), dimension(sys_size), intent(inout)	q_cons_vf,
		type(integer_field), intent(inout)	ib_markers )

The goal of this subroutine is to read in any preexisting initial condition data files so that they may be used by the pre-process as a starting point in the creation of an all new initial condition.

Parameters

q_cons_vf	Conservative variables
ib_markers	track if a cell is within the immersed boundary

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	(	real(wp), dimension(:), intent(inout)	proc_time,
		real(wp), intent(inout)	time_avg,
		real(wp), intent(inout)	time_final,
		logical, intent(inout)	file_exists )

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

proc_rank_dir

character(len=path_len + name_len) m_start_up::proc_rank_dir

Location of the folder associated with the rank of the local processor.

s_read_grid_data_files

procedure(s_read_abstract_grid_data_files), pointer, public m_start_up::s_read_grid_data_files => null()

s_read_ic_data_files

procedure(s_read_abstract_ic_data_files), pointer, public m_start_up::s_read_ic_data_files => null()

t_step_dir

character(len=path_len + 2*name_len), private m_start_up::t_step_dir

private

Possible location of time-step folder containing preexisting grid and/or conservative variables data to be used as starting point for pre-process.