mom_file_parser::log_version Interface Reference

Detailed Description

An overloaded interface to log version information about modules.

Definition at line 109 of file MOM_file_parser.F90.

Private functions
subroutine	log_version_cs (CS, modulename, version, desc, log_to_all, all_default, layout, debugging)
	Log the version of a module to a log file and/or stdout, and/or to the parameter documentation file. More...
subroutine	log_version_plain (modulename, version)
	Log the version of a module to a log file and/or stdout. More...

Detailed Description

An overloaded interface to log version information about modules.

Definition at line 109 of file MOM_file_parser.F90.

Functions and subroutines

log_version_cs()

subroutine mom_file_parser::log_version::log_version_cs ( type(param_file_type), intent(in)  CS, character(len=*), intent(in)  modulename, character(len=*), intent(in)  version, character(len=*), intent(in), optional  desc, logical, intent(in), optional  log_to_all, logical, intent(in), optional  all_default, logical, intent(in), optional  layout, logical, intent(in), optional  debugging  )

private

Log the version of a module to a log file and/or stdout, and/or to the parameter documentation file.

Parameters

[in]	cs	File parser type
[in]	modulename	Name of calling module
[in]	version	Version string of module
[in]	desc	Module description
[in]	log_to_all	If present and true, log this parameter to the ..._doc.all files, even if this module also has layout or debugging parameters.
[in]	all_default	If true, all parameters take their default values.
[in]	layout	If present and true, this module has layout parameters.
[in]	debugging	If present and true, this module has debugging parameters.

Definition at line 1253 of file MOM_file_parser.F90.

  type(param_file_type),      intent(in) :: CS         !< File parser type
  character(len=*),           intent(in) :: modulename !< Name of calling module
  character(len=*),           intent(in) :: version    !< Version string of module
  character(len=*), optional, intent(in) :: desc       !< Module description
  logical,          optional, intent(in) :: log_to_all !< If present and true, log this parameter to the
                                                       !! ..._doc.all files, even if this module also has layout
                                                       !! or debugging parameters.
  logical,          optional, intent(in) :: all_default !< If true, all parameters take their default values.
  logical,          optional, intent(in) :: layout     !< If present and true, this module has layout parameters.
  logical,          optional, intent(in) :: debugging  !< If present and true, this module has debugging parameters.
  ! Local variables
  character(len=240) :: mesg

  mesg = trim(modulename)//": "//trim(version)
  if (is_root_pe()) then
    if (cs%log_open) write(cs%stdlog,'(a)') trim(mesg)
    if (cs%log_to_stdout) write(cs%stdout,'(a)') trim(mesg)
  endif

  if (present(desc)) call doc_module(cs%doc, modulename, desc, log_to_all, all_default, layout, debugging)

log_version_plain()

subroutine mom_file_parser::log_version::log_version_plain ( character(len=*), intent(in)  modulename, character(len=*), intent(in)  version  )

private

Log the version of a module to a log file and/or stdout.

Parameters

[in]	modulename	Name of calling module
[in]	version	Version string of module

Definition at line 1278 of file MOM_file_parser.F90.

  character(len=*),           intent(in) :: modulename !< Name of calling module
  character(len=*),           intent(in) :: version    !< Version string of module
  ! Local variables
  character(len=240) :: mesg

  mesg = trim(modulename)//": "//trim(version)
  if (is_root_pe()) then
    write(stdlog(),'(a)') trim(mesg)
  endif

---

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

• /home/cermak/src/MOM6.devrob/src/framework/MOM_file_parser.F90