Chi-Tech
chi__PostProcessorPrinterSetOptions.h
Go to the documentation of this file.
1/** \defgroup chi__PostProcessorPrinterSetOptions chi.PostProcessorPrinterSetOptions
2
3
4\ingroup doc_PPUtils
5Wrapper function to set options of the singleton PostProcessorPrinter.
6
7
8## Function Syntax:
9\code
10chi.PostProcessorPrinterSetOptions(BLOCK arg0)
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 &nbspOptions parameter block</span></button>
34<div class="content" style="display: none;">
35 <p><I>type=</I><span style="color: blue;"><TT>BLOCK</TT></span>. Options parameter block
36</p>
37<div class="content" style="padding-left: 20px;">
38<HR><button type="button" class="droppy2" style=
39"
40background-color: #ffffff;
41color: #000000;
42cursor: pointer;
43border: none;
44text-align: left;
45outline: none;
46font-size: 15px;
47margin: 2px 2px;
48
49display: block;
50vertical-align: middle;
51padding-top: 4px;
52padding-bottom: 0px;
53"
54><span class="arrow" style="padding-left: 0px;">►</span><B>Optional parameters for chi::PostProcessorPrinterOptions</B></button>
55<div class="content" style="display: none;padding-left: 20px;">
56<div style="display: block;">
57<button type="button" class="droppy2" style=
58"
59background-color: #edf0f5;
60color: #9373A5;
61cursor: pointer;
62border: none;
63text-align: left;
64outline: none;
65font-size: 15px;
66margin: 2px 2px;
67border: 2px solid #687372;
68display: block;
69width: 100%;
70vertical-align: middle;
71padding-top: 4px;
72padding-bottom: 0px;
73"
74><span class="arrow" style="padding-left: 0px;">►</span><TT><B>csv_filename</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspIf not empty, a file will be printed with all the post-processors formatted as comma seperated values</span></button>
75<div class="content" style="display: none;">
76 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. If not empty, a file will be printed with all the post-processors formatted as comma seperated values.
77</p>
78 <p>Default value: <TT style="color:grey">""</TT></p>
79</div>
80
81<button type="button" class="droppy2" style=
82"
83background-color: #edf0f5;
84color: #9373A5;
85cursor: pointer;
86border: none;
87text-align: left;
88outline: none;
89font-size: 15px;
90margin: 2px 2px;
91border: 2px solid #687372;
92display: block;
93width: 100%;
94vertical-align: middle;
95padding-top: 4px;
96padding-bottom: 0px;
97"
98><span class="arrow" style="padding-left: 0px;">►</span><TT><B>events_on_which_to_print_postprocs</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA list of events on which to print post-processors</span></button>
99<div class="content" style="display: none;">
100 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. A list of events on which to print post-processors
101</p>
102 <p>Default value: <TT style="color:grey">"SolverInitialized", "SolverAdvanced", "SolverExecuted", "ProgramExecuted",</TT></p>
103</div>
104
105<button type="button" class="droppy2" style=
106"
107background-color: #edf0f5;
108color: #9373A5;
109cursor: pointer;
110border: none;
111text-align: left;
112outline: none;
113font-size: 15px;
114margin: 2px 2px;
115border: 2px solid #687372;
116display: block;
117width: 100%;
118vertical-align: middle;
119padding-top: 4px;
120padding-bottom: 0px;
121"
122><span class="arrow" style="padding-left: 0px;">►</span><TT><B>per_column_size_scalars</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspControls the sizing of printed columns</span></button>
123<div class="content" style="display: none;">
124 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Controls the sizing of printed columns. If false all the columns will be the same size.
125</p>
126 <p>Default value: <TT style="color:grey">true</TT></p>
127</div>
128
129<button type="button" class="droppy2" style=
130"
131background-color: #edf0f5;
132color: #9373A5;
133cursor: pointer;
134border: none;
135text-align: left;
136outline: none;
137font-size: 15px;
138margin: 2px 2px;
139border: 2px solid #687372;
140display: block;
141width: 100%;
142vertical-align: middle;
143padding-top: 4px;
144padding-bottom: 0px;
145"
146><span class="arrow" style="padding-left: 0px;">►</span><TT><B>per_column_size_vectors</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspControls the sizing of printed columns</span></button>
147<div class="content" style="display: none;">
148 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Controls the sizing of printed columns. If false all the columns will be the same size.
149</p>
150 <p>Default value: <TT style="color:grey">true</TT></p>
151</div>
152
153<button type="button" class="droppy2" style=
154"
155background-color: #edf0f5;
156color: #9373A5;
157cursor: pointer;
158border: none;
159text-align: left;
160outline: none;
161font-size: 15px;
162margin: 2px 2px;
163border: 2px solid #687372;
164display: block;
165width: 100%;
166vertical-align: middle;
167padding-top: 4px;
168padding-bottom: 0px;
169"
170><span class="arrow" style="padding-left: 0px;">►</span><TT><B>print_scalar_time_history</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspControls whether a time history of scalar post-processors are printed</span></button>
171<div class="content" style="display: none;">
172 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Controls whether a time history of scalar post-processors are printed. If false, only the latest version will be printed.
173</p>
174 <p>Default value: <TT style="color:grey">true</TT></p>
175</div>
176
177<button type="button" class="droppy2" style=
178"
179background-color: #edf0f5;
180color: #9373A5;
181cursor: pointer;
182border: none;
183text-align: left;
184outline: none;
185font-size: 15px;
186margin: 2px 2px;
187border: 2px solid #687372;
188display: block;
189width: 100%;
190vertical-align: middle;
191padding-top: 4px;
192padding-bottom: 0px;
193"
194><span class="arrow" style="padding-left: 0px;">►</span><TT><B>print_vector_time_history</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspControls whether a time history of vector post-processors are printed</span></button>
195<div class="content" style="display: none;">
196 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Controls whether a time history of vector post-processors are printed. If false, only the latest version will be printed.
197</p>
198 <p>Default value: <TT style="color:grey">true</TT></p>
199</div>
200
201<button type="button" class="droppy2" style=
202"
203background-color: #edf0f5;
204color: #9373A5;
205cursor: pointer;
206border: none;
207text-align: left;
208outline: none;
209font-size: 15px;
210margin: 2px 2px;
211border: 2px solid #687372;
212display: block;
213width: 100%;
214vertical-align: middle;
215padding-top: 4px;
216padding-bottom: 0px;
217"
218><span class="arrow" style="padding-left: 0px;">►</span><TT><B>scalar_pp_table_format</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe table format with which to print scalar PostProcessors</span></button>
219<div class="content" style="display: none;">
220 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The table format with which to print scalar PostProcessors
221</p>
222 <p>Default value: <TT style="color:grey">"vertical"</TT></p>
223 <p>Allowable values: <TT>"horizontal", "vertical"</TT></p>
224</div>
225
226<button type="button" class="droppy2" style=
227"
228background-color: #edf0f5;
229color: #9373A5;
230cursor: pointer;
231border: none;
232text-align: left;
233outline: none;
234font-size: 15px;
235margin: 2px 2px;
236border: 2px solid #687372;
237display: block;
238width: 100%;
239vertical-align: middle;
240padding-top: 4px;
241padding-bottom: 0px;
242"
243><span class="arrow" style="padding-left: 0px;">►</span><TT><B>table_column_limit</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe maximum column, if reached, would cause tables to be wrapped</span></button>
244<div class="content" style="display: none;">
245 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. The maximum column, if reached, would cause tables to be wrapped. A minimum limit of 80 is automatically enforced.
246</p>
247 <p>Default value: <TT style="color:grey">120</TT></p>
248</div>
249
250<button type="button" class="droppy2" style=
251"
252background-color: #edf0f5;
253color: #9373A5;
254cursor: pointer;
255border: none;
256text-align: left;
257outline: none;
258font-size: 15px;
259margin: 2px 2px;
260border: 2px solid #687372;
261display: block;
262width: 100%;
263vertical-align: middle;
264padding-top: 4px;
265padding-bottom: 0px;
266"
267><span class="arrow" style="padding-left: 0px;">►</span><TT><B>time_history_limit</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspMaximum amount of time values to show in post-processor histories</span></button>
268<div class="content" style="display: none;">
269 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Maximum amount of time values to show in post-processor histories. A maximum of 1000 is automatically enforced.
270</p>
271 <p>Default value: <TT style="color:grey">15</TT></p>
272</div>
273
274</div>
275</div>
276</div>
277</div>
278
279</div>
280\endhtmlonly
281
282\htmlonly
283
284<script>
285
286{
287 var coll = document.getElementsByClassName("droppy2");
288 var i;
289
290 for (i = 0; i < coll.length; i++) {
291 coll[i].addEventListener("click", function() {
292 this.classList.toggle("active");
293 var content = this.nextElementSibling;
294 if (content.style.display === "block") {
295 content.style.display = "none";
296 this.childNodes[0].innerText = "►"
297 } else {
298 content.style.display = "block";
299 this.children[0].innerText = "▼"
300 }
301 });
302 }
303}</script>
304
305\endhtmlonly
306
307### Usage Examples:
308\ref test_framework_post_processors_solver_info_01_lua
309\ref test_framework_post_processors_solver_info_02_lua
310*/