<?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.16">
  <compounddef id="namespacemom__tracer__initialization__from__z" kind="namespace" language="Fortran">
    <compoundname>mom_tracer_initialization_from_z</compoundname>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacemom__tracer__initialization__from__z_1a01747092117d7076ec9a97368b0fdccf" prot="private" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=40)</type>
        <definition>character(len=40) mom_tracer_initialization_from_z::mdl</definition>
        <argsstring></argsstring>
        <name>mdl</name>
        <initializer>= &quot;MOM_tracer_initialization_from_Z&quot;</initializer>
        <briefdescription>
<para>This module&apos;s name. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/initialization/MOM_tracer_initialization_from_Z.F90" line="41" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/initialization/MOM_tracer_initialization_from_Z.F90" bodystart="41" bodyend="41"/>
        <referencedby refid="namespacemom__tracer__initialization__from__z_1ad1570db6534aa3b22bdc5dffef561458" compoundref="MOM__tracer__initialization__from__Z_8F90" startline="49" endline="203">mom_initialize_tracer_from_z</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacemom__tracer__initialization__from__z_1ad1570db6534aa3b22bdc5dffef561458" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public mom_tracer_initialization_from_z::mom_initialize_tracer_from_z</definition>
        <argsstring>(h, tr, G, GV, US, PF, src_file, src_var_nam, src_var_unit_conversion, src_var_record, homogenize, useALEremapping, remappingScheme, src_var_gridspec)</argsstring>
        <name>mom_initialize_tracer_from_z</name>
        <param>
          <type>h</type>
          <defname>h</defname>
        </param>
        <param>
          <type>tr</type>
          <defname>tr</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>PF</type>
          <defname>PF</defname>
        </param>
        <param>
          <type>src_file</type>
          <defname>src_file</defname>
        </param>
        <param>
          <type>src_var_nam</type>
          <defname>src_var_nam</defname>
        </param>
        <param>
          <type>src_var_unit_conversion</type>
          <defname>src_var_unit_conversion</defname>
        </param>
        <param>
          <type>src_var_record</type>
          <defname>src_var_record</defname>
        </param>
        <param>
          <type>homogenize</type>
          <defname>homogenize</defname>
        </param>
        <param>
          <type>useALEremapping</type>
          <defname>useALEremapping</defname>
        </param>
        <param>
          <type>remappingScheme</type>
          <defname>remappingScheme</defname>
        </param>
        <param>
          <type>src_var_gridspec</type>
          <defname>src_var_gridspec</defname>
        </param>
        <briefdescription>
<para>Initializes a tracer from a z-space data file. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean grid structure. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">gv</parametername>
</parameternamelist>
<parameterdescription>
<para>Ocean 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">h</parametername>
</parameternamelist>
<parameterdescription>
<para>Layer thickness [H ~&gt; m or kg m-2]. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>tr</parametername>
</parameternamelist>
<parameterdescription>
<para>Pointer to array to be initialized </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">pf</parametername>
</parameternamelist>
<parameterdescription>
<para>parameter file </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">src_file</parametername>
</parameternamelist>
<parameterdescription>
<para>source filename </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">src_var_nam</parametername>
</parameternamelist>
<parameterdescription>
<para>variable name in file </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">src_var_unit_conversion</parametername>
</parameternamelist>
<parameterdescription>
<para>optional multiplicative unit conversion </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">src_var_record</parametername>
</parameternamelist>
<parameterdescription>
<para>record to read for multiple time-level files </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">homogenize</parametername>
</parameternamelist>
<parameterdescription>
<para>optionally homogenize to mean value </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">usealeremapping</parametername>
</parameternamelist>
<parameterdescription>
<para>to remap or not (optional) </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">remappingscheme</parametername>
</parameternamelist>
<parameterdescription>
<para>remapping scheme to use. </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">src_var_gridspec</parametername>
</parameternamelist>
<parameterdescription>
<para>Source variable name in a gridspec file. This is not implemented yet. </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/initialization/MOM_tracer_initialization_from_Z.F90" line="46" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/initialization/MOM_tracer_initialization_from_Z.F90" bodystart="49" bodyend="203"/>
        <references refid="namespacemom__ale_1a3b5aca0afd3590607919a261b241a185" compoundref="MOM__ALE_8F90" startline="945" endline="1007">mom_ale::ale_remap_scalar</references>
        <references refid="namespacemom__error__handler_1a9cda07a87815f0e5594066162b4345c3" compoundref="MOM__error__handler_8F90" startline="130" endline="146">mom_error_handler::calltree_enter</references>
        <references refid="namespacemom__error__handler_1a88ea67781e2ed9b73ab7eac8ea5e8578" compoundref="MOM__error__handler_8F90" startline="151" endline="156">mom_error_handler::calltree_leave</references>
        <references refid="namespacemom__tracer__initialization__from__z_1a01747092117d7076ec9a97368b0fdccf" compoundref="MOM__tracer__initialization__from__Z_8F90" startline="41" endline="41">mdl</references>
        <references refid="namespacemom__horizontal__regridding_1a2eefabc60ef9735714237dd2094963cd" compoundref="MOM__horizontal__regridding_8F90" startline="62" endline="97">mom_horizontal_regridding::mystats</references>
        <referencedby refid="namespacemom__generic__tracer_1a5a103d836debaf2815b39a3ccb8ae850" compoundref="MOM__generic__tracer_8F90" startline="232" endline="384">mom_generic_tracer::initialize_mom_generic_tracer</referencedby>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Initializes hydrography from z-coordinate climatology files. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/initialization/MOM_tracer_initialization_from_Z.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
