PB3D  [2.45]
Ideal linear high-n MHD stability in 3-D
Functions/Subroutines
input_utilities Module Reference

Numerical utilities related to input. More...

Functions/Subroutines

logical function, public get_log (yes, ind)
 Queries for a logical value yes or no, where the default answer is also to be provided. More...
 
real(dp) function, public get_real (lim_lo, lim_hi, ind)
 Queries for user input for a real value, where allowable range can be provided as well. More...
 
integer function, public get_int (lim_lo, lim_hi, ind)
 Queries for user input for an integer value, where allowable range can be provided as well. More...
 
subroutine, public pause_prog (ind)
 Pauses the running of the program. More...
 
subroutine, public dealloc_in ()
 Cleans up input from equilibrium codes. More...
 

Detailed Description

Numerical utilities related to input.

Function/Subroutine Documentation

◆ dealloc_in()

subroutine, public input_utilities::dealloc_in

Cleans up input from equilibrium codes.

Definition at line 268 of file input_utilities.f90.

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

◆ get_int()

integer function, public input_utilities::get_int ( integer, intent(in), optional  lim_lo,
integer, intent(in), optional  lim_hi,
logical, intent(in), optional  ind 
)

Queries for user input for an integer value, where allowable range can be provided as well.

If not called by all processes at the same time, ind should be set to indicate an individual operation.

Returns
output value
Parameters
[in]lim_loupper and lower limit
[in]lim_hiupper and lower limit
[in]indindividual pause or not

Definition at line 152 of file input_utilities.f90.

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

◆ get_log()

logical function, public input_utilities::get_log ( logical  yes,
logical, intent(in), optional  ind 
)

Queries for a logical value yes or no, where the default answer is also to be provided.

If not called by all processes at the same time, ind should be set to indicate an individual operation.

Returns
output value
Parameters
yesdefault answer
[in]indindividual pause or not

Definition at line 22 of file input_utilities.f90.

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

◆ get_real()

real(dp) function, public input_utilities::get_real ( real(dp), intent(in), optional  lim_lo,
real(dp), intent(in), optional  lim_hi,
logical, intent(in), optional  ind 
)

Queries for user input for a real value, where allowable range can be provided as well.

If not called by all processes at the same time, ind should be set to indicate an individual operation.

Returns
output value
Parameters
[in]lim_loupper and lower limit
[in]lim_hiupper and lower limit
[in]indindividual pause or not

Definition at line 77 of file input_utilities.f90.

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

◆ pause_prog()

subroutine, public input_utilities::pause_prog ( logical, intent(in), optional  ind)

Pauses the running of the program.

If not called by all processes at the same time, ind should be set to indicate an individual operation.

Definition at line 226 of file input_utilities.f90.

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