MOM6
mom_file_parser::log_param Interface Reference

Detailed Description

An overloaded interface to log the values of various types of parameters.

Definition at line 96 of file MOM_file_parser.F90.

Private functions

subroutine log_param_int (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam, like_default)
 Log the name and value of an integer model parameter in documentation files. More...
 
subroutine log_param_real (CS, modulename, varname, value, desc, units, default, debuggingParam, like_default)
 Log the name and value of a real model parameter in documentation files. More...
 
subroutine log_param_logical (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam, like_default)
 Log the name and value of a logical model parameter in documentation files. More...
 
subroutine log_param_char (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam, like_default)
 Log the name and value of a character string model parameter in documentation files. More...
 
subroutine log_param_time (CS, modulename, varname, value, desc, units, default, timeunit, layoutParam, debuggingParam, log_date, like_default)
 This subroutine writes the value of a time-type parameter to a log file, along with its name and the module it came from. More...
 
subroutine log_param_int_array (CS, modulename, varname, value, desc, units, default, layoutParam, debuggingParam, like_default)
 Log the name and values of an array of integer model parameter in documentation files. More...
 
subroutine log_param_real_array (CS, modulename, varname, value, desc, units, default, debuggingParam, like_default)
 Log the name and values of an array of real model parameter in documentation files. More...
 

Detailed Description

An overloaded interface to log the values of various types of parameters.

Definition at line 96 of file MOM_file_parser.F90.

Functions and subroutines

◆ log_param_char()

subroutine mom_file_parser::log_param::log_param_char ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
character(len=*), intent(in)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
character(len=*), intent(in), optional  default,
logical, intent(in), optional  layoutParam,
logical, intent(in), optional  debuggingParam,
logical, intent(in), optional  like_default 
)
private

Log the name and value of a character string model parameter in documentation files.

Parameters
[in]csThe control structure for the file_parser module, it is also a structure to parse for run-time parameters
[in]modulenameThe name of the calling module
[in]varnameThe name of the parameter to log
[in]valueThe value of the parameter to log
[in]descA description of this variable; if not present, this parameter is not written to a doc file
[in]unitsThe units of this parameter
[in]defaultThe default value of the parameter
[in]layoutparamIf present and true, this parameter is logged in the layout parameter file
[in]debuggingparamIf present and true, this parameter is logged in the debugging parameter file
[in]like_defaultIf present and true, log this parameter as though it has the default value, even if there is no default.

Definition at line 1470 of file MOM_file_parser.F90.

1470  type(param_file_type), intent(in) :: CS !< The control structure for the file_parser module,
1471  !! it is also a structure to parse for run-time parameters
1472  character(len=*), intent(in) :: modulename !< The name of the calling module
1473  character(len=*), intent(in) :: varname !< The name of the parameter to log
1474  character(len=*), intent(in) :: value !< The value of the parameter to log
1475  character(len=*), optional, intent(in) :: desc !< A description of this variable; if not
1476  !! present, this parameter is not written to a doc file
1477  character(len=*), optional, intent(in) :: units !< The units of this parameter
1478  character(len=*), optional, intent(in) :: default !< The default value of the parameter
1479  logical, optional, intent(in) :: layoutParam !< If present and true, this parameter is
1480  !! logged in the layout parameter file
1481  logical, optional, intent(in) :: debuggingParam !< If present and true, this parameter is
1482  !! logged in the debugging parameter file
1483  logical, optional, intent(in) :: like_default !< If present and true, log this parameter as
1484  !! though it has the default value, even if there is no default.
1485 
1486  character(len=1024) :: mesg, myunits
1487 
1488  write(mesg, '(" ",a," ",a,": ",a)') &
1489  trim(modulename), trim(varname), trim(value)
1490  if (is_root_pe()) then
1491  if (cs%log_open) write(cs%stdlog,'(a)') trim(mesg)
1492  if (cs%log_to_stdout) write(cs%stdout,'(a)') trim(mesg)
1493  endif
1494 
1495  myunits=" "; if (present(units)) write(myunits(1:1024),'(A)') trim(units)
1496  if (present(desc)) &
1497  call doc_param(cs%doc, varname, desc, myunits, value, default, &
1498  layoutparam=layoutparam, debuggingparam=debuggingparam, like_default=like_default)
1499 

