FLASH4.5 API

Generated from /asc/asci2/site/flashcode/secure/release_4p5/source/physics/Eos/Eos_unitTest.F90 with ROBODoc v4.99.8 on Tue Mar 05 16:16:18 2019

TABLE OF CONTENTS


[Functions] source/physics/Eos/Eos_unitTest

[top][index]

NAME

  Eos_unitTest

SYNOPSIS

  call Eos_unitTest(integer(IN) :: fileUnit,
                    logical(OUT) :: perfect

DESCRIPTION

 This function is the unit test for the Eos unit. It is invoked in
 the setup unitTest/Eos. The Config file for the Eos unit test setup
 requests a few extra variables in the main grid data structure for
 Grid scope temporary storage. The Simulation_initBlock of the Eos
 unit test initializes density in the right place for the DENS_VAR
 variable (see Flash.h for DENS_VAR, TEMP_VAR etc definitions), and
 temperature and pressure in the extra storage space CTMP_VAR
 and CPRS_VAR. The physical quantities at this point are not in
 thermal equilibrium. 

 The Eos_unit test starts by copying the initialized
 temperature into the TEMP_VAR location and calling the
 Eos_wrapped function with eosMode = MODE_DENS_TEMP, where
 density and temperature are given and pressure and energy are
 calculated. Now PRES_VAR and EINT_VAR contain values of pressure
 and internal energy that are in thermal equilibrium, and the pressure values
 are not necessarily what was stored in the extra storage space
 during intialization. 
 
 At this point in time three quantities; temperature,
 pressure and energy are saved in the extra storage requested by
 the unitTest/Eos setup, say OTMP_VAR, OPRS_VAR and OENT_VAR. Now
 the Eos_unitTest function calls Eos_wrapped with eosMode =
 MODE_DENS_PRES, followed by eosMode= MODE_DENS_EI.  If the
 newly calculated values of temperature, pressure and energy are
 the same as those saved in OTMP_VAR, OPRS_VAR and OENT_VAR, then
 we can conclude that the Eos is working in MODE_DENS_PRES and
 MODE_DENS_EI modes. However, we still can't say anything about the
 MODE_DENS_TEMP mode. So we repeat the process by copying CPRS_VAR
 into PRES_VAR and calling Eos_wrapped with MODE_DENS_PRES. We
 again save the calculated values in the extra storage and make two
 more Eos_wrapped calls with the remaining two modes. This time if
 the new and old values of variables compare, we can conclude that
 MODE_DENS_TEMP works too, and hence the unit test is successful.

 A final test calculates the optional derivates by setting the mask
 argument to Eos equal to true.  The values of these arguments are not
 tested in any way.  The unitTest simply makes sure that they can be calculated
 without NaNs or the like.

ARGUMENTS

   fileUnit : unit number for file opened by the unitTest/Eos setup
              in which to write results of the test

   perfect : indicates test ran without error is true.

PARAMETERS

  eintSwitch  a rarely used switch which ensures that internal energy calculations 
        maintain sufficient precision. Important only if energyTotal is dominated 
        by energyKinetic.