<?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.17">
  <compounddef id="structuser__tracer__example_1_1user__tracer__example__cs" kind="type" language="Fortran" prot="public">
    <compoundname>user_tracer_example::user_tracer_example_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structuser__tracer__example_1_1user__tracer__example__cs_1a9cb262a8f72e84efda51f1f86a59763c" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical user_tracer_example::user_tracer_example_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/tracer_example.F90" line="36" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="36" bodyend="36"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__tracer__example_1_1user__tracer__example__cs_1a9e299627465d85c69c00b63f636e151c" prot="public" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=200)</type>
        <definition>character(len=200) user_tracer_example::user_tracer_example_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/tracer_example.F90" line="37" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="37" bodyend="37"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__tracer__example_1_1user__tracer__example__cs_1af8e1d085becdddfc57d6eb01344f66c4" prot="public" static="no" mutable="no">
        <type>type(time_type), pointer</type>
        <definition>type(time_type), pointer user_tracer_example::user_tracer_example_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/tracer_example.F90" line="39" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="39" bodyend="39"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__tracer__example_1_1user__tracer__example__cs_1a0bb9f992287f873b11eba0e72db4f6c6" prot="public" static="no" mutable="no">
        <type>type(tracer_registry_type), pointer</type>
        <definition>type(tracer_registry_type), pointer user_tracer_example::user_tracer_example_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/tracer_example.F90" line="40" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="40" bodyend="40"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__tracer__example_1_1user__tracer__example__cs_1aac497db3d9d6284ab78744ecb64b44e6" prot="public" static="no" mutable="no">
        <type>real, dimension(:,:,:,:), pointer</type>
        <definition>real, dimension(:,:,:,:), pointer user_tracer_example::user_tracer_example_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/tracer_example.F90" line="41" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="41" bodyend="41"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__tracer__example_1_1user__tracer__example__cs_1acd32ce5ccfe66456c42dc31188967d64" prot="public" static="no" mutable="no">
        <type>real, dimension(<ref refid="namespaceuser__tracer__example_1a8878e6c0ffc368959f12d7c06e1d60ba" kindref="member">ntr</ref>)</type>
        <definition>real, dimension(ntr) user_tracer_example::user_tracer_example_cs::land_val</definition>
        <argsstring></argsstring>
        <name>land_val</name>
        <initializer>= -1.0</initializer>
        <briefdescription>
<para>The value of tr that is used where land is masked out. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="42" bodyend="42"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__tracer__example_1_1user__tracer__example__cs_1a396f072e44f49536faf1ab0aed125762" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical user_tracer_example::user_tracer_example_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/tracer_example.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="43" bodyend="43"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__tracer__example_1_1user__tracer__example__cs_1a5aa6c232e667785a514be92ec4bf92d9" prot="public" static="no" mutable="no">
        <type>integer, dimension(<ref refid="namespaceuser__tracer__example_1a8878e6c0ffc368959f12d7c06e1d60ba" kindref="member">ntr</ref>)</type>
        <definition>integer, dimension(ntr) user_tracer_example::user_tracer_example_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/tracer_example.F90" line="45" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="45" bodyend="45"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__tracer__example_1_1user__tracer__example__cs_1acdb68f3369f13ff37fa4540d1a9d4715" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer user_tracer_example::user_tracer_example_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/tracer_example.F90" line="48" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="48" bodyend="48"/>
      </memberdef>
      <memberdef kind="variable" id="structuser__tracer__example_1_1user__tracer__example__cs_1acd5be51cf2e5ab30c95004cb200f5dee" prot="public" static="no" mutable="no">
        <type>type(vardesc), dimension(<ref refid="namespaceuser__tracer__example_1a8878e6c0ffc368959f12d7c06e1d60ba" kindref="member">ntr</ref>)</type>
        <definition>type(vardesc), dimension(ntr) user_tracer_example::user_tracer_example_cs::tr_desc</definition>
        <argsstring></argsstring>
        <name>tr_desc</name>
        <briefdescription>
