<?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="structregional__dyes_1_1dye__tracer__cs" kind="type" language="Fortran" prot="public">
    <compoundname>regional_dyes::dye_tracer_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a1268e9e2fc213858cd3b1448b4a3e412" prot="public" static="no" mutable="no">
        <type>integer</type>
        <definition>integer regional_dyes::dye_tracer_cs::ntr</definition>
        <argsstring></argsstring>
        <name>ntr</name>
        <briefdescription>
<para>The number of tracers that are actually used. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="42" bodyend="42"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a8b4fbe1ca743a69d50926551150e702c" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical regional_dyes::dye_tracer_cs::coupled_tracers</definition>
        <argsstring></argsstring>
        <name>coupled_tracers</name>
        <initializer>= .false.</initializer>
        <briefdescription>
<para>These tracers are not offered to the coupler. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="43" bodyend="43"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a4c94da4fbc2b5b352471236ee885e921" prot="public" static="no" mutable="no">
        <type>real, dimension(:), allocatable</type>
        <definition>real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_minlon</definition>
        <argsstring></argsstring>
        <name>dye_source_minlon</name>
        <briefdescription>
<para>Minimum longitude of region dye will be injected. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="44" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="44" bodyend="44"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a5a9de01ba92daa54257f1da86e8a4102" prot="public" static="no" mutable="no">
        <type>real, dimension(:), allocatable</type>
        <definition>real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_maxlon</definition>
        <argsstring></argsstring>
        <name>dye_source_maxlon</name>
        <briefdescription>
<para>Maximum longitude of region dye will be injected. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="45" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="45" bodyend="45"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a7eca6e6d55f0053be420926463ab6ed2" prot="public" static="no" mutable="no">
        <type>real, dimension(:), allocatable</type>
        <definition>real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_minlat</definition>
        <argsstring></argsstring>
        <name>dye_source_minlat</name>
        <briefdescription>
<para>Minimum latitude of region dye will be injected. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="46" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="46" bodyend="46"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a99747dd299d2e4f613b3089b6613c770" prot="public" static="no" mutable="no">
        <type>real, dimension(:), allocatable</type>
        <definition>real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_maxlat</definition>
        <argsstring></argsstring>
        <name>dye_source_maxlat</name>
        <briefdescription>
<para>Maximum latitude of region dye will be injected. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="47" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="47" bodyend="47"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a53a1c26c7c905869874b8dfa09ffb5f9" prot="public" static="no" mutable="no">
        <type>real, dimension(:), allocatable</type>
        <definition>real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_mindepth</definition>
        <argsstring></argsstring>
        <name>dye_source_mindepth</name>
        <briefdescription>
<para>Minimum depth of region dye will be injected [Z ~&gt; m]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="48" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="48" bodyend="48"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a1efec0bbaa7ab022df92c47d1081b5bb" prot="public" static="no" mutable="no">
        <type>real, dimension(:), allocatable</type>
        <definition>real, dimension(:), allocatable regional_dyes::dye_tracer_cs::dye_source_maxdepth</definition>
        <argsstring></argsstring>
        <name>dye_source_maxdepth</name>
        <briefdescription>
<para>Maximum depth of region dye will be injected [Z ~&gt; m]. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="49" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="49" bodyend="49"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1acba731577a6753c0e814f867f2fb4574" prot="public" static="no" mutable="no">
        <type>type(tracer_registry_type), pointer</type>
        <definition>type(tracer_registry_type), pointer regional_dyes::dye_tracer_cs::tr_reg</definition>
        <argsstring></argsstring>
        <name>tr_reg</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>A pointer to the tracer registry. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="50" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="50" bodyend="50"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a018dbd8db737a7f0a4fe49776e72e2cb" prot="public" static="no" mutable="no">
        <type>real, dimension(:,:,:,:), pointer</type>
        <definition>real, dimension(:,:,:,:), pointer regional_dyes::dye_tracer_cs::tr</definition>
        <argsstring></argsstring>
        <name>tr</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>The array of tracers used in this subroutine, in g m-3? </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="51" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="51" bodyend="51"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1ad5a9c63f2124a4c74b35db70f6938a54" prot="public" static="no" mutable="no">
        <type>integer, dimension(:), allocatable</type>
        <definition>integer, dimension(:), allocatable regional_dyes::dye_tracer_cs::ind_tr</definition>
        <argsstring></argsstring>
        <name>ind_tr</name>
        <briefdescription>
