<?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="namespacescm__cvmix__tests" kind="namespace" language="Fortran">
    <compoundname>scm_cvmix_tests</compoundname>
    <innerclass refid="structscm__cvmix__tests_1_1scm__cvmix__tests__cs" prot="private">scm_cvmix_tests::scm_cvmix_tests_cs</innerclass>
      <sectiondef kind="var">
      <memberdef kind="variable" id="namespacescm__cvmix__tests_1ae2f4e4f6283825ec24dd56858a6d58d9" prot="private" static="no" mutable="no">
        <type><ref refid="version__variable_8h_1acda997fe1761de4c6bca0f27dc786964" kindref="member">character</ref>(len=40)</type>
        <definition>character(len=40) scm_cvmix_tests::mdl</definition>
        <argsstring></argsstring>
        <name>mdl</name>
        <initializer>= &quot;SCM_CVMix_tests&quot;</initializer>
        <briefdescription>
<para>This module&apos;s name. </para>
        </briefdescription>
        <detaileddescription>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/SCM_CVMix_tests.F90" line="50" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/SCM_CVMix_tests.F90" bodystart="50" bodyend="50"/>
        <referencedby refid="namespacescm__cvmix__tests_1a28ab898c50fc4e959d40a62c08d81693" compoundref="SCM__CVMix__tests_8F90" startline="129" endline="200">scm_cvmix_tests_surface_forcing_init</referencedby>
        <referencedby refid="namespacescm__cvmix__tests_1ab4cadfaab1d9da76d9777d190040c93f" compoundref="SCM__CVMix__tests_8F90" startline="56" endline="124">scm_cvmix_tests_ts_init</referencedby>
      </memberdef>
      </sectiondef>
      <sectiondef kind="func">
      <memberdef kind="function" id="namespacescm__cvmix__tests_1ab4cadfaab1d9da76d9777d190040c93f" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public scm_cvmix_tests::scm_cvmix_tests_ts_init</definition>
        <argsstring>(T, S, h, G, GV, US, param_file, just_read_params)</argsstring>
        <name>scm_cvmix_tests_ts_init</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>Initializes temperature and salinity for the SCM CVMix test example. </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>Vertical grid structure </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 [psu] </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 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>Input parameter structure </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/SCM_CVMix_tests.F90" line="55" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/SCM_CVMix_tests.F90" bodystart="56" bodyend="124"/>
        <references refid="namespacescm__cvmix__tests_1ae2f4e4f6283825ec24dd56858a6d58d9" compoundref="SCM__CVMix__tests_8F90" startline="50" endline="50">mdl</references>
        <referencedby refid="namespacemom__state__initialization_1a81503d4f1855cb185f122d6314e4f06c" compoundref="MOM__state__initialization_8F90" startline="117" endline="615">mom_state_initialization::mom_initialize_state</referencedby>
      </memberdef>
      <memberdef kind="function" id="namespacescm__cvmix__tests_1a28ab898c50fc4e959d40a62c08d81693" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public scm_cvmix_tests::scm_cvmix_tests_surface_forcing_init</definition>
        <argsstring>(Time, G, param_file, CS)</argsstring>
        <name>scm_cvmix_tests_surface_forcing_init</name>
        <param>
          <type>Time</type>
          <defname>Time</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>param_file</type>
          <defname>param_file</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