<para>Descriptions of each of the tracers. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" line="50" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="50" bodyend="50"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>The control structure for the USER_tracer_example module. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="9">
        <label>real</label>
      </node>
      <node id="6">
        <label>vardesc</label>
      </node>
      <node id="2">
        <label>logical</label>
      </node>
      <node id="3">
        <label>time_type</label>
      </node>
      <node id="1">
        <label>user_tracer_example::user_tracer_example_cs</label>
        <link refid="structuser__tracer__example_1_1user__tracer__example__cs"/>
        <childnode refid="2" relation="usage">
          <edgelabel>use_sponge</edgelabel>
          <edgelabel>coupled_tracers</edgelabel>
        </childnode>
        <childnode refid="3" relation="usage">
          <edgelabel>time</edgelabel>
        </childnode>
        <childnode refid="4" relation="usage">
          <edgelabel>tr_reg</edgelabel>
        </childnode>
        <childnode refid="5" relation="usage">
          <edgelabel>tracer_ic_file</edgelabel>
        </childnode>
        <childnode refid="6" relation="usage">
          <edgelabel>tr_desc</edgelabel>
        </childnode>
        <childnode refid="7" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="8" relation="usage">
          <edgelabel>ind_tr</edgelabel>
        </childnode>
        <childnode refid="9" relation="usage">
          <edgelabel>land_val</edgelabel>
          <edgelabel>tr</edgelabel>
        </childnode>
      </node>
      <node id="7">
        <label>diag_ctrl</label>
      </node>
      <node id="8">
        <label>integer</label>
      </node>
      <node id="5">
        <label>character(len=200)</label>
      </node>
      <node id="4">
        <label>tracer_registry_type</label>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" line="35" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/tracer_example.F90" bodystart="35" bodyend="51"/>
    <listofallmembers>
      <member refid="structuser__tracer__example_1_1user__tracer__example__cs_1a9cb262a8f72e84efda51f1f86a59763c" prot="public" virt="non-virtual"><scope>user_tracer_example::user_tracer_example_cs</scope><name>coupled_tracers</name></member>
      <member refid="structuser__tracer__example_1_1user__tracer__example__cs_1acdb68f3369f13ff37fa4540d1a9d4715" prot="public" virt="non-virtual"><scope>user_tracer_example::user_tracer_example_cs</scope><name>diag</name></member>
      <member refid="structuser__tracer__example_1_1user__tracer__example__cs_1a5aa6c232e667785a514be92ec4bf92d9" prot="public" virt="non-virtual"><scope>user_tracer_example::user_tracer_example_cs</scope><name>ind_tr</name></member>
      <member refid="structuser__tracer__example_1_1user__tracer__example__cs_1acd32ce5ccfe66456c42dc31188967d64" prot="public" virt="non-virtual"><scope>user_tracer_example::user_tracer_example_cs</scope><name>land_val</name></member>
      <member refid="structuser__tracer__example_1_1user__tracer__example__cs_1af8e1d085becdddfc57d6eb01344f66c4" prot="public" virt="non-virtual"><scope>user_tracer_example::user_tracer_example_cs</scope><name>time</name></member>
      <member refid="structuser__tracer__example_1_1user__tracer__example__cs_1aac497db3d9d6284ab78744ecb64b44e6" prot="public" virt="non-virtual"><scope>user_tracer_example::user_tracer_example_cs</scope><name>tr</name></member>
      <member refid="structuser__tracer__example_1_1user__tracer__example__cs_1acd5be51cf2e5ab30c95004cb200f5dee" prot="public" virt="non-virtual"><scope>user_tracer_example::user_tracer_example_cs</scope><name>tr_desc</name></member>
      <member refid="structuser__tracer__example_1_1user__tracer__example__cs_1a0bb9f992287f873b11eba0e72db4f6c6" prot="public" virt="non-virtual"><scope>user_tracer_example::user_tracer_example_cs</scope><name>tr_reg</name></member>
      <member refid="structuser__tracer__example_1_1user__tracer__example__cs_1a9e299627465d85c69c00b63f636e151c" prot="public" virt="non-virtual"><scope>user_tracer_example::user_tracer_example_cs</scope><name>tracer_ic_file</name></member>
      <member refid="structuser__tracer__example_1_1user__tracer__example__cs_1a396f072e44f49536faf1ab0aed125762" prot="public" virt="non-virtual"><scope>user_tracer_example::user_tracer_example_cs</scope><name>use_sponge</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
