<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.14">
  <compounddef id="namespacemom__dyn__horgrid" kind="namespace" language="Fortran">
    <compoundname>mom_dyn_horgrid</compoundname>
    <innerclass refid="structmom__dyn__horgrid_1_1dyn__horgrid__type" prot="public">mom_dyn_horgrid::dyn_horgrid_type</innerclass>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__dyn__horgrid_1a6dd89718602439a6bca59608e0f7e9f5" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_dyn_horgrid::create_dyn_horgrid</definition>
        <argsstring>(G, HI, bathymetry_at_vel)</argsstring>
        <name>create_dyn_horgrid</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>HI</type>
          <defname>HI</defname>
        </param>
        <param>
          <type>bathymetry_at_vel</type>
          <defname>bathymetry_at_vel</defname>
        </param>
        <briefdescription>
<para>Allocate memory used by the <ref refid="structmom__dyn__horgrid_1_1dyn__horgrid__type" kindref="compound">dyn_horgrid_type</ref> and related structures. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to the dynamic horizontal grid type</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">hi</parametername>
</parameternamelist>
<parameterdescription>
<para>A hor_index_type for array extents</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">bathymetry_at_vel</parametername>
</parameternamelist>
<parameterdescription>
<para>If true, there are separate values for the basin depths at velocity points. Otherwise the effects of topography are entirely determined from thickness points. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" line="175" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" bodystart="176" bodyend="279"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__oda__driver__mod_1aaaf67b8d0e0db3ba3dfe09e24d2b8b24" compoundref="MOM__oda__driver_8F90" startline="115" endline="303">mom_oda_driver_mod::init_oda</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__dyn__horgrid_1a4c2c545c65e12084cd863f0cade973f2" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_dyn_horgrid::rescale_dyn_horgrid_bathymetry</definition>
        <argsstring>(G, m_in_new_units)</argsstring>
        <name>rescale_dyn_horgrid_bathymetry</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>m_in_new_units</type>
          <defname>m_in_new_units</defname>
        </param>
        <briefdescription>
<para>rescale_dyn_horgrid_bathymetry permits a change in the internal units for the bathymetry on the grid, both rescaling the depths and recording the new internal depth units. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The dynamic horizontal grid type</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">m_in_new_units</parametername>
</parameternamelist>
<parameterdescription>
<para>The new internal representation of 1 m depth. </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" line="284" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" bodystart="285" bodyend="312"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <referencedby refid="namespacemom__ice__shelf_1a5990f9918493ff4984245eac74e5f4d9" compoundref="MOM__ice__shelf_8F90" startline="1084" endline="1638">mom_ice_shelf::initialize_ice_shelf</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__dyn__horgrid_1a26c1389a380922c7c5d946cff3a9b11a" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_dyn_horgrid::set_derived_dyn_horgrid</definition>
        <argsstring>(G, US)</argsstring>
        <name>set_derived_dyn_horgrid</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <briefdescription>
<para>set_derived_dyn_horgrid calculates metric terms that are derived from other metrics. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The dynamic horizontal grid type</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" line="316" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" bodystart="317" bodyend="363"/>
        <references refid="namespacemom__dyn__horgrid_1aa6579f50769698067defbc3c676e0191" compoundref="MOM__dyn__horgrid_8F90" startline="368" endline="371">adcroft_reciprocal</references>
        <referencedby refid="namespacemom__transcribe__grid_1afe3cc701e19603d664699db7fe8d72a8" compoundref="MOM__transcribe__grid_8F90" startline="169" endline="307">mom_transcribe_grid::copy_mom_grid_to_dyngrid</referencedby>
        <referencedby refid="namespacemom__transcribe__grid_1a6eb8778abd0e6800af90271536b19796" compoundref="MOM__transcribe__grid_8F90" startline="311" endline="395">mom_transcribe_grid::rotate_dyngrid</referencedby>
        <referencedby refid="namespacemom__grid__initialize_1a80ff9ab4bfca58b9858abc4ce95b06e9" compoundref="MOM__grid__initialize_8F90" startline="63" endline="108">mom_grid_initialize::set_grid_metrics</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__dyn__horgrid_1aa6579f50769698067defbc3c676e0191" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>real function</type>
        <definition>real function mom_dyn_horgrid::adcroft_reciprocal</definition>
        <argsstring>(val)</argsstring>
        <name>adcroft_reciprocal</name>
        <param>
          <type>val</type>
          <defname>val</defname>
        </param>
        <briefdescription>
<para>Adcroft_reciprocal(x) = 1/x for |x|&gt;0 or 0 for x=0. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">val</parametername>
</parameternamelist>
<parameterdescription>
<para>The value being inverted.</para></parameterdescription>
</parameteritem>
</parameterlist>
<simplesect kind="return"><para>The Adcroft reciprocal of val. </para></simplesect>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" line="367" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" bodystart="368" bodyend="371"/>
        <referencedby refid="namespacemom__dyn__horgrid_1a26c1389a380922c7c5d946cff3a9b11a" compoundref="MOM__dyn__horgrid_8F90" startline="317" endline="363">set_derived_dyn_horgrid</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacemom__dyn__horgrid_1a23c063bf0f2d5e5e96569a6bc5f8f382" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_dyn_horgrid::destroy_dyn_horgrid</definition>
        <argsstring>(G)</argsstring>
        <name>destroy_dyn_horgrid</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <briefdescription>
<para>Release memory used by the <ref refid="structmom__dyn__horgrid_1_1dyn__horgrid__type" kindref="compound">dyn_horgrid_type</ref> and related structures. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>g</parametername>
</parameternamelist>
<parameterdescription>
<para>The dynamic horizontal grid type </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" line="376" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" bodystart="377" bodyend="420"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Contains a shareable dynamic type for describing horizontal grids and metric data and utilty routines that work on this type. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_dyn_horgrid.F90" line="3" column="1"/>
  </compounddef>
</doxygen>
