<?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="namespacedyed__obcs__initialization" kind="namespace" language="Fortran">
    <compoundname>dyed_obcs_initialization</compoundname>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacedyed__obcs__initialization_1a29ed29b248ce766691e964a173c7ceda" prot="private" static="no" mutable="no">
        <type>integer</type>
        <definition>integer dyed_obcs_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_todo000011"><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_obcs_initialization.F90" line="24" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dyed_obcs_initialization.F90" bodystart="24" bodyend="24"/>
        <referencedby refid="namespacedyed__obcs__initialization_1a46b0e1f06662e2a74b9912114ed0ebcb" compoundref="dyed__obcs__initialization_8F90" startline="31" endline="81">dyed_obcs_set_obc_data</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacedyed__obcs__initialization_1a46b0e1f06662e2a74b9912114ed0ebcb" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public dyed_obcs_initialization::dyed_obcs_set_obc_data</definition>
        <argsstring>(OBC, G, GV, param_file, tr_Reg)</argsstring>
        <name>dyed_obcs_set_obc_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 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_obcs_initialization.F90" line="30" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/dyed_obcs_initialization.F90" bodystart="31" bodyend="81"/>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
        <references refid="namespacedyed__obcs__initialization_1a29ed29b248ce766691e964a173c7ceda" compoundref="dyed__obcs__initialization_8F90" startline="24" endline="24">ntr</references>
        <references refid="namespacemom__open__boundary_1a5d5843dd1a4e1475f69b5eb2c5b0197d" compoundref="MOM__open__boundary_8F90" startline="4528" endline="4584">mom_open_boundary::register_segment_tracer</references>
        <referencedby refid="namespacemom__state__initialization_1a81503d4f1855cb185f122d6314e4f06c" compoundref="MOM__state__initialization_8F90" startline="117" endline="615">mom_state_initialization::mom_initialize_state</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Dyed open boundary conditions. </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_obcs_initialization.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