◆ log_param_int()

subroutine mom_file_parser::log_param::log_param_int ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
integer, intent(in)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
integer, intent(in), optional  default,
logical, intent(in), optional  layoutParam,
logical, intent(in), optional  debuggingParam,
logical, intent(in), optional  like_default 
)
private

Log the name and value of an integer model parameter in documentation files.

Parameters
[in]csThe control structure for the file_parser module, it is also a structure to parse for run-time parameters
[in]modulenameThe name of the module using this parameter
[in]varnameThe name of the parameter to log
[in]valueThe value of the parameter to log
[in]descA description of this variable; if not present, this parameter is not written to a doc file
[in]unitsThe units of this parameter
[in]defaultThe default value of the parameter
[in]layoutparamIf present and true, this parameter is logged in the layout parameter file
[in]debuggingparamIf present and true, this parameter is logged in the debugging parameter file
[in]like_defaultIf present and true, log this parameter as though it has the default value, even if there is no default.

Definition at line 1293 of file MOM_file_parser.F90.

1293  type(param_file_type), intent(in) :: CS !< The control structure for the file_parser module,
1294  !! it is also a structure to parse for run-time parameters
1295  character(len=*), intent(in) :: modulename !< The name of the module using this parameter
1296  character(len=*), intent(in) :: varname !< The name of the parameter to log
1297  integer, intent(in) :: value !< The value of the parameter to log
1298  character(len=*), optional, intent(in) :: desc !< A description of this variable; if not
1299  !! present, this parameter is not written to a doc file
1300  character(len=*), optional, intent(in) :: units !< The units of this parameter
1301  integer, optional, intent(in) :: default !< The default value of the parameter
1302  logical, optional, intent(in) :: layoutParam !< If present and true, this parameter is
1303  !! logged in the layout parameter file
1304  logical, optional, intent(in) :: debuggingParam !< If present and true, this parameter is
1305  !! logged in the debugging parameter file
1306  logical, optional, intent(in) :: like_default !< If present and true, log this parameter as
1307  !! though it has the default value, even if there is no default.
1308 
1309  character(len=240) :: mesg, myunits
1310 
1311  write(mesg, '(" ",a," ",a,": ",a)') trim(modulename), trim(varname), trim(left_int(value))
1312  if (is_root_pe()) then
1313  if (cs%log_open) write(cs%stdlog,'(a)') trim(mesg)
1314  if (cs%log_to_stdout) write(cs%stdout,'(a)') trim(mesg)
1315  endif
1316 
1317  myunits=" "; if (present(units)) write(myunits(1:240),'(A)') trim(units)
1318  if (present(desc)) &
1319  call doc_param(cs%doc, varname, desc, myunits, value, default, &
1320  layoutparam=layoutparam, debuggingparam=debuggingparam, like_default=like_default)
1321 

◆ log_param_int_array()

subroutine mom_file_parser::log_param::log_param_int_array ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
integer, dimension(:), intent(in)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
integer, intent(in), optional  default,
logical, intent(in), optional  layoutParam,
logical, intent(in), optional  debuggingParam,
logical, intent(in), optional  like_default 
)
private

Log the name and values of an array of integer model parameter in documentation files.

Parameters
[in]csThe control structure for the file_parser module, it is also a structure to parse for run-time parameters
[in]modulenameThe name of the module using this parameter
[in]varnameThe name of the parameter to log
[in]valueThe value of the parameter to log
[in]descA description of this variable; if not present, this parameter is not written to a doc file
[in]unitsThe units of this parameter
[in]defaultThe default value of the parameter
[in]layoutparamIf present and true, this parameter is logged in the layout parameter file
[in]debuggingparamIf present and true, this parameter is logged in the debugging parameter file
[in]like_defaultIf present and true, log this parameter as though it has the default value, even if there is no default.

