<?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.13">
  <compounddef id="structadvection__test__tracer_1_1advection__test__tracer__cs" kind="type" language="Fortran" prot="public">
    <compoundname>advection_test_tracer::advection_test_tracer_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a00889fd18361ee6fba75c3fd62c358e0" prot="public" static="no" mutable="no">
        <type>integer</type>
        <definition>integer advection_test_tracer::advection_test_tracer_cs::ntr</definition>
        <argsstring></argsstring>
        <name>ntr</name>
        <initializer>= NTR</initializer>
        <briefdescription>
<para>Number of tracers in this module. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="38" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="38" bodyend="38"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a7c0acc2218fbe0c2a16997e53883f1d8" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical advection_test_tracer::advection_test_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/advection_test_tracer.F90" line="39" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="39" bodyend="39"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a1b1288fe66af5ce8ad81f25f26c00a8d" prot="public" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=200)</type>
        <definition>character(len=200) advection_test_tracer::advection_test_tracer_cs::tracer_ic_file</definition>
        <argsstring></argsstring>
        <name>tracer_ic_file</name>
        <briefdescription>
<para>The full path to the IC file, or &quot; &quot; to initialize internally. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="40" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="40" bodyend="40"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1af6681a6732e8ad828cc843eeb08d7ecb" prot="public" static="no" mutable="no">
        <type>type(time_type), pointer</type>
        <definition>type(time_type), pointer advection_test_tracer::advection_test_tracer_cs::time</definition>
        <argsstring></argsstring>
        <name>time</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>A pointer to the ocean model&apos;s clock. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="41" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="41" bodyend="41"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a9358bbadf241553aae67888056b31c54" prot="public" static="no" mutable="no">
        <type>type(tracer_registry_type), pointer</type>
        <definition>type(tracer_registry_type), pointer advection_test_tracer::advection_test_tracer_cs::tr_reg</definition>
        <argsstring></argsstring>
        <name>tr_reg</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>A pointer to the MOM tracer registry. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="42" bodyend="42"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a704b8fc747a6b25cce99661743b0ab10" prot="public" static="no" mutable="no">
        <type>real, dimension(:,:,:,:), pointer</type>
        <definition>real, dimension(:,:,:,:), pointer advection_test_tracer::advection_test_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/advection_test_tracer.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="43" bodyend="43"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1ab477d529b84a5e53426843e8b0324c09" prot="public" static="no" mutable="no">
        <type>real, dimension(<ref refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a00889fd18361ee6fba75c3fd62c358e0" kindref="member">ntr</ref>)</type>
        <definition>real, dimension(ntr) advection_test_tracer::advection_test_tracer_cs::land_val</definition>
        <argsstring></argsstring>
        <name>land_val</name>
        <initializer>= -1.0</initializer>
        <briefdescription>
<para>The value of tr used where land is masked out. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="44" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="44" bodyend="44"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1afc9db0aee20780c3f8e1e8d5b8616916" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical advection_test_tracer::advection_test_tracer_cs::use_sponge</definition>
        <argsstring></argsstring>
        <name>use_sponge</name>
        <briefdescription>
<para>If true, sponges may be applied somewhere in the domain. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="45" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="45" bodyend="45"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1acc5ca23da64d86ecb73ad26013d7b1b8" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical advection_test_tracer::advection_test_tracer_cs::tracers_may_reinit</definition>
        <argsstring></argsstring>
        <name>tracers_may_reinit</name>
        <briefdescription>
<para>If true, the tracers may be set up via the initialization code if they are not found in the restart files. Otherwise it is a fatal error if the tracers are not found in the restart files of a restarted run. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="46" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="46" bodyend="46"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a92356585c6949bc02c5b36a18880da46" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real advection_test_tracer::advection_test_tracer_cs::x_origin</definition>
        <argsstring></argsstring>
        <name>x_origin</name>
        <briefdescription>
<para>Parameters describing the test functions. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="49" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="49" bodyend="49"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1adfc9c2b78bf77967d87293aff35a0fcd" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real advection_test_tracer::advection_test_tracer_cs::x_width</definition>
        <argsstring></argsstring>
        <name>x_width</name>
        <briefdescription>
<para>Parameters describing the test functions. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="50" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="50" bodyend="50"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1afc5726e44814268c78c4bd32b175dc88" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real advection_test_tracer::advection_test_tracer_cs::y_origin</definition>
        <argsstring></argsstring>
        <name>y_origin</name>
        <briefdescription>
<para>Parameters describing the test functions. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="51" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="51" bodyend="51"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a681aa8904d374c30522cf22191ae5f48" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real advection_test_tracer::advection_test_tracer_cs::y_width</definition>
        <argsstring></argsstring>
        <name>y_width</name>
        <briefdescription>
<para>Parameters describing the test functions. </para>        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="52" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="52" bodyend="52"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a5516544236f253e5819676badb5c601d" prot="public" static="no" mutable="no">
        <type>integer, dimension(<ref refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a00889fd18361ee6fba75c3fd62c358e0" kindref="member">ntr</ref>)</type>
        <definition>integer, dimension(ntr) advection_test_tracer::advection_test_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/advection_test_tracer.F90" line="54" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="54" bodyend="54"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a2aee63fe7dc969869f2d8256b725d86b" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer advection_test_tracer::advection_test_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/advection_test_tracer.F90" line="57" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="57" bodyend="57"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a492f5aeee7bb3e877d61e527c6f99cf5" prot="public" static="no" mutable="no">
        <type>type(mom_restart_cs), pointer</type>
        <definition>type(mom_restart_cs), pointer advection_test_tracer::advection_test_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/advection_test_tracer.F90" line="59" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="59" bodyend="59"/>
      </memberdef>
      <memberdef kind="variable" id="structadvection__test__tracer_1_1advection__test__tracer__cs_1a81a0a52487093e953cc67b7315d9b705" prot="public" static="no" mutable="no">
        <type>type(vardesc), dimension(<ref refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a00889fd18361ee6fba75c3fd62c358e0" kindref="member">ntr</ref>)</type>
        <definition>type(vardesc), dimension(ntr) advection_test_tracer::advection_test_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/advection_test_tracer.F90" line="61" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="61" bodyend="61"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>The control structure for the advect_test_tracer module. </para>    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="17">
        <label>real</label>
      </node>
      <node id="14">
        <label>vardesc</label>
      </node>
      <node id="10">
        <label>logical</label>
      </node>
      <node id="9">
        <label>advection_test_tracer::advection_test_tracer_cs</label>
        <link refid="structadvection__test__tracer_1_1advection__test__tracer__cs"/>
        <childnode refid="10" relation="usage">
          <edgelabel>use_sponge</edgelabel>
          <edgelabel>coupled_tracers</edgelabel>
          <edgelabel>tracers_may_reinit</edgelabel>
        </childnode>
        <childnode refid="11" relation="usage">
          <edgelabel>time</edgelabel>
        </childnode>
        <childnode refid="12" relation="usage">
          <edgelabel>tr_reg</edgelabel>
        </childnode>
        <childnode refid="13" relation="usage">
          <edgelabel>tracer_ic_file</edgelabel>
        </childnode>
        <childnode refid="14" relation="usage">
          <edgelabel>tr_desc</edgelabel>
        </childnode>
        <childnode refid="15" relation="usage">
          <edgelabel>restart_csp</edgelabel>
        </childnode>
        <childnode refid="16" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="17" relation="usage">
          <edgelabel>y_origin</edgelabel>
          <edgelabel>land_val</edgelabel>
          <edgelabel>x_width</edgelabel>
          <edgelabel>y_width</edgelabel>
          <edgelabel>tr</edgelabel>
          <edgelabel>x_origin</edgelabel>
        </childnode>
        <childnode refid="18" relation="usage">
          <edgelabel>ntr</edgelabel>
          <edgelabel>ind_tr</edgelabel>
        </childnode>
      </node>
      <node id="11">
        <label>time_type</label>
      </node>
      <node id="16">
        <label>diag_ctrl</label>
      </node>
      <node id="18">
        <label>integer</label>
      </node>
      <node id="13">
        <label>character(len=200)</label>
      </node>
      <node id="15">
        <label>type(mom_restart_cs), pointer</label>
      </node>
      <node id="12">
        <label>tracer_registry_type</label>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" line="37" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/advection_test_tracer.F90" bodystart="37" bodyend="62"/>
    <listofallmembers>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a7c0acc2218fbe0c2a16997e53883f1d8" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>coupled_tracers</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a2aee63fe7dc969869f2d8256b725d86b" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>diag</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a5516544236f253e5819676badb5c601d" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>ind_tr</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1ab477d529b84a5e53426843e8b0324c09" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>land_val</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a00889fd18361ee6fba75c3fd62c358e0" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>ntr</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a492f5aeee7bb3e877d61e527c6f99cf5" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>restart_csp</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1af6681a6732e8ad828cc843eeb08d7ecb" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>time</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a704b8fc747a6b25cce99661743b0ab10" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>tr</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a81a0a52487093e953cc67b7315d9b705" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>tr_desc</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a9358bbadf241553aae67888056b31c54" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>tr_reg</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a1b1288fe66af5ce8ad81f25f26c00a8d" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>tracer_ic_file</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1acc5ca23da64d86ecb73ad26013d7b1b8" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>tracers_may_reinit</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1afc9db0aee20780c3f8e1e8d5b8616916" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>use_sponge</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a92356585c6949bc02c5b36a18880da46" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>x_origin</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1adfc9c2b78bf77967d87293aff35a0fcd" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>x_width</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1afc5726e44814268c78c4bd32b175dc88" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>y_origin</name></member>
      <member refid="structadvection__test__tracer_1_1advection__test__tracer__cs_1a681aa8904d374c30522cf22191ae5f48" prot="public" virt="non-virtual"><scope>advection_test_tracer::advection_test_tracer_cs</scope><name>y_width</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
