FLASH4.5 API

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

TABLE OF CONTENTS


[Functions] source/physics/Eos/Eos_getParameters

[top][index]

NAME

  Eos_getParameters

SYNOPSIS

  call Eos_getParameters(OPTIONAL,real(OUT)    :: eintSwitch,
                         OPTIONAL,logical(OUT) :: inputsAreUnchanged,
                         OPTIONAL,logical(OUT) :: inputTempIsGuess,
                         OPTIONAL,logical(OUT) :: constantGammaC,
                         OPTIONAL,logical(OUT) :: inputMassFracNeeded,
                         OPTIONAL,real(OUT)    :: smalle,
                         OPTIONAL,real(OUT)    :: smallE1,
                         OPTIONAL,real(OUT)    :: smallE2,
                         OPTIONAL,real(OUT)    :: smallE3)

DESCRIPTION

  Return information about the Eos implementation that may be of interest
  to other units.

ARGUMENTS

   eintSwitch -          value of the Eos unit's eintSwitch runtime parameter.
   inputsAreUnchanged -  Indicates whether calls to Eos (or Eos_wrapped, etc.) can result
                         in modification of some state variables that should be, strictly
                         speaking, input only to the EOS in the given mode.
                         If this is true, then calls to Eos with MODE_DENS_PRES can modify
                         the pressure, and calls with MODE_DENS_EI can modify enery variables.
   inputTempIsGuess -    Indicates whether the Eos implementation uses the temperature
                         provided on entry to a call as in initial gues in an iterative scheme.
   constantGammaC -      Indicates whether the gamc returned by Eos will always be constant.
   inputMassFracNeeded - Indicates whether the Eos implementation makes use of mass fractions.
   smalle -              value of the Eos unit's smallE runtime parameter.
   smallE1,smallE2,smallE3 - values of lower bounds for temperature components in multiTemp 
                         implementations.

EXAMPLE

     use Eos_interface, ONLY:  Eos_getParameters
     logical :: inputUnchanged, needTempInput
     ...     
     call Eos_getParameters(inputsAreUnchanged=inputUnchanged,inputTempIsGuess=needTempInput)

NOTES

  This interface assumes that Eos initialization has already taken place when
  Eos_getParameters is called.

  Since this interface uses optional arguments, all routines calling this routine must include
  a use Eos_interface statement, possibly with "ONLY" attribute listing Eos_getParameters
  explicitly, e.g.
      use Eos_interface, ONLY:  Eos_getParameters