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 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...

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  )

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

Definition at line 1244 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
  ! 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_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 1263 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:

• /glade/work/altuntas/cesm.sandboxes/cesm2_2_alpha_X_mom/components/mom/MOM6/src/framework/MOM_file_parser.F90