readinput Module Reference

Module for reading the input file and filling data in globals.F90. More...

Functions/Subroutines
subroutine, public	open_input_file (nl_input_path, path_to_input)
	Prepare input file for reading and display its header.
subroutine, public	close_input_file
	Close input file.
subroutine, public	read_basic (part, nwarnings, nerrors)
	Initialize basic inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.
subroutine, public	read_equil (nwarnings, nerrors)
	Initialize equil inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.
subroutine, public	read_fields (nwarnings, nerrors)
	Initialize fields inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.
subroutine, public	read_parallel (nwarnings, nerrors)
	Initialize parallel inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.
subroutine, public	read_sorting (nwarnings, nerrors)
	Initialize sorting inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.
subroutine, public	read_solver (nwarnings, nerrors)
	Initialize solver inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.
subroutine, public	read_diag (nwarnings, nerrors)
	Initialize diag inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.
subroutine, public	read_islands (nwarnings, nerrors)
	Initialize islands inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.
subroutine, public	read_diagnostics (nwarnings, nerrors)
	Initialize diagnostics inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.
subroutine, public	read_antenna (nwarnings, nerrors)
	Initialize antenna inputs, read namelist, check consistency, display, write to HDF5 and export values to antenna module.
subroutine, public	read_species (nwarnings, nerrors)
	Initialize species inputs, read namelists, check consistency, display, write to HDF5 and export values to globals.
subroutine, public	read_collisions (nwarnings, nerrors)
subroutine	check_namelist_read (status, in_unit, namelist_name)
character(len=128) function	create_input_group (group_name)
	Return group path and create HDF5 group if needed.
subroutine	warning (msg, counter)
	Print warning message and increment counter (if present).
subroutine	error (msg, counter)
	Print error message and increment counter (if present).
subroutine	error_or_warning_override (error_mesg, override, nwarnings, nerrors)
	Raise an error unless the user thinks they know better.

Detailed Description

Module for reading the input file and filling data in globals.F90.

Function/Subroutine Documentation

check_namelist_read()

subroutine readinput::check_namelist_read ( integer, intent(in) status, integer, intent(in) in_unit, character(len=*), intent(in) namelist_name )

private

Here is the call graph for this function:

Here is the caller graph for this function:

close_input_file()

subroutine, public readinput::close_input_file

Close input file.

Here is the caller graph for this function:

create_input_group()

character(len=128) function readinput::create_input_group ( character(len=*), intent(in) group_name )

private

Return group path and create HDF5 group if needed.

Author

N. Ohana

Date

09/2017

Parameters

[in]

group_name

HDF5 group name

Returns

HDF5 group path

Here is the caller graph for this function:

error()

subroutine readinput::error ( character(len=*), intent(in) msg, integer, intent(inout), optional counter )

private

Print error message and increment counter (if present).

Author

N. Ohana

Date

09/2017

Parameters

[in]

msg

Displayed message

Here is the caller graph for this function:

error_or_warning_override()

subroutine readinput::error_or_warning_override ( character(len=*), intent(in) error_mesg, logical, intent(in) override, integer, intent(inout) nwarnings, integer, intent(inout) nerrors )

private

Raise an error unless the user thinks they know better.

Author

T. Hayward-Schneider @data 02/2025

Here is the call graph for this function:

Here is the caller graph for this function:

open_input_file()

subroutine, public readinput::open_input_file	(	logical, intent(in)	nl_input_path,
		character(len=*), intent(in)	path_to_input )

Prepare input file for reading and display its header.

Author

Emmanuel Lanti

Date

09/2017

The routine will first look for an input file given in argument. If it is the case, it will copy it in the simulation folder under the name given by input_filname. It it is not the case, it will look for a file called input_filename in the simulation folder and abort the run if it is not present. In all cases, the routine will open the input file for future reading.

Parameters

[in]	nl_input_path	If an input path is given in argument
[in]	path_to_input	Path to input

Here is the call graph for this function:

Here is the caller graph for this function:

read_antenna()

subroutine, public readinput::read_antenna	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize antenna inputs, read namelist, check consistency, display, write to HDF5 and export values to antenna module.

Author

N. Ohana

Date

07/2018

Here is the call graph for this function:

Here is the caller graph for this function:

read_basic()

subroutine, public readinput::read_basic	(	integer, intent(in)	part,
		integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize basic inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.

Note

This routine is split in 2 parts in order for control to open the HDF5 file in between.

Author

N. Ohana

Date

09/2017

Parameters

[in]

part

1 = initialize inputs, read namelist and check consistency 2 = display, write to HDF5 and export values to globals

Here is the call graph for this function:

Here is the caller graph for this function:

read_collisions()

subroutine, public readinput::read_collisions	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Here is the call graph for this function:

Here is the caller graph for this function:

read_diag()

subroutine, public readinput::read_diag	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize diag inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.

Author

N. Ohana

Date

09/2017

Here is the call graph for this function:

Here is the caller graph for this function:

read_diagnostics()

subroutine, public readinput::read_diagnostics	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize diagnostics inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.

Author

N. Ohana

Date

09/2017

Here is the call graph for this function:

Here is the caller graph for this function:

read_equil()

subroutine, public readinput::read_equil	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize equil inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.

Author

N. Ohana

Date

09/2017

Here is the call graph for this function:

Here is the caller graph for this function:

read_fields()

subroutine, public readinput::read_fields	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize fields inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.

Author

N. Ohana

Date

09/2017

Here is the call graph for this function:

Here is the caller graph for this function:

read_islands()

subroutine, public readinput::read_islands	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize islands inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.

Author

N. Ohana

Date

09/2017

Here is the call graph for this function:

Here is the caller graph for this function:

read_parallel()

subroutine, public readinput::read_parallel	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize parallel inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.

Author

N. Ohana

Date

09/2017

Here is the call graph for this function:

Here is the caller graph for this function:

read_solver()

subroutine, public readinput::read_solver	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize solver inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.

Author

N. Ohana

Date

09/2017

Here is the call graph for this function:

Here is the caller graph for this function:

read_sorting()

subroutine, public readinput::read_sorting	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize sorting inputs, read namelist, check consistency, display, write to HDF5 and export values to globals.

Author

N. Ohana

Date

09/2017

Here is the call graph for this function:

Here is the caller graph for this function:

read_species()

subroutine, public readinput::read_species	(	integer, intent(inout)	nwarnings,
		integer, intent(inout)	nerrors )

Initialize species inputs, read namelists, check consistency, display, write to HDF5 and export values to globals.

Author

N. Ohana

Date

09/2017

Here is the call graph for this function:

Here is the caller graph for this function:

warning()

subroutine readinput::warning ( character(len=*), intent(in) msg, integer, intent(inout), optional counter )

private

Print warning message and increment counter (if present).

Author

N. Ohana

Date

09/2017

Parameters

[in]	msg	Displayed message
[in,out]	counter	Warning counter

Here is the caller graph for this function: