<?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.18">
  <compounddef id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs" kind="type" language="Fortran" prot="public">
    <compoundname>boundary_impulse_tracer::boundary_impulse_tracer_cs</compoundname>
      <sectiondef kind="public-attrib">
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1afd67940920321b4446f0940907abee97" prot="public" static="no" mutable="no">
        <type>integer</type>
        <definition>integer boundary_impulse_tracer::boundary_impulse_tracer_cs::ntr</definition>
        <argsstring></argsstring>
        <name>ntr</name>
        <initializer>=NTR_MAX</initializer>
        <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/boundary_impulse_tracer.F90" line="41" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="41" bodyend="41"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a0b05ea70e3cda8cb941da47ff1de4eaa" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical boundary_impulse_tracer::boundary_impulse_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/boundary_impulse_tracer.F90" line="42" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="42" bodyend="42"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1aab0256bbba02275fce781f999278a82a" prot="public" static="no" mutable="no">
        <type>type(time_type), pointer</type>
        <definition>type(time_type), pointer boundary_impulse_tracer::boundary_impulse_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/boundary_impulse_tracer.F90" line="43" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="43" bodyend="43"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1ab7d1e67277a417d6b4c7fc5d11446515" prot="public" static="no" mutable="no">
        <type>type(tracer_registry_type), pointer</type>
        <definition>type(tracer_registry_type), pointer boundary_impulse_tracer::boundary_impulse_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/boundary_impulse_tracer.F90" line="44" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="44" bodyend="44"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a7b57ff617633f1e082631eb4cb9e2f17" prot="public" static="no" mutable="no">
        <type>real, dimension(:,:,:,:), pointer</type>
        <definition>real, dimension(:,:,:,:), pointer boundary_impulse_tracer::boundary_impulse_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/boundary_impulse_tracer.F90" line="45" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="45" bodyend="45"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1afe63ef5dc9a995166299d487cbb46de3" prot="public" static="no" mutable="no">
        <type>logical</type>
        <definition>logical boundary_impulse_tracer::boundary_impulse_tracer_cs::tracers_may_reinit</definition>
        <argsstring></argsstring>
        <name>tracers_may_reinit</name>
        <briefdescription>
<para>If true, boundary_impulse can be initialized if not found in restart file. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" line="46" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="46" bodyend="46"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1ae5f5d262c486290faf9e67db8a5671ea" prot="public" static="no" mutable="no">
        <type>integer, dimension(<ref refid="namespaceboundary__impulse__tracer_1ac5642b1edb9e4ada26fb0741e77bf0b8" kindref="member">ntr_max</ref>)</type>
        <definition>integer, dimension(ntr_max) boundary_impulse_tracer::boundary_impulse_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/boundary_impulse_tracer.F90" line="47" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="47" bodyend="47"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1af7451dd47b0284b54117b06452dd545f" prot="public" static="no" mutable="no">
        <type>integer</type>
        <definition>integer boundary_impulse_tracer::boundary_impulse_tracer_cs::nkml</definition>
        <argsstring></argsstring>
        <name>nkml</name>
        <briefdescription>
<para>Number of layers in mixed layer. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" line="50" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="50" bodyend="50"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a798f52307c4e6d65450fad7b5778b34d" prot="public" static="no" mutable="no">
        <type>real, dimension(<ref refid="namespaceboundary__impulse__tracer_1ac5642b1edb9e4ada26fb0741e77bf0b8" kindref="member">ntr_max</ref>)</type>
        <definition>real, dimension(ntr_max) boundary_impulse_tracer::boundary_impulse_tracer_cs::land_val</definition>
        <argsstring></argsstring>
        <name>land_val</name>
        <initializer>= -1.0</initializer>
        <briefdescription>
<para>A value to use to fill in tracers over land. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" line="51" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="51" bodyend="51"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1abcc79d6eca2b257ca4e92a989637e63c" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real boundary_impulse_tracer::boundary_impulse_tracer_cs::kw_eff</definition>
        <argsstring></argsstring>
        <name>kw_eff</name>
        <briefdescription>
<para>An effective piston velocity used to flux tracer out at the surface. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" line="52" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="52" bodyend="52"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1ac226fdafc173e7f5deb6760bb584143e" prot="public" static="no" mutable="no">
        <type>real</type>
        <definition>real boundary_impulse_tracer::boundary_impulse_tracer_cs::remaining_source_time</definition>
        <argsstring></argsstring>
        <name>remaining_source_time</name>
        <briefdescription>
<para>How much longer (same units as the timestep) to inject the tracer at the surface [s]. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" line="53" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="53" bodyend="53"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a5244fa909213cc1380e9f4e18a3c9009" prot="public" static="no" mutable="no">
        <type>type(diag_ctrl), pointer</type>
        <definition>type(diag_ctrl), pointer boundary_impulse_tracer::boundary_impulse_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/boundary_impulse_tracer.F90" line="56" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="56" bodyend="56"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a93c4f121291de954074ae39fc59be8d1" prot="public" static="no" mutable="no">
        <type>type(mom_restart_cs), pointer</type>
        <definition>type(mom_restart_cs), pointer boundary_impulse_tracer::boundary_impulse_tracer_cs::restart_csp</definition>
        <argsstring></argsstring>
        <name>restart_csp</name>
        <initializer>=&gt; NULL()</initializer>
        <briefdescription>
<para>A pointer to the retart control structure. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" line="58" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="58" bodyend="58"/>
      </memberdef>
      <memberdef kind="variable" id="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a9e6e86e6b52fced193032c12b5eee0f7" prot="public" static="no" mutable="no">
        <type>type(vardesc), dimension(<ref refid="namespaceboundary__impulse__tracer_1ac5642b1edb9e4ada26fb0741e77bf0b8" kindref="member">ntr_max</ref>)</type>
        <definition>type(vardesc), dimension(ntr_max) boundary_impulse_tracer::boundary_impulse_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/boundary_impulse_tracer.F90" line="60" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="60" bodyend="60"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>The control structure for the boundary impulse tracer package. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <collaborationgraph>
      <node id="8">
        <label>real</label>
      </node>
      <node id="5">
        <label>vardesc</label>
      </node>
      <node id="2">
        <label>logical</label>
      </node>
      <node id="3">
        <label>time_type</label>
      </node>
      <node id="1">
        <label>boundary_impulse_tracer::boundary_impulse_tracer_cs</label>
        <link refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs"/>
        <childnode refid="2" relation="usage">
          <edgelabel>coupled_tracers</edgelabel>
          <edgelabel>tracers_may_reinit</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>tr_desc</edgelabel>
        </childnode>
        <childnode refid="6" relation="usage">
          <edgelabel>restart_csp</edgelabel>
        </childnode>
        <childnode refid="7" relation="usage">
          <edgelabel>diag</edgelabel>
        </childnode>
        <childnode refid="8" relation="usage">
          <edgelabel>kw_eff</edgelabel>
          <edgelabel>land_val</edgelabel>
          <edgelabel>tr</edgelabel>
          <edgelabel>remaining_source_time</edgelabel>
        </childnode>
        <childnode refid="9" relation="usage">
          <edgelabel>ntr</edgelabel>
          <edgelabel>nkml</edgelabel>
          <edgelabel>ind_tr</edgelabel>
        </childnode>
      </node>
      <node id="7">
        <label>diag_ctrl</label>
      </node>
      <node id="9">
        <label>integer</label>
      </node>
      <node id="6">
        <label>type(mom_restart_cs), pointer</label>
      </node>
      <node id="4">
        <label>tracer_registry_type</label>
      </node>
    </collaborationgraph>
    <location file="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" line="40" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/tracer/boundary_impulse_tracer.F90" bodystart="40" bodyend="61"/>
    <listofallmembers>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a0b05ea70e3cda8cb941da47ff1de4eaa" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>coupled_tracers</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a5244fa909213cc1380e9f4e18a3c9009" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>diag</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1ae5f5d262c486290faf9e67db8a5671ea" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>ind_tr</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1abcc79d6eca2b257ca4e92a989637e63c" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>kw_eff</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a798f52307c4e6d65450fad7b5778b34d" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>land_val</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1af7451dd47b0284b54117b06452dd545f" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>nkml</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1afd67940920321b4446f0940907abee97" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>ntr</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1ac226fdafc173e7f5deb6760bb584143e" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>remaining_source_time</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a93c4f121291de954074ae39fc59be8d1" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>restart_csp</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1aab0256bbba02275fce781f999278a82a" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>time</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a7b57ff617633f1e082631eb4cb9e2f17" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>tr</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1a9e6e86e6b52fced193032c12b5eee0f7" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>tr_desc</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1ab7d1e67277a417d6b4c7fc5d11446515" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>tr_reg</name></member>
      <member refid="structboundary__impulse__tracer_1_1boundary__impulse__tracer__cs_1afe63ef5dc9a995166299d487cbb46de3" prot="public" virt="non-virtual"><scope>boundary_impulse_tracer::boundary_impulse_tracer_cs</scope><name>tracers_may_reinit</name></member>
    </listofallmembers>
  </compounddef>
</doxygen>
