f_input_file
module¶In a Fortran program it is often useful to have a high-level handling of the input
variables. The Fortran specification provides the namelist
approach, which is
relatively easy to use. However such an approach presents few drawbacks of portability
and code-intrusivity, which limit its usage in a multi-language context.
With this module we provide a set of rules to automatically parse, inspect, verify and
convert a input file from the yaml
format into a futile
dictionary.
With the usage of the f_input_file
module developers might easily
write _specifications_ for their program input file.
Such module is in tight connection with its python counterpart, futile.Inputvars
, which
employs the same conventions and make possible a full interplay between a yaml
input file and
a python dictionary.
Quick access
Needed modules
dictionaries
yaml_strings
(f_strcpy()
, operator(.eqv.)()
)f_utils
(f_zero()
)Subroutines and functions
f_input_file/
abort_excl
()¶Use : | dictionaries , yaml_output |
---|---|
Call to: | f_err_severe() |
f_input_file/
warn_illegal
()¶f_input_file/
input_file_errors
()¶Use : | dictionaries (f_err_define() ) |
---|---|
Call to: | f_err_define() |
f_input_file/
input_file_complete
(inputdef, dict[, imports[, nocheck[, verbose]]])¶Parameters: |
|
---|---|
Options: |
|
Use : |
|
Call to: |
|
f_input_file/
input_keys_set
(inputdef, userdef, dict, file, key)¶Parameters: |
|
---|---|
Use : |
|
Called from: | |
Call to: |
|
f_input_file/
input_keys_fill
(inputdef, dict, file, check, verbose)¶Parameters: |
|
---|---|
Use : |
|
Called from: | |
Call to: |
|
f_input_file/
input_keys_control
(inputdef, dict, file)¶Parameters: |
|
---|---|
Use : |
|
Called from: | |
Call to: |
|
f_input_file/
input_keys_get_profile
(dict, key, user_defined)¶Parameters: |
|
---|---|
Return: | input_keys_get_profile [character] |
Use : |
|
Called from: |
f_input_file/
input_value_is_default
(dict, key)¶Parameters: |
|
---|---|
Return: | yes [logical] |
Call to: |
f_input_file/
input_variable_dump
(dict, useronly)¶Parameters: |
|
---|---|
Use : |
|
Called from: |
f_input_file/
input_file_minimal
(inputdef, dict, minimal, nested, as_is)¶Parameters: |
|
---|---|
Use : |
|
Call to: |
|
f_input_file/
list_scalar
(list, scalar)¶Parameters: |
|
---|---|
Called from: | |
Call to: |
|
f_input_file/
input_file_dump
(dict[, useronly[, nodump_list[, msg]]])¶Parameters: | dict [dictionary,pointer] :: < Dictionary to dump |
---|---|
Options: |
|
Use : |
|
Call to: |