Chi-Tech
prk__TransientSolver.h
Go to the documentation of this file.
1/** \defgroup prk__TransientSolver prk.TransientSolver
2
3
4\ingroup prk
5
6
7
8## Example usage:
9Create this object:
10\code
11params =
12{
13 param_name1 = value1,
14 param_name2 = value2,
15 --etc.
16}
17prk.TransientSolver.Create(params)
18\endcode
19## Optional Input parameters
20\htmlonly
21
22<div style="display: block;">
23<button type="button" class="droppy2" style=
24"
25background-color: #edf0f5;
26color: #9373A5;
27cursor: pointer;
28border: none;
29text-align: left;
30outline: none;
31font-size: 15px;
32margin: 2px 2px;
33border: 2px solid #687372;
34display: block;
35width: 100%;
36vertical-align: middle;
37padding-top: 4px;
38padding-bottom: 0px;
39"
40><span class="arrow" style="padding-left: 0px;">►</span><TT><B>dt</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspDesired initial timestep size</span></button>
41<div class="content" style="display: none;">
42 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Desired initial timestep size.
43</p>
44 <p>Default value: <TT style="color:grey">0.01(double)</TT></p>
45 <p>Allowable values: <TT>>= 1e-12(double)</TT></p>
46</div>
47
48<button type="button" class="droppy2" style=
49"
50background-color: #edf0f5;
51color: #9373A5;
52cursor: pointer;
53border: none;
54text-align: left;
55outline: none;
56font-size: 15px;
57margin: 2px 2px;
58border: 2px solid #687372;
59display: block;
60width: 100%;
61vertical-align: middle;
62padding-top: 4px;
63padding-bottom: 0px;
64"
65><span class="arrow" style="padding-left: 0px;">►</span><TT><B>end_time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTransient end-time if applicable</span></button>
66<div class="content" style="display: none;">
67 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Transient end-time if applicable.
68</p>
69 <p>Default value: <TT style="color:grey">1(double)</TT></p>
70</div>
71
72<button type="button" class="droppy2" style=
73"
74background-color: #edf0f5;
75color: #9373A5;
76cursor: pointer;
77border: none;
78text-align: left;
79outline: none;
80font-size: 15px;
81margin: 2px 2px;
82border: 2px solid #687372;
83display: block;
84width: 100%;
85vertical-align: middle;
86padding-top: 4px;
87padding-bottom: 0px;
88"
89><span class="arrow" style="padding-left: 0px;">►</span><TT><B>gen_time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspNeutron generation time [s]</span></button>
90<div class="content" style="display: none;">
91 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Neutron generation time [s]
92</p>
93 <p>Default value: <TT style="color:grey">1e-05(double)</TT></p>
94 <p>Allowable values: <TT>>= 1e-12(double)</TT></p>
95</div>
96
97<button type="button" class="droppy2" style=
98"
99background-color: #edf0f5;
100color: #9373A5;
101cursor: pointer;
102border: none;
103text-align: left;
104outline: none;
105font-size: 15px;
106margin: 2px 2px;
107border: 2px solid #687372;
108display: block;
109width: 100%;
110vertical-align: middle;
111padding-top: 4px;
112padding-bottom: 0px;
113"
114><span class="arrow" style="padding-left: 0px;">►</span><TT><B>initial_population</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspInitial neutron population</span></button>
115<div class="content" style="display: none;">
116 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Initial neutron population
117</p>
118 <p>Default value: <TT style="color:grey">1(double)</TT></p>
119 <p>Allowable values: <TT>>= 0(double)</TT></p>
120</div>
121
122<button type="button" class="droppy2" style=
123"
124background-color: #edf0f5;
125color: #9373A5;
126cursor: pointer;
127border: none;
128text-align: left;
129outline: none;
130font-size: 15px;
131margin: 2px 2px;
132border: 2px solid #687372;
133display: block;
134width: 100%;
135vertical-align: middle;
136padding-top: 4px;
137padding-bottom: 0px;
138"
139><span class="arrow" style="padding-left: 0px;">►</span><TT><B>initial_rho</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspInitial reactivity [$]</span></button>
140<div class="content" style="display: none;">
141 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Initial reactivity [$]
142</p>
143 <p>Default value: <TT style="color:grey">0(double)</TT></p>
144</div>
145
146<button type="button" class="droppy2" style=
147"
148background-color: #edf0f5;
149color: #9373A5;
150cursor: pointer;
151border: none;
152text-align: left;
153outline: none;
154font-size: 15px;
155margin: 2px 2px;
156border: 2px solid #687372;
157display: block;
158width: 100%;
159vertical-align: middle;
160padding-top: 4px;
161padding-bottom: 0px;
162"
163><span class="arrow" style="padding-left: 0px;">►</span><TT><B>initial_source</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspInitial source strength [/s]</span></button>
164<div class="content" style="display: none;">
165 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Initial source strength [/s]
166</p>
167 <p>Default value: <TT style="color:grey">1(double)</TT></p>
168 <p>Allowable values: <TT>>= 0(double)</TT></p>
169</div>
170
171<button type="button" class="droppy2" style=
172"
173background-color: #edf0f5;
174color: #9373A5;
175cursor: pointer;
176border: none;
177text-align: left;
178outline: none;
179font-size: 15px;
180margin: 2px 2px;
181border: 2px solid #687372;
182display: block;
183width: 100%;
184vertical-align: middle;
185padding-top: 4px;
186padding-bottom: 0px;
187"
188><span class="arrow" style="padding-left: 0px;">►</span><TT><B>max_time_steps</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspMaximum number of timesteps to allow</span></button>
189<div class="content" style="display: none;">
190 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Maximum number of timesteps to allow. Negative values disables this.
191</p>
192 <p>Default value: <TT style="color:grey">-1</TT></p>
193</div>
194
195<button type="button" class="droppy2" style=
196"
197background-color: #edf0f5;
198color: #9373A5;
199cursor: pointer;
200border: none;
201text-align: left;
202outline: none;
203font-size: 15px;
204margin: 2px 2px;
205border: 2px solid #687372;
206display: block;
207width: 100%;
208vertical-align: middle;
209padding-top: 4px;
210padding-bottom: 0px;
211"
212><span class="arrow" style="padding-left: 0px;">►</span><TT><B>name</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA text name to associate with the solver</span></button>
213<div class="content" style="display: none;">
214 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. A text name to associate with the solver. This name will be used in status messages and verbose iterative convergence monitors.
215</p>
216 <p>Default value: <TT style="color:grey">"prk_TransientSolver"</TT></p>
217</div>
218
219<button type="button" class="droppy2" style=
220"
221background-color: #edf0f5;
222color: #9373A5;
223cursor: pointer;
224border: none;
225text-align: left;
226outline: none;
227font-size: 15px;
228margin: 2px 2px;
229border: 2px solid #687372;
230display: block;
231width: 100%;
232vertical-align: middle;
233padding-top: 4px;
234padding-bottom: 0px;
235"
236><span class="arrow" style="padding-left: 0px;">►</span><TT><B>precursor_betas</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspAn array of fractional delayed neutron fractions</span></button>
237<div class="content" style="display: none;">
238 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. An array of fractional delayed neutron fractions
239</p>
240 <p>Default value: <TT style="color:grey">0.00021(double), 0.00142(double), 0.00127(double), 0.00257(double), 0.00075(double), 0.00027(double),</TT></p>
241</div>
242
243<button type="button" class="droppy2" style=
244"
245background-color: #edf0f5;
246color: #9373A5;
247cursor: pointer;
248border: none;
249text-align: left;
250outline: none;
251font-size: 15px;
252margin: 2px 2px;
253border: 2px solid #687372;
254display: block;
255width: 100%;
256vertical-align: middle;
257padding-top: 4px;
258padding-bottom: 0px;
259"
260><span class="arrow" style="padding-left: 0px;">►</span><TT><B>precursor_lambdas</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspAn array of decay constants</span></button>
261<div class="content" style="display: none;">
262 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. An array of decay constants
263</p>
264 <p>Default value: <TT style="color:grey">0.0124(double), 0.0304(double), 0.111(double), 0.301(double), 1.14(double), 3.01(double),</TT></p>
265</div>
266
267<button type="button" class="droppy2" style=
268"
269background-color: #edf0f5;
270color: #9373A5;
271cursor: pointer;
272border: none;
273text-align: left;
274outline: none;
275font-size: 15px;
276margin: 2px 2px;
277border: 2px solid #687372;
278display: block;
279width: 100%;
280vertical-align: middle;
281padding-top: 4px;
282padding-bottom: 0px;
283"
284><span class="arrow" style="padding-left: 0px;">►</span><TT><B>start_time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTransient start-time if applicable</span></button>
285<div class="content" style="display: none;">
286 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Transient start-time if applicable.
287</p>
288 <p>Default value: <TT style="color:grey">0(double)</TT></p>
289</div>
290
291<button type="button" class="droppy2" style=
292"
293background-color: #edf0f5;
294color: #9373A5;
295cursor: pointer;
296border: none;
297text-align: left;
298outline: none;
299font-size: 15px;
300margin: 2px 2px;
301border: 2px solid #687372;
302display: block;
303width: 100%;
304vertical-align: middle;
305padding-top: 4px;
306padding-bottom: 0px;
307"
308><span class="arrow" style="padding-left: 0px;">►</span><TT><B>time</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspCurrent time of the solver</span></button>
309<div class="content" style="display: none;">
310 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Current time of the solver.
311</p>
312 <p>Default value: <TT style="color:grey">0(double)</TT></p>
313</div>
314
315<button type="button" class="droppy2" style=
316"
317background-color: #edf0f5;
318color: #9373A5;
319cursor: pointer;
320border: none;
321text-align: left;
322outline: none;
323font-size: 15px;
324margin: 2px 2px;
325border: 2px solid #687372;
326display: block;
327width: 100%;
328vertical-align: middle;
329padding-top: 4px;
330padding-bottom: 0px;
331"
332><span class="arrow" style="padding-left: 0px;">►</span><TT><B>time_integration</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspTime integration scheme to use</span></button>
333<div class="content" style="display: none;">
334 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Time integration scheme to use
335</p>
336 <p>Default value: <TT style="color:grey">"implicit_euler"</TT></p>
337 <p>Allowable values: <TT>"explicit_euler", "implicit_euler", "crank_nicolson"</TT></p>
338</div>
339
340<button type="button" class="droppy2" style=
341"
342background-color: #edf0f5;
343color: #9373A5;
344cursor: pointer;
345border: none;
346text-align: left;
347outline: none;
348font-size: 15px;
349margin: 2px 2px;
350border: 2px solid #687372;
351display: block;
352width: 100%;
353vertical-align: middle;
354padding-top: 4px;
355padding-bottom: 0px;
356"
357><span class="arrow" style="padding-left: 0px;">►</span><TT><B>timestepper</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspHandle to a timestepper</span></button>
358<div class="content" style="display: none;">
359 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Handle to a timestepper. If not supplied then a ConstantTimeStepper will be created.
360</p>
361 <p>Default value: <TT style="color:grey">0</TT></p>
362</div>
363
364</div>
365\endhtmlonly
366
367\htmlonly
368
369<script>
370
371{
372 var coll = document.getElementsByClassName("droppy2");
373 var i;
374
375 for (i = 0; i < coll.length; i++) {
376 coll[i].addEventListener("click", function() {
377 this.classList.toggle("active");
378 var content = this.nextElementSibling;
379 if (content.style.display === "block") {
380 content.style.display = "none";
381 this.childNodes[0].innerText = "►"
382 } else {
383 content.style.display = "block";
384 this.children[0].innerText = "▼"
385 }
386 });
387 }
388}</script>
389
390\endhtmlonly
391
392### Usage Examples:
393\ref test_framework_post_processors_solver_info_01_lua
394\ref test_framework_post_processors_solver_info_02_lua
395*/