<?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="interfacemom__safe__alloc_1_1safe__alloc__alloc" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_safe_alloc::safe_alloc_alloc</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__safe__alloc_1_1safe__alloc__alloc_1abdf6bc92f2d4da6b7c10a797dc3256d4" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_safe_alloc::safe_alloc_alloc::safe_alloc_allocatable_3d</definition>
        <argsstring>(ptr, is, ie, js, je, nk)</argsstring>
        <name>safe_alloc_allocatable_3d</name>
        <param>
          <type>ptr</type>
          <defname>ptr</defname>
        </param>
        <param>
          <type>is</type>
          <defname>is</defname>
        </param>
        <param>
          <type>ie</type>
          <defname>ie</defname>
        </param>
        <param>
          <type>js</type>
          <defname>js</defname>
        </param>
        <param>
          <type>je</type>
          <defname>je</defname>
        </param>
        <param>
          <type>nk</type>
          <defname>nk</defname>
        </param>
        <briefdescription>
<para>Allocate a 3-d allocatable array based on its index starting and ending values and k-index size. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>An allocatable array to allocate</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">is</parametername>
</parameternamelist>
<parameterdescription>
<para>The start index to allocate for the 1st dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ie</parametername>
</parameternamelist>
<parameterdescription>
<para>The end index to allocate for the 1st dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">js</parametername>
</parameternamelist>
<parameterdescription>
<para>The start index to allocate for the 2nd dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">je</parametername>
</parameternamelist>
<parameterdescription>
<para>The end index to allocate for the 2nd dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nk</parametername>
</parameternamelist>
<parameterdescription>
<para>The size to allocate for the 3rd dimension </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" line="130" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="131" bodyend="140"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__safe__alloc_1_1safe__alloc__alloc_1ab75c2e234298e38b8bd113f83ef1796d" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_safe_alloc::safe_alloc_alloc::safe_alloc_allocatable_2d</definition>
        <argsstring>(ptr, is, ie, js, je)</argsstring>
        <name>safe_alloc_allocatable_2d</name>
        <param>
          <type>ptr</type>
          <defname>ptr</defname>
        </param>
        <param>
          <type>is</type>
          <defname>is</defname>
        </param>
        <param>
          <type>ie</type>
          <defname>ie</defname>
        </param>
        <param>
          <type>js</type>
          <defname>js</defname>
        </param>
        <param>
          <type>je</type>
          <defname>je</defname>
        </param>
        <briefdescription>
<para>Allocate a 2-d allocatable array based on its index starting and ending values. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>An allocatable array to allocate</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">is</parametername>
</parameternamelist>
<parameterdescription>
<para>The start index to allocate for the 1st dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ie</parametername>
</parameternamelist>
<parameterdescription>
<para>The end index to allocate for the 1st dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">js</parametername>
</parameternamelist>
<parameterdescription>
<para>The start index to allocate for the 2nd dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">je</parametername>
</parameternamelist>
<parameterdescription>
<para>The end index to allocate for the 2nd dimension </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" line="116" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="117" bodyend="125"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__safe__alloc_1_1safe__alloc__alloc_1ac8b67bbe358629f00a3a708a65aaa91c" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_safe_alloc::safe_alloc_alloc::safe_alloc_allocatable_3d_6arg</definition>
        <argsstring>(ptr, is, ie, js, je, ks, ke)</argsstring>
        <name>safe_alloc_allocatable_3d_6arg</name>
        <param>
          <type>ptr</type>
          <defname>ptr</defname>
        </param>
        <param>
          <type>is</type>
          <defname>is</defname>
        </param>
        <param>
          <type>ie</type>
          <defname>ie</defname>
        </param>
        <param>
          <type>js</type>
          <defname>js</defname>
        </param>
        <param>
          <type>je</type>
          <defname>je</defname>
        </param>
        <param>
          <type>ks</type>
          <defname>ks</defname>
        </param>
        <param>
          <type>ke</type>
          <defname>ke</defname>
        </param>
        <briefdescription>
<para>Allocate a 3-d allocatable array based on its 6 index starting and ending values. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>An allocatable array to allocate</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">is</parametername>
</parameternamelist>
<parameterdescription>
<para>The start index to allocate for the 1st dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ie</parametername>
</parameternamelist>
<parameterdescription>
<para>The end index to allocate for the 1st dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">js</parametername>
</parameternamelist>
<parameterdescription>
<para>The start index to allocate for the 2nd dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">je</parametername>
</parameternamelist>
<parameterdescription>
<para>The end index to allocate for the 2nd dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ks</parametername>
</parameternamelist>
<parameterdescription>
<para>The start index to allocate for the 3rd dimension</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ke</parametername>
</parameternamelist>
<parameterdescription>
<para>The end index to allocate for the 3rd dimension </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" line="144" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="145" bodyend="155"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Allocate a 2-d or 3-d allocatable array. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" line="18" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="18" bodyend="20"/>
    <listofallmembers>
      <member refid="interfacemom__safe__alloc_1_1safe__alloc__alloc_1ab75c2e234298e38b8bd113f83ef1796d" prot="private" virt="non-virtual"><scope>mom_safe_alloc::safe_alloc_alloc</scope><name>safe_alloc_allocatable_2d</name></member>
      <member refid="interfacemom__safe__alloc_1_1safe__alloc__alloc_1abdf6bc92f2d4da6b7c10a797dc3256d4" prot="private" virt="non-virtual"><scope>mom_safe_alloc::safe_alloc_alloc</scope><name>safe_alloc_allocatable_3d</name></member>
      <member refid="interfacemom__safe__alloc_1_1safe__alloc__alloc_1ac8b67bbe358629f00a3a708a65aaa91c" prot="private" virt="non-virtual"><scope>mom_safe_alloc::safe_alloc_alloc</scope><name>safe_alloc_allocatable_3d_6arg</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
