<?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.15">
  <compounddef id="namespacebaroclinic__zone__initialization" kind="namespace" language="Fortran">
    <compoundname>baroclinic_zone_initialization</compoundname>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacebaroclinic__zone__initialization_1a28cab2b958411c14f4ae24bc83f8faee" prot="private" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=40)</type>
        <definition>character(len=40) baroclinic_zone_initialization::mdl</definition>
        <argsstring></argsstring>
        <name>mdl</name>
        <initializer>= &quot;baroclinic_zone_initialization&quot;</initializer>
        <briefdescription>
<para>This module&apos;s name. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/baroclinic_zone_initialization.F90" line="18" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/baroclinic_zone_initialization.F90" bodystart="18" bodyend="18"/>
        <referencedby refid="namespacebaroclinic__zone__initialization_1ae61a49364522c0a98058b170932974dc" compoundref="baroclinic__zone__initialization_8F90" startline="32" endline="74">bcz_params</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacebaroclinic__zone__initialization_1ae61a49364522c0a98058b170932974dc" prot="private" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine</type>
        <definition>subroutine baroclinic_zone_initialization::bcz_params</definition>
        <argsstring>(G, GV, US, param_file, S_ref, dSdz, delta_S, dSdx, T_ref, dTdz, delta_T, dTdx, L_zone, just_read_params)</argsstring>
        <name>bcz_params</name>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>S_ref</type>
          <defname>S_ref</defname>
        </param>
        <param>
          <type>dSdz</type>
          <defname>dSdz</defname>
        </param>
        <param>
          <type>delta_S</type>
          <defname>delta_S</defname>
        </param>
        <param>
          <type>dSdx</type>
          <defname>dSdx</defname>
        </param>
        <param>
          <type>T_ref</type>
          <defname>T_ref</defname>
        </param>
        <param>
          <type>dTdz</type>
          <defname>dTdz</defname>
        </param>
        <param>
          <type>delta_T</type>
          <defname>delta_T</defname>
        </param>
        <param>
          <type>dTdx</type>
          <defname>dTdx</defname>
        </param>
        <param>
          <type>L_zone</type>
          <defname>L_zone</defname>
        </param>
        <param>
          <type>just_read_params</type>
          <defname>just_read_params</defname>
        </param>
        <briefdescription>
<para>Reads the parameters unique to this module. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>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">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter file handle </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">s_ref</parametername>
</parameternamelist>
<parameterdescription>
<para>Reference salinity [ppt] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">dsdz</parametername>
</parameternamelist>
<parameterdescription>
<para>Salinity stratification [ppt Z-1 ~&gt; ppt m-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">delta_s</parametername>
</parameternamelist>
<parameterdescription>
<para>Salinity difference across baroclinic zone [ppt] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">dsdx</parametername>
</parameternamelist>
<parameterdescription>
<para>Linear salinity gradient [ppt m-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t_ref</parametername>
</parameternamelist>
<parameterdescription>
<para>Reference temperature [degC] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">dtdz</parametername>
</parameternamelist>
<parameterdescription>
<para>Temperature stratification [degC Z-1 ~&gt; degC m-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">delta_t</parametername>
</parameternamelist>
<parameterdescription>
<para>Temperature difference across baroclinic zone [degC] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">dtdx</parametername>
</parameternamelist>
<parameterdescription>
<para>Linear temperature gradient in [degC Gx_axis_units-1] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">l_zone</parametername>
</parameternamelist>
<parameterdescription>
<para>Width of baroclinic zone in [Gx_axis_units] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">just_read_params</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, this call will only read parameters without changing h. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/baroclinic_zone_initialization.F90" line="30" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/baroclinic_zone_initialization.F90" bodystart="32" bodyend="74"/>
        <references refid="namespacemom__file__parser_1a0d01b9a66f5ac12b657c00f1295351bb" compoundref="MOM__file__parser_8F90" startline="2061" endline="2076">mom_file_parser::closeparameterblock</references>
        <references refid="namespacebaroclinic__zone__initialization_1a28cab2b958411c14f4ae24bc83f8faee" compoundref="baroclinic__zone__initialization_8F90" startline="18" endline="18">mdl</references>
        <references refid="namespacemom__file__parser_1a363628fcd8540de780ebeacf24012229" compoundref="MOM__file__parser_8F90" startline="2043" endline="2056">mom_file_parser::openparameterblock</references>
        <referencedby refid="namespacebaroclinic__zone__initialization_1a00eea273e33b70e67bc8df9a5e2b8793" compoundref="baroclinic__zone__initialization_8F90" startline="80" endline="135">baroclinic_zone_init_temperature_salinity</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacebaroclinic__zone__initialization_1a00eea273e33b70e67bc8df9a5e2b8793" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public baroclinic_zone_initialization::baroclinic_zone_init_temperature_salinity</definition>
        <argsstring>(T, S, h, G, GV, US, param_file, just_read_params)</argsstring>
        <name>baroclinic_zone_init_temperature_salinity</name>
        <param>
          <type>T</type>
          <defname>T</defname>
        </param>
        <param>
          <type>S</type>
          <defname>S</defname>
        </param>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>GV</type>
          <defname>GV</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>just_read_params</type>
          <defname>just_read_params</defname>
        </param>
        <briefdescription>
<para>Initialization of temperature and salinity with the baroclinic zone initial conditions. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>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">us</parametername>
</parameternamelist>
<parameterdescription>
<para>A dimensional unit scaling type </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">t</parametername>
</parameternamelist>
<parameterdescription>
<para>Potential temperature [degC] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="out">s</parametername>
</parameternamelist>
<parameterdescription>
<para>Salinity [ppt] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">h</parametername>
</parameternamelist>
<parameterdescription>
<para>The model thicknesses [H ~&gt; m or kg m-2] </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter file handle </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">just_read_params</parametername>
</parameternamelist>
<parameterdescription>
<para>If present and true, this call will only read parameters without changing T &amp; S. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/baroclinic_zone_initialization.F90" line="78" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/baroclinic_zone_initialization.F90" bodystart="80" bodyend="135"/>
        <references refid="namespacebaroclinic__zone__initialization_1ae61a49364522c0a98058b170932974dc" compoundref="baroclinic__zone__initialization_8F90" startline="32" endline="74">bcz_params</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>Initial conditions for an idealized baroclinic zone. </para>
    </briefdescription>
    <detaileddescription>
<sect1 id="namespacebaroclinic__zone__initialization_1section_baroclinic_zone">
<title>Description of the baroclinic zone initial conditions</title>
<para>yada yada yada </para>
</sect1>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/baroclinic_zone_initialization.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
