MOM6
mom_file_parser::param_file_type Type Reference

Detailed Description

A structure that can be parsed to read and document run-time parameters.

Definition at line 54 of file MOM_file_parser.F90.

Collaboration diagram for mom_file_parser::param_file_type:
[legend]

Public variables and constants

integer nfiles = 0
 The number of open files. More...
 
integer, dimension(max_param_filesiounit
 The unit numbers of open files. More...
 
character(len=filename_length), dimension(max_param_filesfilename
 The names of the open files. More...
 
logical, dimension(max_param_filesnetcdf_file
 If true, the input file is in NetCDF. More...
 
type(file_data_type), dimension(max_param_filesparam_data
 Structures that contain the valid data lines from the parameter files, enabling all subsequent reads of parameter data to occur internally. More...
 
logical report_unused = report_unused_default
 If true, report any parameter lines that are not used in the run. More...
 
logical unused_params_fatal = unused_params_fatal_default
 If true, kill the run if there are any unused parameters. More...
 
logical log_to_stdout = log_to_stdout_default
 If true, all log messages are also sent to stdout. More...
 
logical log_open = .false.
 True if the log file has been opened. More...
 
integer stdout
 The unit number from stdout(). More...
 
integer stdlog
 The unit number from stdlog(). More...
 
character(len=240) doc_file
 A file where all run-time parameters, their settings and defaults are documented. More...
 
logical complete_doc = complete_doc_default
 If true, document all run-time parameters. More...
 
logical minimal_doc = minimal_doc_default
 If true, document only those run-time parameters that differ from defaults. More...
 
type(doc_type), pointer doc => NULL()
 A structure that contains information related to parameter documentation. More...
 
type(link_parameter), pointer chain => NULL()
 Facilitates linked list. More...
 
type(parameter_block), pointer blockname => NULL()
 Name of active parameter block. More...
 

Variables and constants

◆ blockname

type(parameter_block), pointer mom_file_parser::param_file_type::blockname => NULL()

Name of active parameter block.

Definition at line 82 of file MOM_file_parser.F90.

82  type(parameter_block), pointer :: blockName => null() !< Name of active parameter block

◆ chain

type(link_parameter), pointer mom_file_parser::param_file_type::chain => NULL()

Facilitates linked list.

Definition at line 81 of file MOM_file_parser.F90.

81  type(link_parameter), pointer :: chain => null() !< Facilitates linked list

◆ complete_doc

logical mom_file_parser::param_file_type::complete_doc = complete_doc_default

If true, document all run-time parameters.

Definition at line 75 of file MOM_file_parser.F90.

75  logical :: complete_doc = complete_doc_default !< If true, document all

◆ doc

type(doc_type), pointer mom_file_parser::param_file_type::doc => NULL()

A structure that contains information related to parameter documentation.

Definition at line 79 of file MOM_file_parser.F90.

79  type(doc_type), pointer :: doc => null() !< A structure that contains information

◆ doc_file

character(len=240) mom_file_parser::param_file_type::doc_file

A file where all run-time parameters, their settings and defaults are documented.

Definition at line 73 of file MOM_file_parser.F90.

73  character(len=240) :: doc_file !< A file where all run-time parameters, their

◆ filename

character(len=filename_length), dimension(max_param_files) mom_file_parser::param_file_type::filename

The names of the open files.

Definition at line 57 of file MOM_file_parser.F90.

57  character(len=FILENAME_LENGTH) :: filename(MAX_PARAM_FILES) !< The names of the open files.

◆ iounit

integer, dimension(max_param_files) mom_file_parser::param_file_type::iounit

The unit numbers of open files.

Definition at line 56 of file MOM_file_parser.F90.

56  integer :: iounit(MAX_PARAM_FILES) !< The unit numbers of open files.

◆ log_open

logical mom_file_parser::param_file_type::log_open = .false.

True if the log file has been opened.

Definition at line 70 of file MOM_file_parser.F90.

70  logical :: log_open = .false. !< True if the log file has been opened.

◆ log_to_stdout

logical mom_file_parser::param_file_type::log_to_stdout = log_to_stdout_default

If true, all log messages are also sent to stdout.

Definition at line 68 of file MOM_file_parser.F90.

68  logical :: log_to_stdout = log_to_stdout_default !< If true, all log

◆ minimal_doc

logical mom_file_parser::param_file_type::minimal_doc = minimal_doc_default

If true, document only those run-time parameters that differ from defaults.

Definition at line 77 of file MOM_file_parser.F90.

77  logical :: minimal_doc = minimal_doc_default !< If true, document only those

◆ netcdf_file

logical, dimension(max_param_files) mom_file_parser::param_file_type::netcdf_file

If true, the input file is in NetCDF.

Definition at line 58 of file MOM_file_parser.F90.

58  logical :: NetCDF_file(MAX_PARAM_FILES) !< If true, the input file is in NetCDF.

◆ nfiles

integer mom_file_parser::param_file_type::nfiles = 0

The number of open files.

Definition at line 55 of file MOM_file_parser.F90.

55  integer :: nfiles = 0 !< The number of open files.

◆ param_data

type(file_data_type), dimension(max_param_files) mom_file_parser::param_file_type::param_data

Structures that contain the valid data lines from the parameter files, enabling all subsequent reads of parameter data to occur internally.

Definition at line 60 of file MOM_file_parser.F90.

60  type(file_data_type) :: param_data(MAX_PARAM_FILES) !< Structures that contain

◆ report_unused

logical mom_file_parser::param_file_type::report_unused = report_unused_default

If true, report any parameter lines that are not used in the run.

Definition at line 64 of file MOM_file_parser.F90.

64  logical :: report_unused = report_unused_default !< If true, report any

◆ stdlog

integer mom_file_parser::param_file_type::stdlog

The unit number from stdlog().

Definition at line 72 of file MOM_file_parser.F90.

72  integer :: stdlog !< The unit number from stdlog().

◆ stdout

integer mom_file_parser::param_file_type::stdout

The unit number from stdout().

Definition at line 71 of file MOM_file_parser.F90.

71  integer :: stdout !< The unit number from stdout().

◆ unused_params_fatal

logical mom_file_parser::param_file_type::unused_params_fatal = unused_params_fatal_default

If true, kill the run if there are any unused parameters.

Definition at line 66 of file MOM_file_parser.F90.

66  logical :: unused_params_fatal = unused_params_fatal_default !< If true, kill

The documentation for this type was generated from the following file: