MFC
Exascale flow solver
Loading...
Searching...
No Matches
m_start_up Module Reference

Reads and validates user inputs, loads existing grid/IC data, and initializes pre-process modules. More...

Data Types

interface  s_read_abstract_grid_data_files
 Abstract interface for reading grid data files in serial or parallel. More...
interface  s_read_abstract_ic_data_files
 Abstract interface for reading initial condition data files in serial or parallel. More...

Functions/Subroutines

impure 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.
impure 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.
impure 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.
impure 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.
impure subroutine, public s_read_serial_ic_data_files (q_cons_vf_in)
 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.
impure 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.
impure subroutine, public s_read_parallel_ic_data_files (q_cons_vf_in)
 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.
impure subroutine, public s_initialize_modules
 Initialize all pre-process modules, allocate data structures, and set I/O procedure pointers.
impure subroutine, public s_read_grid ()
 Read an existing grid from data files or generate a new grid from user inputs.
impure subroutine, public s_apply_initial_condition (start, finish)
 Generate or read the initial condition, apply relaxation if needed, and write output data files.
impure subroutine, public s_save_data (proc_time, time_avg, time_final, file_exists)
 Gather processor timing data and write elapsed wall-clock time to a summary file.
impure subroutine, public s_initialize_mpi_domain
 Initialize MPI, read and validate user inputs on rank 0, and decompose the computational domain.
impure subroutine, public s_finalize_modules
 Finalize all pre-process modules, deallocate resources, and shut down MPI.

Variables

character(len=path_len+name_lenproc_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
 Path to preexisting time-step folder for restart.
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

Reads and validates user inputs, loads existing grid/IC data, and initializes pre-process modules.

Function/Subroutine Documentation

◆ s_apply_initial_condition()

impure subroutine, public m_start_up::s_apply_initial_condition ( real(wp), intent(inout) start,
real(wp), intent(inout) finish )

Generate or read the initial condition, apply relaxation if needed, and write output data files.

Definition at line 848 of file m_start_up.fpp.f90.

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

◆ s_check_grid_data_files()

impure 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 551 of file m_start_up.fpp.f90.

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

◆ s_check_input_file()

impure 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 433 of file m_start_up.fpp.f90.

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

◆ s_finalize_modules()

impure subroutine, public m_start_up::s_finalize_modules

Finalize all pre-process modules, deallocate resources, and shut down MPI.

Definition at line 954 of file m_start_up.fpp.f90.

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

◆ s_initialize_modules()

impure subroutine, public m_start_up::s_initialize_modules

Initialize all pre-process modules, allocate data structures, and set I/O procedure pointers.

Definition at line 795 of file m_start_up.fpp.f90.

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

◆ s_initialize_mpi_domain()

impure subroutine, public m_start_up::s_initialize_mpi_domain

Initialize MPI, read and validate user inputs on rank 0, and decompose the computational domain.

Definition at line 933 of file m_start_up.fpp.f90.

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

◆ s_read_grid()

impure subroutine, public m_start_up::s_read_grid

Read an existing grid from data files or generate a new grid from user inputs.

Definition at line 829 of file m_start_up.fpp.f90.

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

◆ s_read_input_file()

impure 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 379 of file m_start_up.fpp.f90.

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

◆ s_read_parallel_grid_data_files()

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

Definition at line 639 of file m_start_up.fpp.f90.

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

◆ s_read_parallel_ic_data_files()

impure subroutine, public m_start_up::s_read_parallel_ic_data_files ( type(scalar_field), dimension(sys_size), intent(inout) q_cons_vf_in)

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.

Definition at line 720 of file m_start_up.fpp.f90.

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

◆ s_read_serial_grid_data_files()

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

Definition at line 461 of file m_start_up.fpp.f90.

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

◆ s_read_serial_ic_data_files()

impure subroutine, public m_start_up::s_read_serial_ic_data_files ( type(scalar_field), dimension(sys_size), intent(inout) q_cons_vf_in)

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.

Definition at line 573 of file m_start_up.fpp.f90.

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

◆ s_save_data()

impure 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 )

Gather processor timing data and write elapsed wall-clock time to a summary file.

Definition at line 897 of file m_start_up.fpp.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
private

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

Definition at line 370 of file m_start_up.fpp.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 372 of file m_start_up.fpp.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 373 of file m_start_up.fpp.f90.

◆ t_step_dir

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

Path to preexisting time-step folder for restart.

Definition at line 371 of file m_start_up.fpp.f90.