MOM6
mom_file_parser::log_version Interface Reference

Detailed Description

Definition at line 140 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]csFile parser type
[in]modulenameName of calling module
[in]versionVersion string of module
[in]descModule description

Definition at line 1225 of file MOM_file_parser.F90.

1225  type(param_file_type), intent(in) :: cs !< File parser type
1226  character(len=*), intent(in) :: modulename !< Name of calling module
1227  character(len=*), intent(in) :: version !< Version string of module
1228  character(len=*), optional, intent(in) :: desc !< Module description
1229  ! Local variables
1230  character(len=240) :: mesg
1231 
1232  mesg = trim(modulename)//": "//trim(version)
1233  if (is_root_pe()) then
1234  if (cs%log_open) write(cs%stdlog,'(a)') trim(mesg)
1235  if (cs%log_to_stdout) write(cs%stdout,'(a)') trim(mesg)
1236  endif
1237 
1238  if (present(desc)) call doc_module(cs%doc, modulename, desc)
1239 

◆ 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]modulenameName of calling module
[in]versionVersion string of module

Definition at line 1244 of file MOM_file_parser.F90.

1244  character(len=*), intent(in) :: modulename !< Name of calling module
1245  character(len=*), intent(in) :: version !< Version string of module
1246  ! Local variables
1247  character(len=240) :: mesg
1248 
1249  mesg = trim(modulename)//": "//trim(version)
1250  if (is_root_pe()) then
1251  write(stdlog(),'(a)') trim(mesg)
1252  endif
1253 

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