<para>Initializes surface forcing for the CVMix test case suite. </para>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">time</parametername>
</parameternamelist>
<parameterdescription>
<para>Model time </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">g</parametername>
</parameternamelist>
<parameterdescription>
<para>Grid structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">param_file</parametername>
</parameternamelist>
<parameterdescription>
<para>Input parameter structure </para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Parameter container </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/SCM_CVMix_tests.F90" line="128" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/SCM_CVMix_tests.F90" bodystart="129" bodyend="200"/>
        <references refid="namespacescm__cvmix__tests_1ae2f4e4f6283825ec24dd56858a6d58d9" compoundref="SCM__CVMix__tests_8F90" startline="50" endline="50">mdl</references>
        <references refid="namespacemom__error__handler_1a460cfb79a06c29fc249952c2a3710d67" compoundref="MOM__error__handler_8F90" startline="72" endline="92">mom_error_handler::mom_error</references>
      </memberdef>
      <memberdef kind="function" id="namespacescm__cvmix__tests_1aac23f24159bc5eb342bcfe1643e516fd" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public scm_cvmix_tests::scm_cvmix_tests_wind_forcing</definition>
        <argsstring>(sfc_state, forces, day, G, US, CS)</argsstring>
        <name>scm_cvmix_tests_wind_forcing</name>
        <param>
          <type>sfc_state</type>
          <defname>sfc_state</defname>
        </param>
        <param>
          <type>forces</type>
          <defname>forces</defname>
        </param>
        <param>
          <type>day</type>
          <defname>day</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">sfc_state</parametername>
</parameternamelist>
<parameterdescription>
<para>Surface state structure</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">forces</parametername>
</parameternamelist>
<parameterdescription>
<para>A structure with the driving mechanical forces</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">day</parametername>
</parameternamelist>
<parameterdescription>
<para>Time in days</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>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>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Container for SCM parameters </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/SCM_CVMix_tests.F90" line="203" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/SCM_CVMix_tests.F90" bodystart="204" bodyend="232"/>
        <references refid="namespacemom__domains_1aa7d2122aa278771209b860dbd6788097" compoundref="MOM__domains_8F90" startline="137" endline="137">mom_domains::to_all</references>
      </memberdef>
      <memberdef kind="function" id="namespacescm__cvmix__tests_1ad04f730fa495a891148e3c6d01f4c680" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
        <type>subroutine, public</type>
        <definition>subroutine, public scm_cvmix_tests::scm_cvmix_tests_buoyancy_forcing</definition>
        <argsstring>(sfc_state, fluxes, day, G, US, CS)</argsstring>
        <name>scm_cvmix_tests_buoyancy_forcing</name>
        <param>
          <type>sfc_state</type>
          <defname>sfc_state</defname>
        </param>
        <param>
          <type>fluxes</type>
          <defname>fluxes</defname>
        </param>
        <param>
          <type>day</type>
          <defname>day</defname>
        </param>
        <param>
          <type>G</type>
          <defname>G</defname>
        </param>
        <param>
          <type>US</type>
          <defname>US</defname>
        </param>
        <param>
          <type>CS</type>
          <defname>CS</defname>
        </param>
        <briefdescription>
        </briefdescription>
        <detaileddescription>
<para><parameterlist kind="param"><parameteritem>
<parameternamelist>
<parametername direction="in">sfc_state</parametername>
</parameternamelist>
<parameterdescription>
<para>Surface state structure</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">fluxes</parametername>
</parameternamelist>
<parameterdescription>
<para>Surface fluxes structure</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="in">day</parametername>
</parameternamelist>
<parameterdescription>
<para>Current model time</para>
</parameterdescription>
</parameteritem>
<parameteritem>
<parameternamelist>
<parametername direction="inout">g</parametername>
</parameternamelist>
<parameterdescription>
<para>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>cs</parametername>
</parameternamelist>
<parameterdescription>
<para>Container for SCM parameters </para>
</parameterdescription>
</parameteritem>
</parameterlist>
</para>
        </detaileddescription>
        <inbodydescription>
        </inbodydescription>
        <location file="/home/cermak/src/MOM6.devrob/src/user/SCM_CVMix_tests.F90" line="236" column="1" bodyfile="/home/cermak/src/MOM6.devrob/src/user/SCM_CVMix_tests.F90" bodystart="237" bodyend="283"/>
      </memberdef>
      </sectiondef>
    <briefdescription>
<para>Initial conditions and forcing for the single column model (SCM) CVMix test set. </para>
    </briefdescription>
    <detaileddescription>
    </detaileddescription>
    <location file="/home/cermak/src/MOM6.devrob/src/user/SCM_CVMix_tests.F90" line="2" column="1"/>
  </compounddef>
</doxygen>
