Rocstar  1.0
Rocstar multiphysics simulation application
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
INRT_ModParameters.F90
Go to the documentation of this file.
1 ! *********************************************************************
2 ! * Rocstar Simulation Suite *
3 ! * Copyright@2015, Illinois Rocstar LLC. All rights reserved. *
4 ! * *
5 ! * Illinois Rocstar LLC *
6 ! * Champaign, IL *
7 ! * www.illinoisrocstar.com *
8 ! * sales@illinoisrocstar.com *
9 ! * *
10 ! * License: See LICENSE file in top level of distribution package or *
11 ! * http://opensource.org/licenses/NCSA *
12 ! *********************************************************************
13 ! *********************************************************************
14 ! * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, *
15 ! * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES *
16 ! * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND *
17 ! * NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS OR *
18 ! * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
19 ! * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, *
20 ! * Arising FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE *
21 ! * USE OR OTHER DEALINGS WITH THE SOFTWARE. *
22 ! *********************************************************************
23 !******************************************************************************
24 !
25 ! Purpose: define parameters for interactions
26 !
27 ! Description: none
28 !
29 ! Notes: none
30 !
31 !******************************************************************************
32 !
33 ! $Id: INRT_ModParameters.F90,v 1.12 2008/12/06 08:44:31 mtcampbe Exp $
34 !
35 ! Copyright: (c) 2003 by the University of Illinois
36 !
37 !******************************************************************************
38 
39 MODULE inrt_modparameters
40 
41  IMPLICIT NONE
42 
43 ! Types of Interactions
44 
45  INTEGER, PARAMETER :: INRT_TYPE_DRAG = 1, &
46  INRT_TYPE_HTRANSNB = 2, &
47  INRT_TYPE_SCOURING = 3, &
48  INRT_TYPE_BURNING = 4, &
49  INRT_TYPE_BOILRGN = 5, &
50  INRT_TYPE_TOTAL = 5
51 
52 ! Switches and data
53 
54  INTEGER, PARAMETER :: INRT_SWI_DRAG_MODEL = 1, &
55  INRT_SWI_DRAG_TOTAL = 1, &
56  INRT_DAT_DRAG_TOTAL = 0
57 
58  INTEGER, PARAMETER :: INRT_SWI_HTRANSNB_MODEL = 1, &
59  INRT_SWI_HTRANSNB_TOTAL = 1, &
60  INRT_DAT_HTRANSNB_TOTAL = 0
61 
62  INTEGER, PARAMETER :: INRT_SWI_SCOURING_TOTAL = 0, &
63  INRT_DAT_SCOURING_COEF0 = 0, &
64  INRT_DAT_SCOURING_TOTAL0 = 0 ! TOTAL = this + nPeul
65 
66  INTEGER, PARAMETER :: INRT_SWI_BURNING_MODEL = 1, &
67  INRT_SWI_BURNING_OXUSED = 2, &
68  INRT_SWI_BURNING_VAPOR_METH = 3, &
69  INRT_SWI_BURNING_TOTAL = 3, &
70  INRT_DAT_BURNING_VAPOR_TEMP = 1, &
71  INRT_DAT_BURNING_HEAT_COEF = 2, &
72  INRT_DAT_BURNING_MFRC_PLAG = 3, &
73  INRT_DAT_BURNING_MFRC_PEUL0 = 3, &
74  INRT_DAT_BURNING_TOTAL0 = 3 ! TOTAL = this + nPeul
75 
76  INTEGER, PARAMETER :: INRT_SWI_BOILRGN_MODEL = 1, &
77  INRT_SWI_BOILRGN_LIQIND = 2, &
78  INRT_SWI_BOILRGN_GASIND = 3, &
79  INRT_SWI_BOILRGN_TOTAL = 3, &
80  INRT_DAT_BOILRGN_BOILPT = 1, &
81  INRT_DAT_BOILRGN_ENPMS = 2, &
82  INRT_DAT_BOILRGN_TOTAL = 2
83 
84 ! Values of switches
85 
86  INTEGER, PARAMETER :: &
87  INRT_DRAG_MODEL_STOKES = 1, & ! Stokes drag
88  INRT_DRAG_MODEL_SN = 2, & ! Schiller-Naumann
89  INRT_DRAG_MODEL_SMRFLD = 3, & ! Schiller-Naumann
90  INRT_DRAG_MODEL_DEFAULT = INRT_DRAG_MODEL_SN
91 
92  INTEGER, PARAMETER :: &
93  INRT_HTRANSNB_MODEL_STOKES = 1, & ! Stokes thermal drag
94  INRT_HTRANSNB_MODEL_RM = 2, & ! Ranz-Marshall
95  INRT_HTRANSNB_MODEL_DEFAULT = INRT_HTRANSNB_MODEL_RM
96 
97  INTEGER, PARAMETER :: &
98  INRT_BURNING_MODEL_BECKSTEAD = 1, & ! Beckstead model
99  INRT_BURNING_MODEL_DEFAULT = INRT_BURNING_MODEL_BECKSTEAD
100 
101  INTEGER, PARAMETER :: &
102  INRT_BURNING_VAPOR_METH_NONE = 0, & ! Not used
103  INRT_BURNING_VAPOR_METH_USED = 1 ! Used
104 
105  INTEGER, PARAMETER :: &
106  INRT_BOILRGN_MODEL_SHARP = 1, & ! Sharp cutoff
107  INRT_BOILRGN_MODEL_DEFAULT = INRT_BOILRGN_MODEL_SHARP
108 
109 ! Miscellaneous
110 
111 ! Values of Burning Status for particles
112 
113  INTEGER, PARAMETER :: &
114  INRT_BURNSTAT_OFF = 0, & ! Particle not burning
115  INRT_BURNSTAT_ON = 1 ! Particle burning
116 
117 ! Indices of Edges:
118 !
119 ! G = Gas Node
120 ! L = Lagrangian particle Node
121 ! S = Smoke Node
122 ! X = Internal Node
123 
124  INTEGER, PARAMETER :: INRT_DRAG_L_XMOM_G = 1, &
125  INRT_DRAG_L_YMOM_G = 2, &
126  INRT_DRAG_L_ZMOM_G = 3, &
127  INRT_DRAG_NEDGES = 3
128 
129  INTEGER, PARAMETER :: INRT_HTRANSNB_L_ENER_G = 1, &
130  INRT_HTRANSNB_NEDGES = 1
131 
132 ! no parameters of this type for Scouring:
133 ! -> Edges are created dynamically by matching smoke and particle materials
134 
135  INTEGER, PARAMETER :: INRT_BURNING_G_MASS_X = 1, &
136  INRT_BURNING_L_MASS_X = 2, &
137  INRT_BURNING_S_MASS_X0 = 2, &
138  INRT_BURNING_X_ENER_G = 3, &
139  INRT_BURNING_X_ENER_LV = 4, &
140  INRT_BURNING_X_MASS_G = 5, &
141  INRT_BURNING_X_MASS_L = 6, &
142  INRT_BURNING_X_MASS_S0 = 6, &
143  INRT_BURNING_NEDGES0 = 6
144 
145  INTEGER, PARAMETER :: INRT_BOILRGN_NEDGES = 0
146 
147 !******************************************************************************
148 
149 ! Types of Edges
150 
151  INTEGER, PARAMETER :: INRT_EDGE_BAD = 0, & ! Bad Edge (uninitialized)
152  INRT_EDGE_MASS = 1, & ! Mass Edge
153  INRT_EDGE_MOME = 2, & ! Momentum Edge
154  INRT_EDGE_MOME_DUM = 3, & ! Dummy momentum Edge
155  INRT_EDGE_ENER = 5, & ! Energy Edge
156  INRT_EDGE_MASS_GHO = 6 ! Ghost mass Edge
157 
158 ! Permission levels
159 
160  INTEGER, PARAMETER :: INRT_PERM_BAD = -1, & ! Bad value (uninitialized)
161  INRT_PERM_BLOCK = 0, & ! Block
162  INRT_PERM_PMASS = 1, & ! Permit Mass
163  INRT_PERM_PMOME = 2, & ! Permit Mass and Momentum
164  INRT_PERM_PALL = 3 ! Permit All
165 
166 ! Activeness (everything less than INRT_ACT_ACTIVE is passive)
167 
168  INTEGER, PARAMETER :: INRT_ACT_BAD = 2, & ! Bad value (uninitialized)
169  INRT_ACT_ACTIVE = 1 ! Node is active
170 
171 END MODULE inrt_modparameters
172 
173 !******************************************************************************
174 !
175 ! RCS Revision history:
176 !
177 ! $Log: INRT_ModParameters.F90,v $
178 ! Revision 1.12 2008/12/06 08:44:31 mtcampbe
179 ! Updated license.
180 !
181 ! Revision 1.11 2008/11/19 22:17:44 mtcampbe
182 ! Added Illinois Open Source License/Copyright
183 !
184 ! Revision 1.10 2007/03/07 22:17:23 fnajjar
185 ! Added Sommerfeld drag law in the parameter list
186 !
187 ! Revision 1.9 2004/07/28 15:42:12 jferry
188 ! deleted defunct constructs: useDetangle, useSmokeDrag, useSmokeHeatTransfer
189 !
190 ! Revision 1.8 2004/04/15 16:04:21 jferry
191 ! minor formatting (removed trailing spaces)
192 !
193 ! Revision 1.7 2004/03/02 21:47:29 jferry
194 ! Added After Update interactions
195 !
196 ! Revision 1.6 2003/09/25 15:48:43 jferry
197 ! implemented Boiling Regulation interaction
198 !
199 ! Revision 1.5 2003/09/19 20:35:26 jferry
200 ! Implemented oxidizer species for burning interaction
201 !
202 ! Revision 1.4 2003/04/02 22:32:03 jferry
203 ! codified Activeness and Permission structures for rocinteract
204 !
205 ! Revision 1.3 2003/03/24 23:30:52 jferry
206 ! overhauled rocinteract to allow interaction design to use user input
207 !
208 ! Revision 1.2 2003/03/11 16:09:39 jferry
209 ! Added comments
210 !
211 ! Revision 1.1 2003/03/04 22:12:35 jferry
212 ! Initial import of Rocinteract
213 !
214 !******************************************************************************
215 
216 
217 
218 
219 
220 
inrt_modparameters
Definition: INRT_ModParameters.F90:39