MFC:Pre_process  v1.0
m_start_up Module Reference

This module contains subroutines that read, and check consistency of, the user provided inputs and data. 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. More...
 
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. More...
 
subroutine s_check_line_segment_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the line segment patch have consistently been inputted by the user. More...
 
subroutine s_check_circle_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the circle patch have consistently been inputted by the user. More...
 
subroutine s_check_rectangle_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the rectangle patch have consistently been inputted by the user. More...
 
subroutine s_check_line_sweep_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the line sweep patch have consistently been inputted by the user. More...
 
subroutine s_check_ellipse_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the ellipse patch have consistently been inputted by the user. More...
 
subroutine s_check_isentropic_vortex_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the isentropic vortex patch have been entered by the user consistently. More...
 
subroutine s_check_1d_analytical_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the analytical patch have consistently been inputted by the user. More...
 
subroutine s_check_2d_analytical_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the analytical patch have consistently been inputted by the user. More...
 
subroutine s_check_3d_analytical_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the analytical patch have consistently been inputted by the user. More...
 
subroutine s_check_sphere_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the sphere patch have consistently been inputted by the user. More...
 
subroutine s_check_spherical_harmonic_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the spherical harmonic patch have consistently been inputted by the user. More...
 
subroutine s_check_cuboid_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the cuboid patch have consistently been inputted by the user. More...
 
subroutine s_check_cylinder_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the cylinder patch have consistently been inputted by the user. More...
 
subroutine s_check_plane_sweep_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the plane sweep patch have consistently been inputted by the user. More...
 
subroutine s_check_ellipsoid_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the ellipsoid patch have consistently been inputted by the user. More...
 
subroutine s_check_inactive_patch_geometry (patch_id)
 This subroutine verifies that the geometric parameters of the inactive patch remain unaltered by the user inputs. More...
 
subroutine s_check_active_patch_alteration_rights (patch_id)
 This subroutine verifies that any rights granted to the given active patch, to overwrite the preceding active patches, were consistently inputted by the user. More...
 
subroutine s_check_inactive_patch_alteration_rights (patch_id)
 This subroutine verifies that the rights of the given inactive patch, to overwrite the preceding patches, remain unaltered by the user inputs. More...
 
subroutine s_check_supported_patch_smoothing (patch_id)
 This subroutine verifies that the smoothing parameters of the given patch, which supports the smoothing out of its boundaries, have consistently been inputted by the user. More...
 
subroutine s_check_unsupported_patch_smoothing (patch_id)
 This subroutine verifies that the smoothing parameters of the given patch, which does not support the smoothing out of its boundaries, remain unaltered by the user inputs. More...
 
subroutine s_check_active_patch_primitive_variables (patch_id)
 This subroutine verifies that the primitive variables associated with the given active patch are physically consistent. More...
 
subroutine s_check_inactive_patch_primitive_variables (patch_id)
 This subroutine verifies that the primitive variables associated with the given inactive patch remain unaltered by the user inputs. More...
 
subroutine, public s_read_serial_grid_data_files (dflt_int)
 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. More...
 
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. More...
 
subroutine, public s_read_serial_ic_data_files (q_cons_vf)
 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. More...
 
subroutine, public s_read_parallel_grid_data_files (dflt_int)
 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. More...
 
subroutine, public s_read_parallel_ic_data_files (q_cons_vf)
 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. More...
 
subroutine, public s_initialize_start_up_module ()
 
subroutine, public s_finalize_start_up_module ()
 

Variables

character(len=path_len+name_len) proc_rank_dir
 Location of the folder associated with the rank of the local processor. More...
 
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. More...
 
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 and data.

Function/Subroutine Documentation

◆ s_check_1d_analytical_patch_geometry()

subroutine m_start_up::s_check_1d_analytical_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the analytical patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1178 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_2d_analytical_patch_geometry()

subroutine m_start_up::s_check_2d_analytical_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the analytical patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1202 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_3d_analytical_patch_geometry()

subroutine m_start_up::s_check_3d_analytical_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the analytical patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1230 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_active_patch_alteration_rights()

subroutine m_start_up::s_check_active_patch_alteration_rights ( integer, intent(in)  patch_id)

This subroutine verifies that any rights granted to the given active patch, to overwrite the preceding active patches, were consistently inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1548 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_active_patch_primitive_variables()

subroutine m_start_up::s_check_active_patch_primitive_variables ( integer, intent(in)  patch_id)

This subroutine verifies that the primitive variables associated with the given active patch are physically consistent.

