<?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__ptr" kind="interface" language="Fortran" prot="private">
    <compoundname>mom_safe_alloc::safe_alloc_ptr</compoundname>
      <sectiondef kind="private-func">
      <memberdef kind="function" id="interfacemom__safe__alloc_1_1safe__alloc__ptr_1a12a82b8b4684884b1dc2c0ad50087a3c" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_safe_alloc::safe_alloc_ptr::safe_alloc_ptr_3d_3arg</definition>
        <argsstring>(ptr, ni, nj, nk)</argsstring>
        <name>safe_alloc_ptr_3d_3arg</name>
        <param>
          <type>ptr</type>
          <defname>ptr</defname>
        </param>
        <param>
          <type>ni</type>
          <defname>ni</defname>
        </param>
        <param>
          <type>nj</type>
          <defname>nj</defname>
        </param>
        <param>
          <type>nk</type>
          <defname>nk</defname>
        </param>
        <briefdescription>
<para>Allocate a pointer to a 3-d array based on its dimension sizes. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to allocate</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ni</parametername>
</parameternamelist>
<parameterdescription>
<para>The size of the 1st dimension of the array</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nj</parametername>
</parameternamelist>
<parameterdescription>
<para>The size of the 2nd dimension of the array</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nk</parametername>
</parameternamelist>
<parameterdescription>
<para>The size of the 3rd dimension of the array </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" line="61" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="62" bodyend="69"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__safe__alloc_1_1safe__alloc__ptr_1adb80bbe755ca8e2161737ab9ac692016" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_safe_alloc::safe_alloc_ptr::safe_alloc_ptr_3d_6arg</definition>
        <argsstring>(ptr, is, ie, js, je, ks, ke)</argsstring>
        <name>safe_alloc_ptr_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 pointer to a 3-d array based on its index starting and ending values. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer 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="100" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="101" bodyend="111"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__safe__alloc_1_1safe__alloc__ptr_1a814a08c2898e17352b44735255137296" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_safe_alloc::safe_alloc_ptr::safe_alloc_ptr_2d_2arg</definition>
        <argsstring>(ptr, ni, nj)</argsstring>
        <name>safe_alloc_ptr_2d_2arg</name>
        <param>
          <type>ptr</type>
          <defname>ptr</defname>
        </param>
        <param>
          <type>ni</type>
          <defname>ni</defname>
        </param>
        <param>
          <type>nj</type>
          <defname>nj</defname>
        </param>
        <briefdescription>
<para>Allocate a pointer to a 2-d array based on its dimension sizes. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to allocate</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ni</parametername>
</parameternamelist>
<parameterdescription>
<para>The size of the 1st dimension of the array</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">nj</parametername>
</parameternamelist>
<parameterdescription>
<para>The size of the 2nd dimension of the array </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" line="50" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="51" bodyend="57"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__safe__alloc_1_1safe__alloc__ptr_1abee4bf2c26394f435ce3ede3de327caa" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_safe_alloc::safe_alloc_ptr::safe_alloc_ptr_3d</definition>
        <argsstring>(ptr, is, ie, js, je, nk)</argsstring>
        <name>safe_alloc_ptr_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 pointer to a 3-d array based on its index starting and ending values. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer 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="86" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="87" bodyend="96"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__safe__alloc_1_1safe__alloc__ptr_1ad3985d82ed4b679fa040efcaed207188" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_safe_alloc::safe_alloc_ptr::safe_alloc_ptr_2d</definition>
        <argsstring>(ptr, is, ie, js, je)</argsstring>
        <name>safe_alloc_ptr_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 pointer to a 2-d array based on its index starting and ending values. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer 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="73" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="74" bodyend="82"/>
      </memberdef>
      <memberdef kind="function" id="interfacemom__safe__alloc_1_1safe__alloc__ptr_1ad8b9c3b68988584eb0137dadf3957046" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine mom_safe_alloc::safe_alloc_ptr::safe_alloc_ptr_1d</definition>
        <argsstring>(ptr, i1, i2)</argsstring>
        <name>safe_alloc_ptr_1d</name>
        <param>
          <type>ptr</type>
          <defname>ptr</defname>
        </param>
        <param>
          <type>i1</type>
          <defname>i1</defname>
        </param>
        <param>
          <type>i2</type>
          <defname>i2</defname>
        </param>
        <briefdescription>
<para>Allocate a pointer to a 1-d array. </para>        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>ptr</parametername>
</parameternamelist>
<parameterdescription>
<para>A pointer to allocate</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">i1</parametername>
</parameternamelist>
<parameterdescription>
<para>The size of the array, or its starting index if i2 is present</para></parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">i2</parametername>
</parameternamelist>
<parameterdescription>
<para>The ending index of the array </para></parameterdescription>
</parameteritem>
</parameterlist>
</para>        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" line="35" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="36" bodyend="46"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Allocate a pointer to a 1-d, 2-d or 3-d array. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" line="12" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/framework/MOM_safe_alloc.F90" bodystart="12" bodyend="14"/>
    <listofallmembers>
      <member refid="interfacemom__safe__alloc_1_1safe__alloc__ptr_1ad8b9c3b68988584eb0137dadf3957046" prot="private" virt="non-virtual"><scope>mom_safe_alloc::safe_alloc_ptr</scope><name>safe_alloc_ptr_1d</name></member>
      <member refid="interfacemom__safe__alloc_1_1safe__alloc__ptr_1ad3985d82ed4b679fa040efcaed207188" prot="private" virt="non-virtual"><scope>mom_safe_alloc::safe_alloc_ptr</scope><name>safe_alloc_ptr_2d</name></member>
      <member refid="interfacemom__safe__alloc_1_1safe__alloc__ptr_1a814a08c2898e17352b44735255137296" prot="private" virt="non-virtual"><scope>mom_safe_alloc::safe_alloc_ptr</scope><name>safe_alloc_ptr_2d_2arg</name></member>
      <member refid="interfacemom__safe__alloc_1_1safe__alloc__ptr_1abee4bf2c26394f435ce3ede3de327caa" prot="private" virt="non-virtual"><scope>mom_safe_alloc::safe_alloc_ptr</scope><name>safe_alloc_ptr_3d</name></member>
      <member refid="interfacemom__safe__alloc_1_1safe__alloc__ptr_1a12a82b8b4684884b1dc2c0ad50087a3c" prot="private" virt="non-virtual"><scope>mom_safe_alloc::safe_alloc_ptr</scope><name>safe_alloc_ptr_3d_3arg</name></member>
      <member refid="interfacemom__safe__alloc_1_1safe__alloc__ptr_1adb80bbe755ca8e2161737ab9ac692016" prot="private" virt="non-virtual"><scope>mom_safe_alloc::safe_alloc_ptr</scope><name>safe_alloc_ptr_3d_6arg</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
