<?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.16">
  <compounddef id="namespacefms__coupler__util" kind="namespace" language="Fortran">
    <compoundname>fms_coupler_util</compoundname>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacefms__coupler__util_1a4f1e5f13ca0653fa9676d45abf192aef" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public fms_coupler_util::extract_coupler_values</definition>
        <argsstring>(BC_struc, BC_index, BC_element, array_out, ilb, jlb, is, ie, js, je, conversion)</argsstring>
        <name>extract_coupler_values</name>
        <param>
          <type>BC_struc</type>
          <defname>BC_struc</defname>
        </param>
        <param>
          <type>BC_index</type>
          <defname>BC_index</defname>
        </param>
        <param>
          <type>BC_element</type>
          <defname>BC_element</defname>
        </param>
        <param>
          <type>array_out</type>
          <defname>array_out</defname>
        </param>
        <param>
          <type>ilb</type>
          <defname>ilb</defname>
        </param>
        <param>
          <type>jlb</type>
          <defname>jlb</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>conversion</type>
          <defname>conversion</defname>
        </param>
        <briefdescription>
<para>Get element and index of a boundary condition. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="out">array_out</parametername>
</parameternamelist>
<parameterdescription>
<para>The array being filled with the input values </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ilb</parametername>
</parameternamelist>
<parameterdescription>
<para>Lower bounds </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">jlb</parametername>
</parameternamelist>
<parameterdescription>
<para>Lower bounds </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">bc_struc</parametername>
</parameternamelist>
<parameterdescription>
<para>The type from which the data is being extracted </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">bc_index</parametername>
</parameternamelist>
<parameterdescription>
<para>The boundary condition number being extracted </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">bc_element</parametername>
</parameternamelist>
<parameterdescription>
<para>The element of the boundary condition being extracted </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">is</parametername>
</parameternamelist>
<parameterdescription>
<para>The i- limits of array_out to be filled </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ie</parametername>
</parameternamelist>
<parameterdescription>
<para>The i- limits of array_out to be filled </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">js</parametername>
</parameternamelist>
<parameterdescription>
<para>The j- limits of array_out to be filled </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">je</parametername>
</parameternamelist>
<parameterdescription>
<para>The j- limits of array_out to be filled </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">conversion</parametername>
</parameternamelist>
<parameterdescription>
<para>A number that every element is multiplied by </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/config_src/external/GFDL_ocean_BGC/FMS_coupler_util.F90" line="12" column="1" bodyfile="/home/cermak/src/MOM6.devrob/config_src/external/GFDL_ocean_BGC/FMS_coupler_util.F90" bodystart="14" bodyend="24"/>
      </memberdef>
      <memberdef kind="function" id="namespacefms__coupler__util_1a463adad9df21a9a4b6a791b876e3aab4" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public fms_coupler_util::set_coupler_values</definition>
        <argsstring>(array_in, BC_struc, BC_index, BC_element, ilb, jlb, is, ie, js, je, conversion)</argsstring>
        <name>set_coupler_values</name>
        <param>
          <type>array_in</type>
          <defname>array_in</defname>
        </param>
        <param>
          <type>BC_struc</type>
          <defname>BC_struc</defname>
        </param>
        <param>
          <type>BC_index</type>
          <defname>BC_index</defname>
        </param>
        <param>
          <type>BC_element</type>
          <defname>BC_element</defname>
        </param>
        <param>
          <type>ilb</type>
          <defname>ilb</defname>
        </param>
        <param>
          <type>jlb</type>
          <defname>jlb</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>conversion</type>
          <defname>conversion</defname>
        </param>
        <briefdescription>
<para>Set element and index of a boundary condition. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">array_in</parametername>
</parameternamelist>
<parameterdescription>
<para>The array containing the values to load into the BC </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ilb</parametername>
</parameternamelist>
<parameterdescription>
<para>Lower bounds </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">jlb</parametername>
</parameternamelist>
<parameterdescription>
<para>Lower bounds </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">bc_struc</parametername>
</parameternamelist>
<parameterdescription>
<para>The type into which the data is being loaded </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">bc_index</parametername>
</parameternamelist>
<parameterdescription>
<para>The boundary condition number being set </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">bc_element</parametername>
</parameternamelist>
<parameterdescription>
<para>The element of the boundary condition being set </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">is</parametername>
</parameternamelist>
<parameterdescription>
<para>The i- limits of array_out to be filled </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">ie</parametername>
</parameternamelist>
<parameterdescription>
<para>The i- limits of array_out to be filled </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">js</parametername>
</parameternamelist>
<parameterdescription>
<para>The j- limits of array_out to be filled </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">je</parametername>
</parameternamelist>
<parameterdescription>
<para>The j- limits of array_out to be filled </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">conversion</parametername>
</parameternamelist>
<parameterdescription>
<para>A number that every element is multiplied by </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/config_src/external/GFDL_ocean_BGC/FMS_coupler_util.F90" line="28" column="1" bodyfile="/home/cermak/src/MOM6.devrob/config_src/external/GFDL_ocean_BGC/FMS_coupler_util.F90" bodystart="30" bodyend="40"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/config_src/external/GFDL_ocean_BGC/FMS_coupler_util.F90" line="1" column="1"/>
  </compounddef>
</doxygen>
