MOM6
Private functions | List of all members
mom_file_parser::get_param Interface Reference

Detailed Description

Definition at line 135 of file MOM_file_parser.F90.

Private functions

subroutine get_param_int (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value, layoutParam)
 
subroutine get_param_real (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value)
 
subroutine get_param_logical (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value, layoutParam)
 
subroutine get_param_char (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value, layoutParam)
 
subroutine get_param_char_array (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value)
 
subroutine get_param_time (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, timeunit, static_value, layoutParam, log_as_date)
 
subroutine get_param_int_array (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value, layoutParam)
 
subroutine get_param_real_array (CS, modulename, varname, value, desc, units, default, fail_if_missing, do_not_read, do_not_log, static_value)
 

Functions and subroutines

◆ get_param_char()

subroutine mom_file_parser::get_param::get_param_char ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
character(len=*), intent(inout)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
character(len=*), intent(in), optional  default,
logical, intent(in), optional  fail_if_missing,
logical, intent(in), optional  do_not_read,
logical, intent(in), optional  do_not_log,
character(len=*), intent(in), optional  static_value,
logical, intent(in), optional  layoutParam 
)
private

Definition at line 1657 of file MOM_file_parser.F90.

1657  type(param_file_type), intent(in) :: cs
1658  character(len=*), intent(in) :: modulename
1659  character(len=*), intent(in) :: varname
1660  character(len=*), intent(inout) :: value
1661  character(len=*), optional, intent(in) :: desc, units
1662  character(len=*), optional, intent(in) :: default, static_value
1663  logical, optional, intent(in) :: fail_if_missing
1664  logical, optional, intent(in) :: do_not_read, do_not_log
1665  logical, optional, intent(in) :: layoutparam
1666 ! This subroutine writes the value of a real parameter to a log file,
1667 ! along with its name and the module it came from.
1668  logical :: do_read, do_log
1669 
1670  do_read = .true. ; if (present(do_not_read)) do_read = .not.do_not_read
1671  do_log = .true. ; if (present(do_not_log)) do_log = .not.do_not_log
1672 
1673  if (do_read) then
1674  if (present(default)) value = default
1675  if (present(static_value)) value = static_value
1676  call read_param_char(cs, varname, value, fail_if_missing)
1677  endif
1678 
1679  if (do_log) then
1680  call log_param_char(cs, modulename, varname, value, desc, units, &
1681  default, layoutparam)
1682  endif
1683 

◆ get_param_char_array()

subroutine mom_file_parser::get_param::get_param_char_array ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
character(len=*), dimension(:), intent(inout)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
character(len=*), intent(in), optional  default,
logical, intent(in), optional  fail_if_missing,
logical, intent(in), optional  do_not_read,
logical, intent(in), optional  do_not_log,
character(len=*), intent(in), optional  static_value 
)
private

Definition at line 1688 of file MOM_file_parser.F90.

1688  type(param_file_type), intent(in) :: cs
1689  character(len=*), intent(in) :: modulename
1690  character(len=*), intent(in) :: varname
1691  character(len=*), intent(inout) :: value(:)
1692  character(len=*), optional, intent(in) :: desc, units
1693  character(len=*), optional, intent(in) :: default, static_value
1694  logical, optional, intent(in) :: fail_if_missing
1695  logical, optional, intent(in) :: do_not_read, do_not_log
1696 ! This subroutine writes the value of a real parameter to a log file,
1697 ! along with its name and the module it came from.
1698  logical :: do_read, do_log
1699  integer :: i, len_tot, len_val
1700  character(len=240) :: cat_val
1701 
1702  do_read = .true. ; if (present(do_not_read)) do_read = .not.do_not_read
1703  do_log = .true. ; if (present(do_not_log)) do_log = .not.do_not_log
1704 
1705  if (do_read) then
1706  if (present(default)) then ; value(:) = default ; endif
1707  if (present(static_value)) then ; value(:) = static_value ; endif
1708  call read_param_char_array(cs, varname, value, fail_if_missing)
1709  endif
1710 
1711  if (do_log) then
1712  cat_val = trim(value(1)); len_tot = len_trim(value(1))
1713  do i=2,size(value)
1714  len_val = len_trim(value(i))
1715  if ((len_val > 0) .and. (len_tot + len_val + 2 < 240)) then
1716  cat_val = trim(cat_val)//achar(34)// ", "//achar(34)//trim(value(i))
1717  len_tot = len_tot + len_val
1718  endif
1719  enddo
1720  call log_param_char(cs, modulename, varname, cat_val, desc, &
1721  units, default)
1722  endif
1723 

◆ get_param_int()

subroutine mom_file_parser::get_param::get_param_int ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
integer, intent(inout)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
integer, intent(in), optional  default,
logical, intent(in), optional  fail_if_missing,
logical, intent(in), optional  do_not_read,
logical, intent(in), optional  do_not_log,
integer, intent(in), optional  static_value,
logical, intent(in), optional  layoutParam 
)
private

Definition at line 1533 of file MOM_file_parser.F90.

