Chi-Tech
prk__SetParam.h
Go to the documentation of this file.
1/** \defgroup prk__SetParam prk.SetParam
2
3
4\ingroup prk
5Lua wrapper function for setting parameters in the PointReactorKinetics module.
6
7
8## Function Syntax:
9\code
10prk.SetParam(INTEGER arg0, STRING arg1, FLOAT arg2)
11\endcode
12## Required Input parameters
13\htmlonly
14
15<div style="display: block;">
16<button type="button" class="droppy2" style=
17"
18background-color: #edf0f5;
19color: #9373A5;
20cursor: pointer;
21border: none;
22text-align: left;
23outline: none;
24font-size: 15px;
25margin: 2px 2px;
26border: 2px solid #687372;
27display: block;
28width: 100%;
29vertical-align: middle;
30padding-top: 4px;
31padding-bottom: 0px;
32"
33><span class="arrow" style="padding-left: 0px;">►</span><TT><B>arg0</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspHandle to a <TT>prk::TransientSolver</TT> object</span></button>
34<div class="content" style="display: none;">
35 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Handle to a <TT>prk::TransientSolver</TT> object.
36</p>
37</div>
38
39<button type="button" class="droppy2" style=
40"
41background-color: #edf0f5;
42color: #9373A5;
43cursor: pointer;
44border: none;
45text-align: left;
46outline: none;
47font-size: 15px;
48margin: 2px 2px;
49border: 2px solid #687372;
50display: block;
51width: 100%;
52vertical-align: middle;
53padding-top: 4px;
54padding-bottom: 0px;
55"
56><span class="arrow" style="padding-left: 0px;">►</span><TT><B>arg1</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspText name of the parameter to set</span></button>
57<div class="content" style="display: none;">
58 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Text name of the parameter to set.
59</p>
60 <p>Allowable values: <TT>"rho"</TT></p>
61</div>
62
63<button type="button" class="droppy2" style=
64"
65background-color: #edf0f5;
66color: #9373A5;
67cursor: pointer;
68border: none;
69text-align: left;
70outline: none;
71font-size: 15px;
72margin: 2px 2px;
73border: 2px solid #687372;
74display: block;
75width: 100%;
76vertical-align: middle;
77padding-top: 4px;
78padding-bottom: 0px;
79"
80><span class="arrow" style="padding-left: 0px;">►</span><TT><B>arg2</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspValue to set to the parameter pointed to by arg1</span></button>
81<div class="content" style="display: none;">
82 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Value to set to the parameter pointed to by arg1
83</p>
84</div>
85
86</div>
87\endhtmlonly
88
89\htmlonly
90
91<script>
92
93{
94 var coll = document.getElementsByClassName("droppy2");
95 var i;
96
97 for (i = 0; i < coll.length; i++) {
98 coll[i].addEventListener("click", function() {
99 this.classList.toggle("active");
100 var content = this.nextElementSibling;
101 if (content.style.display === "block") {
102 content.style.display = "none";
103 this.childNodes[0].innerText = "►"
104 } else {
105 content.style.display = "block";
106 this.children[0].innerText = "▼"
107 }
108 });
109 }
110}</script>
111
112\endhtmlonly
113
114### Usage Examples:
115\ref test_framework_post_processors_solver_info_01_lua
116\ref test_framework_post_processors_solver_info_02_lua
117*/