Parameters
patch_idPatch identifier

Definition at line 1668 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_circle_patch_geometry()

subroutine m_start_up::s_check_circle_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the circle patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1022 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_cuboid_patch_geometry()

subroutine m_start_up::s_check_cuboid_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the cuboid patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1333 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_cylinder_patch_geometry()

subroutine m_start_up::s_check_cylinder_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the cylinder patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1372 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_ellipse_patch_geometry()

subroutine m_start_up::s_check_ellipse_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the ellipse patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1115 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_ellipsoid_patch_geometry()

subroutine m_start_up::s_check_ellipsoid_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the ellipsoid patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1462 of file m_start_up.f90.

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.

Definition at line 1943 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_inactive_patch_alteration_rights()

subroutine m_start_up::s_check_inactive_patch_alteration_rights ( integer, intent(in)  patch_id)

This subroutine verifies that the rights of the given inactive patch, to overwrite the preceding patches, remain unaltered by the user inputs.

Parameters
patch_idPatch identifier

Definition at line 1574 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_inactive_patch_geometry()

subroutine m_start_up::s_check_inactive_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the inactive patch remain unaltered by the user inputs.

Parameters
patch_idPatch identifier

Definition at line 1497 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_inactive_patch_primitive_variables()

subroutine m_start_up::s_check_inactive_patch_primitive_variables ( integer, intent(in)  patch_id)

This subroutine verifies that the primitive variables associated with the given inactive patch remain unaltered by the user inputs.

Parameters
patch_idPatch identifier

Definition at line 1748 of file m_start_up.f90.

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.

Definition at line 167 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_isentropic_vortex_patch_geometry()

subroutine m_start_up::s_check_isentropic_vortex_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the isentropic vortex patch have been entered by the user consistently.

Parameters
patch_idPatch identifier

Definition at line 1149 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_line_segment_patch_geometry()

subroutine m_start_up::s_check_line_segment_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the line segment patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 995 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_line_sweep_patch_geometry()

subroutine m_start_up::s_check_line_sweep_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the line sweep patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1082 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_plane_sweep_patch_geometry()

subroutine m_start_up::s_check_plane_sweep_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the plane sweep patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1424 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_rectangle_patch_geometry()

subroutine m_start_up::s_check_rectangle_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the rectangle patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1049 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_sphere_patch_geometry()

subroutine m_start_up::s_check_sphere_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the sphere patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1263 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_spherical_harmonic_patch_geometry()

subroutine m_start_up::s_check_spherical_harmonic_patch_geometry ( integer, intent(in)  patch_id)

This subroutine verifies that the geometric parameters of the spherical harmonic patch have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1294 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_supported_patch_smoothing()

subroutine m_start_up::s_check_supported_patch_smoothing ( integer, intent(in)  patch_id)

This subroutine verifies that the smoothing parameters of the given patch, which supports the smoothing out of its boundaries, have consistently been inputted by the user.

Parameters
patch_idPatch identifier

Definition at line 1602 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_check_unsupported_patch_smoothing()

subroutine m_start_up::s_check_unsupported_patch_smoothing ( integer, intent(in)  patch_id)

This subroutine verifies that the smoothing parameters of the given patch, which does not support the smoothing out of its boundaries, remain unaltered by the user inputs.

Parameters
patch_idPatch identifier

Definition at line 1638 of file m_start_up.f90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ s_finalize_start_up_module()

subroutine, public m_start_up::s_finalize_start_up_module ( )

Definition at line 2264 of file m_start_up.f90.

Here is the caller graph for this function:

◆ s_initialize_start_up_module()

subroutine, public m_start_up::s_initialize_start_up_module ( )

Definition at line 2248 of file m_start_up.f90.

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.

Definition at line 108 of file m_start_up.f90.

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 ( integer, intent(in)  dflt_int)

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.

Parameters
dflt_intDefault null integer

Definition at line 2068 of file m_start_up.f90.

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)

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_vfConservative variables

Definition at line 2176 of file m_start_up.f90.

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 ( integer, intent(in)  dflt_int)

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.

Parameters
dflt_intDefault null integer

Definition at line 1784 of file m_start_up.f90.

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)

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_vfConservative variables

Definition at line 1998 of file m_start_up.f90.

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.

Definition at line 90 of file m_start_up.f90.

◆ s_read_grid_data_files

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

Definition at line 97 of file m_start_up.f90.

◆ s_read_ic_data_files

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

Definition at line 98 of file m_start_up.f90.

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

Definition at line 93 of file m_start_up.f90.