Definition at line 1327 of file MOM_file_parser.F90.

1327  type(param_file_type), intent(in) :: CS !< The control structure for the file_parser module,
1328  !! it is also a structure to parse for run-time parameters
1329  character(len=*), intent(in) :: modulename !< The name of the module using this parameter
1330  character(len=*), intent(in) :: varname !< The name of the parameter to log
1331  integer, dimension(:), intent(in) :: value !< The value of the parameter to log
1332  character(len=*), optional, intent(in) :: desc !< A description of this variable; if not
1333  !! present, this parameter is not written to a doc file
1334  character(len=*), optional, intent(in) :: units !< The units of this parameter
1335  integer, optional, intent(in) :: default !< The default value of the parameter
1336  logical, optional, intent(in) :: layoutParam !< If present and true, this parameter is
1337  !! logged in the layout parameter file
1338  logical, optional, intent(in) :: debuggingParam !< If present and true, this parameter is
1339  !! logged in the debugging parameter file
1340  logical, optional, intent(in) :: like_default !< If present and true, log this parameter as
1341  !! though it has the default value, even if there is no default.
1342 
1343  character(len=1320) :: mesg
1344  character(len=240) :: myunits
1345 
1346  write(mesg, '(" ",a," ",a,": ",A)') trim(modulename), trim(varname), trim(left_ints(value))
1347  if (is_root_pe()) then
1348  if (cs%log_open) write(cs%stdlog,'(a)') trim(mesg)
1349  if (cs%log_to_stdout) write(cs%stdout,'(a)') trim(mesg)
1350  endif
1351 
1352  myunits=" "; if (present(units)) write(myunits(1:240),'(A)') trim(units)
1353  if (present(desc)) &
1354  call doc_param(cs%doc, varname, desc, myunits, value, default, &
1355  layoutparam=layoutparam, debuggingparam=debuggingparam, like_default=like_default)
1356 

◆ log_param_logical()

subroutine mom_file_parser::log_param::log_param_logical ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
logical, intent(in)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
logical, intent(in), optional  default,
logical, intent(in), optional  layoutParam,
logical, intent(in), optional  debuggingParam,
logical, intent(in), optional  like_default 
)
private

Log the name and value of a logical model parameter in documentation files.

Parameters
[in]csThe control structure for the file_parser module, it is also a structure to parse for run-time parameters
[in]modulenameThe name of the calling module
[in]varnameThe name of the parameter to log
[in]valueThe value of the parameter to log
[in]descA description of this variable; if not present, this parameter is not written to a doc file
[in]unitsThe units of this parameter
[in]defaultThe default value of the parameter
[in]layoutparamIf present and true, this parameter is logged in the layout parameter file
[in]debuggingparamIf present and true, this parameter is logged in the debugging parameter file
[in]like_defaultIf present and true, log this parameter as though it has the default value, even if there is no default.

Definition at line 1432 of file MOM_file_parser.F90.

1432  type(param_file_type), intent(in) :: CS !< The control structure for the file_parser module,
1433  !! it is also a structure to parse for run-time parameters
1434  character(len=*), intent(in) :: modulename !< The name of the calling module
1435  character(len=*), intent(in) :: varname !< The name of the parameter to log
1436  logical, intent(in) :: value !< The value of the parameter to log
1437  character(len=*), optional, intent(in) :: desc !< A description of this variable; if not
1438  !! present, this parameter is not written to a doc file
1439  character(len=*), optional, intent(in) :: units !< The units of this parameter
1440  logical, optional, intent(in) :: default !< The default value of the parameter
1441  logical, optional, intent(in) :: layoutParam !< If present and true, this parameter is
1442  !! logged in the layout parameter file
1443  logical, optional, intent(in) :: debuggingParam !< If present and true, this parameter is
1444  !! logged in the debugging parameter file
1445  logical, optional, intent(in) :: like_default !< If present and true, log this parameter as
1446  !! though it has the default value, even if there is no default.
1447 
1448  character(len=240) :: mesg, myunits
1449 
1450  if (value) then
1451  write(mesg, '(" ",a," ",a,": True")') trim(modulename), trim(varname)
1452  else
1453  write(mesg, '(" ",a," ",a,": False")') trim(modulename), trim(varname)
1454  endif
1455  if (is_root_pe()) then
1456  if (cs%log_open) write(cs%stdlog,'(a)') trim(mesg)
1457  if (cs%log_to_stdout) write(cs%stdout,'(a)') trim(mesg)
1458  endif
1459 
1460  myunits="Boolean"; if (present(units)) write(myunits(1:240),'(A)') trim(units)
1461  if (present(desc)) &
1462  call doc_param(cs%doc, varname, desc, myunits, value, default, &
1463  layoutparam=layoutparam, debuggingparam=debuggingparam, like_default=like_default)
1464 

