Chi-Tech
chi__SolverInfoPostProcessor.h
Go to the documentation of this file.
1/** \defgroup chi__SolverInfoPostProcessor chi.SolverInfoPostProcessor
2
3
4\ingroup doc_PostProcessors
5A post processor that can get basic info for any object based on chi_physics::Solver. This solver's execution does not filter whether solverevents are for the relevant solver. This is done to avoid differing time-histories.
6
7
8## Example usage:
9Create this object:
10\code
11params =
12{
13 param_name1 = value1,
14 param_name2 = value2,
15 --etc.
16}
17chi.SolverInfoPostProcessor.Create(params)
18\endcode
19## Required 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>info</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA parameter block, requiring at minimum the parameter "name" to pass to the solver</span></button>
41<div class="content" style="display: none;">
42 <p><I>type=</I><span style="color: blue;"><TT>BLOCK</TT></span>. A parameter block, requiring at minimum the parameter "name" to pass to the solver. Note: each solver will have custom parameter blocks available to get a vast array of different pieces of information.
43</p>
44</div>
45
46<button type="button" class="droppy2" style=
47"
48background-color: #edf0f5;
49color: #9373A5;
50cursor: pointer;
51border: none;
52text-align: left;
53outline: none;
54font-size: 15px;
55margin: 2px 2px;
56border: 2px solid #687372;
57display: block;
58width: 100%;
59vertical-align: middle;
60padding-top: 4px;
61padding-bottom: 0px;
62"
63><span class="arrow" style="padding-left: 0px;">►</span><TT><B>name</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspName of the post processor</span></button>
64<div class="content" style="display: none;">
65 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Name of the post processor. This name will be used in many places so make sure it's a useful name.
66</p>
67</div>
68
69<button type="button" class="droppy2" style=
70"
71background-color: #edf0f5;
72color: #9373A5;
73cursor: pointer;
74border: none;
75text-align: left;
76outline: none;
77font-size: 15px;
78margin: 2px 2px;
79border: 2px solid #687372;
80display: block;
81width: 100%;
82vertical-align: middle;
83padding-top: 4px;
84padding-bottom: 0px;
85"
86><span class="arrow" style="padding-left: 0px;">►</span><TT><B>solver</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA handle to the solver</span></button>
87<div class="content" style="display: none;">
88 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. A handle to the solver.
89</p>
90</div>
91
92</div>
93\endhtmlonly
94
95## Optional Input parameters
96\htmlonly
97
98<div style="display: block;">
99<button type="button" class="droppy2" style=
100"
101background-color: #edf0f5;
102color: #9373A5;
103cursor: pointer;
104border: none;
105text-align: left;
106outline: none;
107font-size: 15px;
108margin: 2px 2px;
109border: 2px solid #687372;
110display: block;
111width: 100%;
112vertical-align: middle;
113padding-top: 4px;
114padding-bottom: 0px;
115"
116><span class="arrow" style="padding-left: 0px;">►</span><TT><B>execute_on</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspList of events at which the post-processor will execute</span></button>
117<div class="content" style="display: none;">
118 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. List of events at which the post-processor will execute.
119</p>
120 <p>Default value: <TT style="color:grey">"SolverInitialized", "SolverAdvanced", "SolverExecuted", "ProgramExecuted",</TT></p>
121</div>
122
123<button type="button" class="droppy2" style=
124"
125background-color: #edf0f5;
126color: #9373A5;
127cursor: pointer;
128border: none;
129text-align: left;
130outline: none;
131font-size: 15px;
132margin: 2px 2px;
133border: 2px solid #687372;
134display: block;
135width: 100%;
136vertical-align: middle;
137padding-top: 4px;
138padding-bottom: 0px;
139"
140><span class="arrow" style="padding-left: 0px;">►</span><TT><B>initial_value</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspAn initial value</span></button>
141<div class="content" style="display: none;">
142 <p><I>type=</I><span style="color: blue;"><TT>BLOCK</TT></span>. An initial value.
143</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>print_numeric_format</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspNumeric format to use</span></button>
164<div class="content" style="display: none;">
165 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Numeric format to use.
166</p>
167 <p>Default value: <TT style="color:grey">"general"</TT></p>
168 <p>Allowable values: <TT>"fixed", "floating_point", "scientific", "general"</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>print_on</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspList of events at which the post-processor will print</span></button>
189<div class="content" style="display: none;">
190 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. List of events at which the post-processor will print. Make sure that these events are also set for the `PostProcessorPrinter` otherwise it wont print.
191</p>
192 <p>Default value: <TT style="color:grey">"SolverInitialized", "SolverAdvanced", "SolverExecuted", "ProgramExecuted",</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>print_precision</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspNumber of digits to display after decimal point</span></button>
213<div class="content" style="display: none;">
214 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Number of digits to display after decimal point
215</p>
216 <p>Default value: <TT style="color:grey">6</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>solvername_filter</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspControls update events to only execute on the relevant solver'sevent calls</span></button>
237<div class="content" style="display: none;">
238 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Controls update events to only execute on the relevant solver'sevent calls.
239</p>
240 <p>Default value: <TT style="color:grey">""</TT></p>
241</div>
242
243</div>
244\endhtmlonly
245
246\htmlonly
247
248<script>
249
250{
251 var coll = document.getElementsByClassName("droppy2");
252 var i;
253
254 for (i = 0; i < coll.length; i++) {
255 coll[i].addEventListener("click", function() {
256 this.classList.toggle("active");
257 var content = this.nextElementSibling;
258 if (content.style.display === "block") {
259 content.style.display = "none";
260 this.childNodes[0].innerText = "►"
261 } else {
262 content.style.display = "block";
263 this.children[0].innerText = "▼"
264 }
265 });
266 }
267}</script>
268
269\endhtmlonly
270
271### Usage Examples:
272\ref test_framework_post_processors_solver_info_01_lua
273\ref test_framework_post_processors_solver_info_02_lua
274*/