ORB5  v4.9.4
control_all Module Reference

Functions/Subroutines

subroutine, public control
 
subroutine initialize_all_modules (datn)
 
subroutine date (str)
 Print the run date. More...
 
subroutine print_run_label
 Label the run with the git commit hash and modified files since last commit. More...
 
subroutine annular_label
 
subroutine run_file_check (datn)
 Check if mystop and datn exist else create. More...
 
subroutine create_data_directory
 Create data directory for the checkpoints. More...
 
subroutine write_checkpoint
 Write files necessary for checkpoint. More...
 
subroutine summarize_run
 
subroutine create_hdf5_file
 Create the result file. More...
 
subroutine create_parallel_hdf5_file
 Create the parallel result file (across subdomains) More...
 
subroutine create_hdf5_testpart_file
 Create the trajectory file. More...
 
subroutine open_hdf5_file
 
subroutine open_parallel_hdf5_file
 
subroutine open_hdf5_testpart_file
 
subroutine close_hdf5_files
 
subroutine copy_hdf5_to_main_directory (datn)
 Copy {orb5_res{,_parallel},matrix}.h5 file from dat{0,1} to main directory to avoid problems in case of crash. More...
 
subroutine initialize_run_counter
 Create run counter. More...
 
subroutine increment_run_counter
 Increment run counter. More...
 
subroutine broadcast_file_related_variables (datn)
 Broadcast a couple variables computed by master. More...
 
subroutine store_species_info
 Store information about species. More...
 
subroutine store_input_file
 Store the input file in the current directory in the result file. More...
 
subroutine store_commit_hash
 Store the Git commit hash, modified files and. More...
 
subroutine, public check_mpi_types
 
subroutine, public parse_program_arguments (nl_input_path, input_path)
 Parse program arguments to extract options input file name Arguments beginning with "--" are treated as options, and the rest is treated as input file name. More...
 
subroutine restart_end_time
 

Function/Subroutine Documentation

◆ annular_label()

subroutine control_all::annular_label
private
+ Here is the caller graph for this function:

◆ broadcast_file_related_variables()

subroutine control_all::broadcast_file_related_variables ( integer, intent(inout)  datn)

Broadcast a couple variables computed by master.

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

◆ check_mpi_types()

subroutine, public control_all::check_mpi_types
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ close_hdf5_files()

subroutine control_all::close_hdf5_files
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ control()

subroutine, public control_all::control
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ copy_hdf5_to_main_directory()

subroutine control_all::copy_hdf5_to_main_directory ( integer, intent(in)  datn)

Copy {orb5_res{,_parallel},matrix}.h5 file from dat{0,1} to main directory to avoid problems in case of crash.

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

◆ create_data_directory()

subroutine control_all::create_data_directory
private

Create data directory for the checkpoints.

Author
Emmanuel Lanti
Date
05/2017
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ create_hdf5_file()

subroutine control_all::create_hdf5_file
private

Create the result file.

+ Here is the caller graph for this function:

◆ create_hdf5_testpart_file()

subroutine control_all::create_hdf5_testpart_file

Create the trajectory file.

+ Here is the caller graph for this function:

◆ create_parallel_hdf5_file()

subroutine control_all::create_parallel_hdf5_file

Create the parallel result file (across subdomains)

+ Here is the caller graph for this function:

◆ date()

subroutine control_all::date ( character(len=*), intent(in)  str)

Print the run date.

Parameters
[in]strString to be printed before the date
+ Here is the caller graph for this function:

◆ increment_run_counter()

subroutine control_all::increment_run_counter

Increment run counter.

+ Here is the caller graph for this function:

◆ initialize_all_modules()

subroutine control_all::initialize_all_modules ( integer, intent(in)  datn)
Todo:
decide where best to place - can it be moved to part.F90 area? ALS
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initialize_run_counter()

subroutine control_all::initialize_run_counter

Create run counter.

+ Here is the caller graph for this function:

◆ open_hdf5_file()

subroutine control_all::open_hdf5_file
+ Here is the caller graph for this function:

◆ open_hdf5_testpart_file()

subroutine control_all::open_hdf5_testpart_file
+ Here is the caller graph for this function:

◆ open_parallel_hdf5_file()

subroutine control_all::open_parallel_hdf5_file
+ Here is the caller graph for this function:

◆ parse_program_arguments()

subroutine, public control_all::parse_program_arguments ( logical, intent(inout)  nl_input_path,
character(len=*), intent(inout)  input_path 
)

Parse program arguments to extract options input file name Arguments beginning with "--" are treated as options, and the rest is treated as input file name.

Author
N. Ohana, E. Lanti
Date
09/2017
Parameters
[in,out]nl_input_pathIf an input path is given in argument
[in,out]input_pathPath to input
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ print_run_label()

subroutine control_all::print_run_label
private

Label the run with the git commit hash and modified files since last commit.

+ Here is the caller graph for this function:

◆ restart_end_time()

subroutine control_all::restart_end_time
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ run_file_check()

subroutine control_all::run_file_check ( integer, intent(out)  datn)
private

Check if mystop and datn exist else create.

+ Here is the caller graph for this function:

◆ store_commit_hash()

subroutine control_all::store_commit_hash

Store the Git commit hash, modified files and.

Author
Emmanuel Lanti (based on A. Bottino's work)
Date
02/17
+ Here is the caller graph for this function:

◆ store_input_file()

subroutine control_all::store_input_file

Store the input file in the current directory in the result file.

Author
Emmanuel Lanti
Date
02/17
+ Here is the caller graph for this function:

◆ store_species_info()

subroutine control_all::store_species_info
private

Store information about species.

Author
Emmanuel Lanti
Date
11/17
Note
We suppose that the species won't change name during the simulation
+ Here is the caller graph for this function:

◆ summarize_run()

subroutine control_all::summarize_run
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ write_checkpoint()

subroutine control_all::write_checkpoint

Write files necessary for checkpoint.

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