1533  type(param_file_type), intent(in) :: cs
1534  character(len=*), intent(in) :: modulename
1535  character(len=*), intent(in) :: varname
1536  integer, intent(inout) :: value
1537  character(len=*), optional, intent(in) :: desc, units
1538  integer, optional, intent(in) :: default, static_value
1539  logical, optional, intent(in) :: fail_if_missing
1540  logical, optional, intent(in) :: do_not_read, do_not_log
1541  logical, optional, intent(in) :: layoutparam
1542 ! This subroutine writes the value of a real parameter to a log file,
1543 ! along with its name and the module it came from.
1544  logical :: do_read, do_log
1545 
1546  do_read = .true. ; if (present(do_not_read)) do_read = .not.do_not_read
1547  do_log = .true. ; if (present(do_not_log)) do_log = .not.do_not_log
1548 
1549  if (do_read) then
1550  if (present(default)) value = default
1551  if (present(static_value)) value = static_value
1552  call read_param_int(cs, varname, value, fail_if_missing)
1553  endif
1554 
1555  if (do_log) then
1556  call log_param_int(cs, modulename, varname, value, desc, units, &
1557  default, layoutparam)
1558  endif
1559 

◆ get_param_int_array()

subroutine mom_file_parser::get_param::get_param_int_array ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
integer, dimension(:), intent(inout)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
integer, intent(in), optional  default,
logical, intent(in), optional  fail_if_missing,
logical, intent(in), optional  do_not_read,
logical, intent(in), optional  do_not_log,
integer, intent(in), optional  static_value,
logical, intent(in), optional  layoutParam 
)
private

Definition at line 1565 of file MOM_file_parser.F90.

1565  type(param_file_type), intent(in) :: cs
1566  character(len=*), intent(in) :: modulename
1567  character(len=*), intent(in) :: varname
1568  integer, intent(inout) :: value(:)
1569  character(len=*), optional, intent(in) :: desc, units
1570  integer, optional, intent(in) :: default, static_value
1571  logical, optional, intent(in) :: fail_if_missing
1572  logical, optional, intent(in) :: do_not_read, do_not_log
1573  logical, optional, intent(in) :: layoutparam
1574 ! This subroutine writes the value of a real parameter to a log file,
1575 ! along with its name and the module it came from.
1576  logical :: do_read, do_log
1577 
1578  do_read = .true. ; if (present(do_not_read)) do_read = .not.do_not_read
1579  do_log = .true. ; if (present(do_not_log)) do_log = .not.do_not_log
1580 
1581  if (do_read) then
1582  if (present(default)) then ; value(:) = default ; endif
1583  if (present(static_value)) then ; value(:) = static_value ; endif
1584  call read_param_int_array(cs, varname, value, fail_if_missing)
1585  endif
1586 
1587  if (do_log) then
1588  call log_param_int_array(cs, modulename, varname, value, desc, &
1589  units, default, layoutparam)
1590  endif
1591 

◆ get_param_logical()

subroutine mom_file_parser::get_param::get_param_logical ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
logical, intent(inout)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
logical, intent(in), optional  default,
logical, intent(in), optional  fail_if_missing,
logical, intent(in), optional  do_not_read,
logical, intent(in), optional  do_not_log,
logical, intent(in), optional  static_value,
logical, intent(in), optional  layoutParam 
)
private

Definition at line 1729 of file MOM_file_parser.F90.

1729  type(param_file_type), intent(in) :: cs
1730  character(len=*), intent(in) :: modulename
1731  character(len=*), intent(in) :: varname
1732  logical, intent(inout) :: value
1733  character(len=*), optional, intent(in) :: desc, units
1734  logical, optional, intent(in) :: default, static_value
1735  logical, optional, intent(in) :: fail_if_missing
1736  logical, optional, intent(in) :: do_not_read, do_not_log
1737  logical, optional, intent(in) :: layoutparam
1738 ! This subroutine writes the value of a real parameter to a log file,
1739 ! along with its name and the module it came from.
1740  logical :: do_read, do_log
1741 
1742  do_read = .true. ; if (present(do_not_read)) do_read = .not.do_not_read
1743  do_log = .true. ; if (present(do_not_log)) do_log = .not.do_not_log
1744 
1745  if (do_read) then
1746  if (present(default)) value = default
1747  if (present(static_value)) value = static_value
1748  call read_param_logical(cs, varname, value, fail_if_missing)
1749  endif
1750 
1751  if (do_log) then
1752  call log_param_logical(cs, modulename, varname, value, desc, &
1753  units, default, layoutparam)
1754  endif
1755 

◆ get_param_real()

subroutine mom_file_parser::get_param::get_param_real ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
real, intent(inout)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
real, intent(in), optional  default,
logical, intent(in), optional  fail_if_missing,
logical, intent(in), optional  do_not_read,
logical, intent(in), optional  do_not_log,
real, intent(in), optional  static_value 
)
private

Definition at line 1596 of file MOM_file_parser.F90.