◆ log_param_real()

subroutine mom_file_parser::log_param::log_param_real ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
real, intent(in)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
real, intent(in), optional  default,
logical, intent(in), optional  debuggingParam,
logical, intent(in), optional  like_default 
)
private

Log the name and value of a real model parameter in documentation files.

Parameters
[in]csThe control structure for the file_parser module, it is also a structure to parse for run-time parameters
[in]modulenameThe name of the calling module
[in]varnameThe name of the parameter to log
[in]valueThe value of the parameter to log
[in]descA description of this variable; if not present, this parameter is not written to a doc file
[in]unitsThe units of this parameter
[in]defaultThe default value of the parameter
[in]debuggingparamIf present and true, this parameter is logged in the debugging parameter file
[in]like_defaultIf present and true, log this parameter as though it has the default value, even if there is no default.

Definition at line 1362 of file MOM_file_parser.F90.

1362  type(param_file_type), intent(in) :: CS !< The control structure for the file_parser module,
1363  !! it is also a structure to parse for run-time parameters
1364  character(len=*), intent(in) :: modulename !< The name of the calling module
1365  character(len=*), intent(in) :: varname !< The name of the parameter to log
1366  real, intent(in) :: value !< The value of the parameter to log
1367  character(len=*), optional, intent(in) :: desc !< A description of this variable; if not
1368  !! present, this parameter is not written to a doc file
1369  character(len=*), optional, intent(in) :: units !< The units of this parameter
1370  real, optional, intent(in) :: default !< The default value of the parameter
1371  logical, optional, intent(in) :: debuggingParam !< If present and true, this parameter is
1372  !! logged in the debugging parameter file
1373  logical, optional, intent(in) :: like_default !< If present and true, log this parameter as
1374  !! though it has the default value, even if there is no default.
1375 
1376  character(len=240) :: mesg, myunits
1377 
1378  write(mesg, '(" ",a," ",a,": ",a)') &
1379  trim(modulename), trim(varname), trim(left_real(value))
1380  if (is_root_pe()) then
1381  if (cs%log_open) write(cs%stdlog,'(a)') trim(mesg)
1382  if (cs%log_to_stdout) write(cs%stdout,'(a)') trim(mesg)
1383  endif
1384 
1385  myunits="not defined"; if (present(units)) write(myunits(1:240),'(A)') trim(units)
1386  if (present(desc)) &
1387  call doc_param(cs%doc, varname, desc, myunits, value, default, &
1388  debuggingparam=debuggingparam, like_default=like_default)
1389 

◆ log_param_real_array()

subroutine mom_file_parser::log_param::log_param_real_array ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
real, dimension(:), intent(in)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
real, intent(in), optional  default,
logical, intent(in), optional  debuggingParam,
logical, intent(in), optional  like_default 
)
private

Log the name and values of an array of real model parameter in documentation files.

Parameters
[in]csThe control structure for the file_parser module, it is also a structure to parse for run-time parameters
[in]modulenameThe name of the calling module
[in]varnameThe name of the parameter to log
[in]valueThe value of the parameter to log
[in]descA description of this variable; if not present, this parameter is not written to a doc file
[in]unitsThe units of this parameter
[in]defaultThe default value of the parameter
[in]debuggingparamIf present and true, this parameter is logged in the debugging parameter file
[in]like_defaultIf present and true, log this parameter as though it has the default value, even if there is no default.