<para>Indices returned by aof_set_coupler_flux if it is used and the surface tracer concentrations are to be provided to the coupler. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="53" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="53" bodyend="53"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1af45f01b7f511f41f30483aa5f13356d5" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer regional_dyes::dye_tracer_cs::diag</definition>
        <argsstring></argsstring>
        <name>diag</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>A structure that is used to regulate the timing of diagnostic output. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="56" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="56" bodyend="56"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a85ec48ef3231acadfd96ab3206a1bd0c" prot="public" static="no" mutable="no">
        <type>type(mom_restart_cs), pointer</type>
        <definition>type(mom_restart_cs), pointer regional_dyes::dye_tracer_cs::restart_csp</definition>
        <argsstring></argsstring>
        <name>restart_csp</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>A pointer to the restart control structure. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="58" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="58" bodyend="58"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a1d0dc3872db51cb7d425ab82341b58fb" prot="public" static="no" mutable="no">
        <type>type(vardesc), dimension(:), allocatable</type>
        <definition>type(vardesc), dimension(:), allocatable regional_dyes::dye_tracer_cs::tr_desc</definition>
        <argsstring></argsstring>
        <name>tr_desc</name>
        <briefdescription>
<para>Descriptions and metadata for the tracers. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="60" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="60" bodyend="60"/>
      </memberdef>
      <memberdef kind="variable" id="structregional__dyes_1_1dye__tracer__cs_1a93886a04c960e0d041b40ca45228d3c2" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical regional_dyes::dye_tracer_cs::tracers_may_reinit</definition>
        <argsstring></argsstring>
        <name>tracers_may_reinit</name>
        <initializer>= .false.</initializer>
        <briefdescription>
<para>If true the tracers may be initialized if not found in a restart file. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="61" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="61" bodyend="61"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>The control structure for the regional dyes tracer package. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="415">
        <label>real</label>
      </node>
      <node id="412">
        <label>vardesc</label>
      </node>
      <node id="410">
        <label>logical</label>
      </node>
      <node id="409">
        <label>regional_dyes::dye_tracer_cs</label>
        <link refid="structregional__dyes_1_1dye__tracer__cs"/>
        <childnode refid="410" relation="usage">
          <edgelabel>coupled_tracers</edgelabel>
          <edgelabel>tracers_may_reinit</edgelabel>
        </childnode>
        <childnode refid="411" relation="usage">
          <edgelabel>tr_reg</edgelabel>
        </childnode>
        <childnode refid="412" relation="usage">
          <edgelabel>tr_desc</edgelabel>
        </childnode>
        <childnode refid="413" relation="usage">
          <edgelabel>restart_csp</edgelabel>
        </childnode>
        <childnode refid="414" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="415" relation="usage">
          <edgelabel>dye_source_maxlat</edgelabel>
          <edgelabel>dye_source_minlat</edgelabel>
          <edgelabel>dye_source_maxdepth</edgelabel>
          <edgelabel>dye_source_mindepth</edgelabel>
          <edgelabel>dye_source_maxlon</edgelabel>
          <edgelabel>dye_source_minlon</edgelabel>
          <edgelabel>tr</edgelabel>
        </childnode>
        <childnode refid="416" relation="usage">
          <edgelabel>ntr</edgelabel>
          <edgelabel>ind_tr</edgelabel>
        </childnode>
      </node>
      <node id="414">
        <label>diag_ctrl</label>
      </node>
      <node id="416">
        <label>integer</label>
      </node>
      <node id="413">
        <label>type(mom_restart_cs), pointer</label>
      </node>
      <node id="411">
        <label>tracer_registry_type</label>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" line="41" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/dye_example.F90" bodystart="41" bodyend="62"/>
    <listofallmembers>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a8b4fbe1ca743a69d50926551150e702c" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>coupled_tracers</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1af45f01b7f511f41f30483aa5f13356d5" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>diag</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a1efec0bbaa7ab022df92c47d1081b5bb" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>dye_source_maxdepth</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a99747dd299d2e4f613b3089b6613c770" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>dye_source_maxlat</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a5a9de01ba92daa54257f1da86e8a4102" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>dye_source_maxlon</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a53a1c26c7c905869874b8dfa09ffb5f9" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>dye_source_mindepth</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a7eca6e6d55f0053be420926463ab6ed2" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>dye_source_minlat</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a4c94da4fbc2b5b352471236ee885e921" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>dye_source_minlon</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1ad5a9c63f2124a4c74b35db70f6938a54" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>ind_tr</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a1268e9e2fc213858cd3b1448b4a3e412" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>ntr</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a85ec48ef3231acadfd96ab3206a1bd0c" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>restart_csp</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a018dbd8db737a7f0a4fe49776e72e2cb" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>tr</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a1d0dc3872db51cb7d425ab82341b58fb" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>tr_desc</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1acba731577a6753c0e814f867f2fb4574" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>tr_reg</name></member>
      <member refid="structregional__dyes_1_1dye__tracer__cs_1a93886a04c960e0d041b40ca45228d3c2" prot="public" virt="non-virtual"><scope>regional_dyes::dye_tracer_cs</scope><name>tracers_may_reinit</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
