FLASH-X
Doxygen Generated Documentation From Interface Source Code
Eos.h
Go to the documentation of this file.
1#if 0
2This file contains the indices of the various variables used in
3the EOS routines. The first seven indices (EOS_VARS) are basic properties
4whereas the last eleven indices (EOS_VARS+1 to EOS_NUM) represent derived
5or optionally calculated quantities.
6
7The derived variables are used in the mask required by Eos.F90, and
8values for them are returned by Eos in the array eosData when the
9corresponding mask element is true.
10
11NOTE1 -- originally both EOS_ENER and EOS_EINT were included here.
12EOS_ENER was the variable (mostly) used internally, and EOS_EINT was basically
13 ignored. This was very confusing, as the EOS routines work with internal
14 entergy, which corresponds to EINT_VAR in the unk array. Hence, on
157/20/2006 LBR removed all references to EOS_ENER by changing them to EOS_EINT.
16
17NOTE2 -- the equivalent Flash2 variable is given in [brackets] after the
18 description below
19
20quantity EOS_VARS 9
21quantity EOS_DERIVS 13
22quantity EOS_NUM 22
23
24NOTE3a -- kinetic energy EKIN is not actually used by any Eos implementation,
25but a place for it reserved among the "basic" variables so that an Eos-wrapping
26function can conveniently store the kinetic energy derived from grid
27datastructure variables across Eos() calls.
28
29basic EOS_PRES Pressure [p]
30basic EOS_DENS Density [rho]
31basic EOS_TEMP Temperature [temp]
32basic EOS_GAMC Adiabatic index, the Gamma1 of Chandrasekhar [gamc]
33basic EOS_EINT Total internal energy (equivalent to EINT_VAR) [ei]
34basic EOS_ABAR Average mass of the nuclei
35basic EOS_ZBAR Average proton number
36basic EOS_ENTR Entropy
37basic EOS_EKIN used to hold kinetic energy for internal Eos use
38derived EOS_DPT Derivative of pressure wrt temperature
39derived EOS_DPD Derivative of pressure wrt density
40derived EOS_DET Derivative of internal energy wrt temperature
41derived EOS_DEA Derivative of internal energy wrt atomic mass
42derived EOS_DEZ Derivative of internal energy wrt atomic number/charge
43derived EOS_DED Derivative of internal energy wrt density
44derived EOS_DST Derivative of entropy wrt temperature
45derived EOS_DSD Derivative of entropy wrt density
46derived EOS_CV Specific heat at constant volume
47derived EOS_CP Specific heat at constant pressure
48derived EOS_PEL Electron pressure
49derived EOS_NE Electron number density
50derived EOS_ETA Electron degeneracy parameter (chemical potential / k_b*T)
51
52#endif
53
54#define EOS_BEGIN 1
55#define EOS_VARS 9
56#define EOS_DERIVS 13
57#define EOS_NUM 22
58#define EOS_PRES 1
59#define EOS_DENS 2
60#define EOS_EINT 3
61#define EOS_TEMP 4
62#define EOS_GAMC 5
63#define EOS_ABAR 6
64#define EOS_ZBAR 7
65#define EOS_ENTR 8
66#define EOS_EKIN 9
67
68
69#define EOS_DPT 10
70#define EOS_DPD 11
71#define EOS_DET 12
72#define EOS_DED 13
73#define EOS_DEA 14
74#define EOS_DEZ 15
75#define EOS_DST 16
76#define EOS_DSD 17
77#define EOS_CV 18
78#define EOS_CP 19
79#define EOS_PEL 20
80#define EOS_NE 21
81#define EOS_ETA 22
82
83
84#define N_EOS_TEMP 1
85
86#if 0
87 This section defines the constants to identify different equations
88 of states that are included in the distribution.
89 The "USER" types can be used for user-defined specialized implementations.
90#endif
91
92#define EOS_GAM 321
93#define EOS_HLM 452
94#define EOS_MGAM 645
95#define EOS_MTMP 325
96#define EOS_TAB 624
97#define EOS_NUC 787
98#define EOS_STAR 989
99#define EOS_WL 128
100
101#define EOS_USERTYPE1 1001
102#define EOS_USERTYPE2 1002
103
104
105#define EOS_TABULAR_Z 1
106#define EOS_TABULAR_E 2
107#define EOS_TABULAR_C 3
108#define EOS_TABULAR_P 4
109#define EOS_APPROX_KIN 40
110
111
112#define EOS_LOGLEVEL_WARN_ANY 100
113#define EOS_LOGLEVEL_WARN_DATA 300
114#define EOS_LOGLEVEL_WARN_ALLPROCS 430
115#define EOS_LOGLEVEL_INFO_DATA 450
116#define EOS_LOGLEVEL_INFO_ALLPROCS 900
117#define EOS_LOGLEVEL_INFO_ALL 1000
subroutine Eos(mode, vecLen, eosData, massFrac, mask, vecBegin, vecEnd, diagFlag)
Definition: Eos.F90:93
#define EOS_ZBAR
Definition: Eos.h:64
#define EOS_GAMC
Definition: Eos.h:62
#define EOS_NE
Definition: Eos.h:80
#define EOS_ETA
Definition: Eos.h:81
#define EOS_DED
Definition: Eos.h:72
#define EOS_CV
Definition: Eos.h:77
#define EOS_EKIN
Definition: Eos.h:66
#define EOS_ENTR
Definition: Eos.h:65
#define EOS_ABAR
Definition: Eos.h:63
#define EOS_DERIVS
Definition: Eos.h:56
#define EOS_TEMP
Definition: Eos.h:61
#define EOS_DST
Definition: Eos.h:75
#define EOS_DEA
Definition: Eos.h:73
#define EOS_EINT
Definition: Eos.h:60
#define EOS_CP
Definition: Eos.h:78
#define EOS_DEZ
Definition: Eos.h:74
#define EOS_DENS
Definition: Eos.h:59
#define EOS_DPD
Definition: Eos.h:70
#define EOS_DSD
Definition: Eos.h:76
#define EOS_PRES
Definition: Eos.h:58
#define EOS_NUM
Definition: Eos.h:57
#define EOS_PEL
Definition: Eos.h:79
#define EOS_DPT
Definition: Eos.h:69
#define EOS_VARS
Definition: Eos.h:55
#define EOS_DET
Definition: Eos.h:71