Definition at line 1395 of file MOM_file_parser.F90.

1395  type(param_file_type), intent(in) :: CS !< The control structure for the file_parser module,
1396  !! it is also a structure to parse for run-time parameters
1397  character(len=*), intent(in) :: modulename !< The name of the calling module
1398  character(len=*), intent(in) :: varname !< The name of the parameter to log
1399  real, dimension(:), intent(in) :: value !< The value of the parameter to log
1400  character(len=*), optional, intent(in) :: desc !< A description of this variable; if not
1401  !! present, this parameter is not written to a doc file
1402  character(len=*), optional, intent(in) :: units !< The units of this parameter
1403  real, optional, intent(in) :: default !< The default value of the parameter
1404  logical, optional, intent(in) :: debuggingParam !< If present and true, this parameter is
1405  !! logged in the debugging parameter file
1406  logical, optional, intent(in) :: like_default !< If present and true, log this parameter as
1407  !! though it has the default value, even if there is no default.
1408 
1409  character(len=1320) :: mesg
1410  character(len=240) :: myunits
1411 
1412  !write(mesg, '(" ",a," ",a,": ",ES19.12,99(",",ES19.12))') &
1413  !write(mesg, '(" ",a," ",a,": ",G,99(",",G))') &
1414  ! trim(modulename), trim(varname), value
1415  write(mesg, '(" ",a," ",a,": ",a)') &
1416  trim(modulename), trim(varname), trim(left_reals(value))
1417  if (is_root_pe()) then
1418  if (cs%log_open) write(cs%stdlog,'(a)') trim(mesg)
1419  if (cs%log_to_stdout) write(cs%stdout,'(a)') trim(mesg)
1420  endif
1421 
1422  myunits="not defined"; if (present(units)) write(myunits(1:240),'(A)') trim(units)
1423  if (present(desc)) &
1424  call doc_param(cs%doc, varname, desc, myunits, value, default, &
1425  debuggingparam=debuggingparam, like_default=like_default)
1426 

◆ log_param_time()

subroutine mom_file_parser::log_param::log_param_time ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
type(time_type), intent(in)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
type(time_type), intent(in), optional  default,
real, intent(in), optional  timeunit,
logical, intent(in), optional  layoutParam,
logical, intent(in), optional  debuggingParam,
logical, intent(in), optional  log_date,
logical, intent(in), optional  like_default 
)
private

This subroutine writes the value of a time-type parameter to a log file, along with its name and the module it came from.

Parameters
[in]csThe control structure for the file_parser module, it is also a structure to parse for run-time parameters
[in]modulenameThe name of the calling module
[in]varnameThe name of the parameter to log
[in]valueThe value of the parameter to log
[in]descA description of this variable; if not present, this parameter is not written to a doc file
[in]unitsThe units of this parameter
[in]defaultThe default value of the parameter
[in]timeunitThe number of seconds in a time unit for real-number output.
[in]log_dateIf true, log the time_type in date format. If missing the default is false.
[in]layoutparamIf present and true, this parameter is logged in the layout parameter file
[in]debuggingparamIf present and true, this parameter is logged in the debugging parameter file
[in]like_defaultIf present and true, log this parameter as though it has the default value, even if there is no default.

Definition at line 1506 of file MOM_file_parser.F90.