1596  type(param_file_type), intent(in) :: cs
1597  character(len=*), intent(in) :: modulename
1598  character(len=*), intent(in) :: varname
1599  real, intent(inout) :: value
1600  character(len=*), optional, intent(in) :: desc, units
1601  real, optional, intent(in) :: default, static_value
1602  logical, optional, intent(in) :: fail_if_missing
1603  logical, optional, intent(in) :: do_not_read, do_not_log
1604 ! This subroutine writes the value of a real parameter to a log file,
1605 ! along with its name and the module it came from.
1606  logical :: do_read, do_log
1607 
1608  do_read = .true. ; if (present(do_not_read)) do_read = .not.do_not_read
1609  do_log = .true. ; if (present(do_not_log)) do_log = .not.do_not_log
1610 
1611  if (do_read) then
1612  if (present(default)) value = default
1613  if (present(static_value)) value = static_value
1614  call read_param_real(cs, varname, value, fail_if_missing)
1615  endif
1616 
1617  if (do_log) then
1618  call log_param_real(cs, modulename, varname, value, desc, units, &
1619  default)
1620  endif
1621 

◆ get_param_real_array()

subroutine mom_file_parser::get_param::get_param_real_array ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
real, dimension(:), intent(inout)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
real, intent(in), optional  default,
logical, intent(in), optional  fail_if_missing,
logical, intent(in), optional  do_not_read,
logical, intent(in), optional  do_not_log,
real, intent(in), optional  static_value 
)
private

Definition at line 1626 of file MOM_file_parser.F90.

1626  type(param_file_type), intent(in) :: cs
1627  character(len=*), intent(in) :: modulename
1628  character(len=*), intent(in) :: varname
1629  real, intent(inout) :: value(:)
1630  character(len=*), optional, intent(in) :: desc, units
1631  real, optional, intent(in) :: default, static_value
1632  logical, optional, intent(in) :: fail_if_missing
1633  logical, optional, intent(in) :: do_not_read, do_not_log
1634 ! This subroutine writes the value of a real parameter to a log file,
1635 ! along with its name and the module it came from.
1636  logical :: do_read, do_log
1637 
1638  do_read = .true. ; if (present(do_not_read)) do_read = .not.do_not_read
1639  do_log = .true. ; if (present(do_not_log)) do_log = .not.do_not_log
1640 
1641  if (do_read) then
1642  if (present(default)) then ; value(:) = default ; endif
1643  if (present(static_value)) then ; value(:) = static_value ; endif
1644  call read_param_real_array(cs, varname, value, fail_if_missing)
1645  endif
1646 
1647  if (do_log) then
1648  call log_param_real_array(cs, modulename, varname, value, desc, &
1649  units, default)
1650  endif
1651 

◆ get_param_time()

subroutine mom_file_parser::get_param::get_param_time ( type(param_file_type), intent(in)  CS,
character(len=*), intent(in)  modulename,
character(len=*), intent(in)  varname,
type(time_type), intent(inout)  value,
character(len=*), intent(in), optional  desc,
character(len=*), intent(in), optional  units,
type(time_type), intent(in), optional  default,
logical, intent(in), optional  fail_if_missing,
logical, intent(in), optional  do_not_read,
logical, intent(in), optional  do_not_log,
real, intent(in), optional  timeunit,
type(time_type), intent(in), optional  static_value,
logical, intent(in), optional  layoutParam,
logical, intent(in), optional  log_as_date 
)
private

Definition at line 1761 of file MOM_file_parser.F90.

1761  type(param_file_type), intent(in) :: cs
1762  character(len=*), intent(in) :: modulename
1763  character(len=*), intent(in) :: varname
1764  type(time_type), intent(inout) :: value
1765  character(len=*), optional, intent(in) :: desc, units
1766  type(time_type), optional, intent(in) :: default, static_value
1767  logical, optional, intent(in) :: fail_if_missing
1768  logical, optional, intent(in) :: do_not_read, do_not_log
1769  real, optional, intent(in) :: timeunit
1770  logical, optional, intent(in) :: layoutparam
1771  logical, optional, intent(in) :: log_as_date
1772 ! This subroutine writes the value of a real parameter to a log file,
1773 ! along with its name and the module it came from.
1774  logical :: do_read, do_log, date_format, log_date
1775 
1776  do_read = .true. ; if (present(do_not_read)) do_read = .not.do_not_read
1777  do_log = .true. ; if (present(do_not_log)) do_log = .not.do_not_log
1778  log_date = .false.
1779 
1780  if (do_read) then
1781  if (present(default)) value = default
1782  if (present(static_value)) value = static_value
1783  call read_param_time(cs, varname, value, timeunit, fail_if_missing, date_format=log_date)
1784  endif
1785 
1786  if (do_log) then
1787  if (present(log_as_date)) log_date = log_as_date
1788  call log_param_time(cs, modulename, varname, value, desc, units, default, &
1789  timeunit, layoutparam=layoutparam, log_date=log_date)
1790  endif
1791 
The documentation for this interface was generated from the following file: