<?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.19" xml:lang="en-US">
  <compounddef id="namespacedyed__channel__initialization" kind="namespace" language="Fortran">
    <compoundname>dyed_channel_initialization</compoundname>
    <innerclass refid="structdyed__channel__initialization_1_1dyed__channel__obc__cs" prot="public">dyed_channel_initialization::dyed_channel_obc_cs</innerclass>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacedyed__channel__initialization_1a3e5386324e634b73ca2c9e53a1f85775" prot="public" static="no" mutable="no">
        <type>integer</type>
        <definition>integer dyed_channel_initialization::ntr</definition>
        <argsstring></argsstring>
        <name>ntr</name>
        <initializer>= 0</initializer>
        <briefdescription>
<para>Number of dye tracers. </para>
        </briefdescription>
        <detaileddescription>
<para><xrefsect id="todo_1_todo000010"><xreftitle>Todo</xreftitle><xrefdescription><para>This is a module variable. Move this variable into the control structure. </para>
</xrefdescription></xrefsect></para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" line="34" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" bodystart="34" bodyend="34"/>
        <referencedby refid="namespacedyed__channel__initialization_1a61f1363b7fcad22750a7cea035aada98" compoundref="dyed__channel__initialization_8F90" startline="83" endline="130">dyed_channel_set_obc_tracer_data</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacedyed__channel__initialization_1a3b2f27c5213cbae5174f1e841d5f0d97" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>logical function, public</type>
        <definition>logical function, public dyed_channel_initialization::register_dyed_channel_obc</definition>
        <argsstring>(param_file, CS, OBC_Reg)</argsstring>
        <name>register_dyed_channel_obc</name>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>OBC_Reg</type>
          <defname>OBC_Reg</defname>
        </param>
        <briefdescription>
<para>Add dyed channel to OBC registry. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>parameter file. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Dyed channel control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>obc_reg</parametername>
</parameternamelist>
<parameterdescription>
<para>OBC registry. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" line="40" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" bodystart="41" bodyend="69"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacemom__open__boundary_1a8e0e22d829c122134f039228c6f1c7fb" compoundref="MOM__open__boundary_8F90" startline="4414" endline="4435">mom_open_boundary::register_obc</references>
      </memberdef>
      <memberdef kind="function" id="namespacedyed__channel__initialization_1a11908b8cf33f19e69a11a46107d9b2d6" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dyed_channel_initialization::dyed_channel_obc_end</definition>
        <argsstring>(CS)</argsstring>
        <name>dyed_channel_obc_end</name>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Clean up the dyed_channel OBC from registry. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Dyed channel control structure. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" line="73" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" bodystart="74" bodyend="78"/>
      </memberdef>
      <memberdef kind="function" id="namespacedyed__channel__initialization_1a61f1363b7fcad22750a7cea035aada98" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dyed_channel_initialization::dyed_channel_set_obc_tracer_data</definition>
        <argsstring>(OBC, G, GV, param_file, tr_Reg)</argsstring>
        <name>dyed_channel_set_obc_tracer_data</name>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>tr_Reg</type>
          <defname>tr_Reg</defname>
        </param>
        <briefdescription>
<para>This subroutine sets the dye and flow properties at open boundary conditions. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>This open boundary condition type specifies whether, where, and what open boundary conditions are used. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s vertical grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure indicating the open file to parse for model parameter values. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>tr_reg</parametername>
</parameternamelist>
<parameterdescription>
<para>Tracer registry. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" line="82" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" bodystart="83" bodyend="130"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacedyed__channel__initialization_1a3e5386324e634b73ca2c9e53a1f85775" compoundref="dyed__channel__initialization_8F90" startline="34" endline="34">ntr</references>
        <referencedby refid="namespacemom__state__initialization_1a81503d4f1855cb185f122d6314e4f06c" compoundref="MOM__state__initialization_8F90" startline="117" endline="615">mom_state_initialization::mom_initialize_state</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacedyed__channel__initialization_1a5e9457402221f33d9e8dd4495246e051" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dyed_channel_initialization::dyed_channel_update_flow</definition>
        <argsstring>(OBC, CS, G, Time)</argsstring>
        <name>dyed_channel_update_flow</name>
        <param>
          <type>OBC</type>
          <defname>OBC</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>Time</type>
          <defname>Time</defname>
        </param>
        <briefdescription>
<para>This subroutine updates the long-channel flow. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername>obc</parametername>
</parameternamelist>
<parameterdescription>
<para>This open boundary condition type specifies whether, where, and what open boundary conditions are used. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Dyed channel control structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>The ocean&apos;s grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>model time. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" line="134" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" bodystart="135" bodyend="190"/>
        <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>Initialization for the dyed_channel configuration. </para>
    </briefdescription>
    <detaileddescription>
<para>Setting dyes, one for painting the inflow on each side. </para>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/dyed_channel_initialization.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