1506  type(param_file_type), intent(in) :: CS !< The control structure for the file_parser module,
1507  !! it is also a structure to parse for run-time parameters
1508  character(len=*), intent(in) :: modulename !< The name of the calling module
1509  character(len=*), intent(in) :: varname !< The name of the parameter to log
1510  type(time_type), intent(in) :: value !< The value of the parameter to log
1511  character(len=*), optional, intent(in) :: desc !< A description of this variable; if not
1512  !! present, this parameter is not written to a doc file
1513  character(len=*), optional, intent(in) :: units !< The units of this parameter
1514  type(time_type), optional, intent(in) :: default !< The default value of the parameter
1515  real, optional, intent(in) :: timeunit !< The number of seconds in a time unit for
1516  !! real-number output.
1517  logical, optional, intent(in) :: log_date !< If true, log the time_type in date format.
1518  !! If missing the default is false.
1519  logical, optional, intent(in) :: layoutParam !< If present and true, this parameter is
1520  !! logged in the layout parameter file
1521  logical, optional, intent(in) :: debuggingParam !< If present and true, this parameter is
1522  !! logged in the debugging parameter file
1523  logical, optional, intent(in) :: like_default !< If present and true, log this parameter as
1524  !! though it has the default value, even if there is no default.
1525 
1526  ! Local variables
1527  real :: real_time, real_default
1528  logical :: use_timeunit, date_format
1529  character(len=240) :: mesg, myunits
1530  character(len=80) :: date_string, default_string
1531  integer :: days, secs, ticks, ticks_per_sec
1532 
1533  use_timeunit = .false.
1534  date_format = .false. ; if (present(log_date)) date_format = log_date
1535 
1536  call get_time(value, secs, days, ticks)
1537 
1538  if (ticks == 0) then
1539  write(mesg, '(" ",a," ",a," (Time): ",i0,":",i0)') trim(modulename), &
1540  trim(varname), days, secs
1541  else
1542  write(mesg, '(" ",a," ",a," (Time): ",i0,":",i0,":",i0)') trim(modulename), &
1543  trim(varname), days, secs, ticks
1544  endif
1545  if (is_root_pe()) then
1546  if (cs%log_open) write(cs%stdlog,'(a)') trim(mesg)
1547  if (cs%log_to_stdout) write(cs%stdout,'(a)') trim(mesg)
1548  endif
1549 
1550  if (present(desc)) then
1551  if (present(timeunit)) use_timeunit = (timeunit > 0.0)
1552  if (date_format) then
1553  myunits='[date]'
1554 
1555  date_string = convert_date_to_string(value)
1556  if (present(default)) then
1557  default_string = convert_date_to_string(default)
1558  call doc_param(cs%doc, varname, desc, myunits, date_string, &
1559  default=default_string, layoutparam=layoutparam, &
1560  debuggingparam=debuggingparam, like_default=like_default)
1561  else
1562  call doc_param(cs%doc, varname, desc, myunits, date_string, &
1563  layoutparam=layoutparam, debuggingparam=debuggingparam, like_default=like_default)
1564  endif
1565  elseif (use_timeunit) then
1566  if (present(units)) then
1567  write(myunits(1:240),'(A)') trim(units)
1568  else
1569  if (abs(timeunit-1.0) < 0.01) then ; myunits = "seconds"
1570  elseif (abs(timeunit-3600.0) < 1.0) then ; myunits = "hours"
1571  elseif (abs(timeunit-86400.0) < 1.0) then ; myunits = "days"
1572  elseif (abs(timeunit-3.1e7) < 1.0e6) then ; myunits = "years"
1573  else ; write(myunits,'(es8.2," sec")') timeunit ; endif
1574  endif
1575  real_time = (86400.0/timeunit)*days + secs/timeunit
1576  if (ticks > 0) real_time = real_time + &
1577  real(ticks) / (timeunit*get_ticks_per_second())
1578  if (present(default)) then
1579  call get_time(default, secs, days, ticks)
1580  real_default = (86400.0/timeunit)*days + secs/timeunit
1581  if (ticks > 0) real_default = real_default + &
1582  real(ticks) / (timeunit*get_ticks_per_second())
1583  call doc_param(cs%doc, varname, desc, myunits, real_time, real_default, like_default=like_default)
1584  else
1585  call doc_param(cs%doc, varname, desc, myunits, real_time, like_default=like_default)
1586  endif
1587  else
1588  call doc_param(cs%doc, varname, desc, value, default, units=units, like_default=like_default)
1589  endif
1590  endif
1591 

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