Chi-Tech
chi__PostProcessorPrinterOptions.h
Go to the documentation of this file.
1/** \defgroup chi__PostProcessorPrinterOptions chi.PostProcessorPrinterOptions
2
3
4\ingroup doc_PPUtils
5Options allowable for the PostProcessorPrinter
6
7<B>Note:</B> This object is not constructable
8## Optional Input parameters
9\htmlonly
10
11<div style="display: block;">
12<button type="button" class="droppy2" style=
13"
14background-color: #edf0f5;
15color: #9373A5;
16cursor: pointer;
17border: none;
18text-align: left;
19outline: none;
20font-size: 15px;
21margin: 2px 2px;
22border: 2px solid #687372;
23display: block;
24width: 100%;
25vertical-align: middle;
26padding-top: 4px;
27padding-bottom: 0px;
28"
29><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>
30<div class="content" style="display: none;">
31 <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.
32</p>
33 <p>Default value: <TT style="color:grey">""</TT></p>
34</div>
35
36<button type="button" class="droppy2" style=
37"
38background-color: #edf0f5;
39color: #9373A5;
40cursor: pointer;
41border: none;
42text-align: left;
43outline: none;
44font-size: 15px;
45margin: 2px 2px;
46border: 2px solid #687372;
47display: block;
48width: 100%;
49vertical-align: middle;
50padding-top: 4px;
51padding-bottom: 0px;
52"
53><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>
54<div class="content" style="display: none;">
55 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. A list of events on which to print post-processors
56</p>
57 <p>Default value: <TT style="color:grey">"SolverInitialized", "SolverAdvanced", "SolverExecuted", "ProgramExecuted",</TT></p>
58</div>
59
60<button type="button" class="droppy2" style=
61"
62background-color: #edf0f5;
63color: #9373A5;
64cursor: pointer;
65border: none;
66text-align: left;
67outline: none;
68font-size: 15px;
69margin: 2px 2px;
70border: 2px solid #687372;
71display: block;
72width: 100%;
73vertical-align: middle;
74padding-top: 4px;
75padding-bottom: 0px;
76"
77><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>
78<div class="content" style="display: none;">
79 <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.
80</p>
81 <p>Default value: <TT style="color:grey">true</TT></p>
82</div>
83
84<button type="button" class="droppy2" style=
85"
86background-color: #edf0f5;
87color: #9373A5;
88cursor: pointer;
89border: none;
90text-align: left;
91outline: none;
92font-size: 15px;
93margin: 2px 2px;
94border: 2px solid #687372;
95display: block;
96width: 100%;
97vertical-align: middle;
98padding-top: 4px;
99padding-bottom: 0px;
100"
101><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>
102<div class="content" style="display: none;">
103 <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.
104</p>
105 <p>Default value: <TT style="color:grey">true</TT></p>
106</div>
107
108<button type="button" class="droppy2" style=
109"
110background-color: #edf0f5;
111color: #9373A5;
112cursor: pointer;
113border: none;
114text-align: left;
115outline: none;
116font-size: 15px;
117margin: 2px 2px;
118border: 2px solid #687372;
119display: block;
120width: 100%;
121vertical-align: middle;
122padding-top: 4px;
123padding-bottom: 0px;
124"
125><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>
126<div class="content" style="display: none;">
127 <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.
128</p>
129 <p>Default value: <TT style="color:grey">true</TT></p>
130</div>
131
132<button type="button" class="droppy2" style=
133"
134background-color: #edf0f5;
135color: #9373A5;
136cursor: pointer;
137border: none;
138text-align: left;
139outline: none;
140font-size: 15px;
141margin: 2px 2px;
142border: 2px solid #687372;
143display: block;
144width: 100%;
145vertical-align: middle;
146padding-top: 4px;
147padding-bottom: 0px;
148"
149><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>
150<div class="content" style="display: none;">
151 <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.
152</p>
153 <p>Default value: <TT style="color:grey">true</TT></p>
154</div>
155
156<button type="button" class="droppy2" style=
157"
158background-color: #edf0f5;
159color: #9373A5;
160cursor: pointer;
161border: none;
162text-align: left;
163outline: none;
164font-size: 15px;
165margin: 2px 2px;
166border: 2px solid #687372;
167display: block;
168width: 100%;
169vertical-align: middle;
170padding-top: 4px;
171padding-bottom: 0px;
172"
173><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>
174<div class="content" style="display: none;">
175 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The table format with which to print scalar PostProcessors
176</p>
177 <p>Default value: <TT style="color:grey">"vertical"</TT></p>
178 <p>Allowable values: <TT>"horizontal", "vertical"</TT></p>
179</div>
180
181<button type="button" class="droppy2" style=
182"
183background-color: #edf0f5;
184color: #9373A5;
185cursor: pointer;
186border: none;
187text-align: left;
188outline: none;
189font-size: 15px;
190margin: 2px 2px;
191border: 2px solid #687372;
192display: block;
193width: 100%;
194vertical-align: middle;
195padding-top: 4px;
196padding-bottom: 0px;
197"
198><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>
199<div class="content" style="display: none;">
200 <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.
201</p>
202 <p>Default value: <TT style="color:grey">120</TT></p>
203</div>
204
205<button type="button" class="droppy2" style=
206"
207background-color: #edf0f5;
208color: #9373A5;
209cursor: pointer;
210border: none;
211text-align: left;
212outline: none;
213font-size: 15px;
214margin: 2px 2px;
215border: 2px solid #687372;
216display: block;
217width: 100%;
218vertical-align: middle;
219padding-top: 4px;
220padding-bottom: 0px;
221"
222><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>
223<div class="content" style="display: none;">
224 <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.
225</p>
226 <p>Default value: <TT style="color:grey">15</TT></p>
227</div>
228
229</div>
230\endhtmlonly
231
232\htmlonly
233
234<script>
235
236{
237 var coll = document.getElementsByClassName("droppy2");
238 var i;
239
240 for (i = 0; i < coll.length; i++) {
241 coll[i].addEventListener("click", function() {
242 this.classList.toggle("active");
243 var content = this.nextElementSibling;
244 if (content.style.display === "block") {
245 content.style.display = "none";
246 this.childNodes[0].innerText = "►"
247 } else {
248 content.style.display = "block";
249 this.children[0].innerText = "▼"
250 }
251 });
252 }
253}</script>
254
255\endhtmlonly
256
257*/