Chi-Tech
chi__AggregateNodalValuePostProcessor.h
Go to the documentation of this file.
1/** \defgroup chi__AggregateNodalValuePostProcessor chi.AggregateNodalValuePostProcessor
2
3
4\ingroup doc_PostProcessors
5Gets the max/min/avg nodal value of a field function among nodal values.
6
7
8## Example usage:
9Create this object:
10\code
11params =
12{
13 param_name1 = value1,
14 param_name2 = value2,
15 --etc.
16}
17chi.AggregateNodalValuePostProcessor.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>field_function</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspField function handle or name</span></button>
41<div class="content" style="display: none;">
42 <p><I>type=</I><span style="color: blue;"><TT>BLOCK</TT></span>. Field function handle or name.
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>operation</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe required operation to be performed</span></button>
87<div class="content" style="display: none;">
88 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The required operation to be performed.
89</p>
90 <p>Allowable values: <TT>"max", "min", "avg"</TT></p>
91</div>
92
93</div>
94\endhtmlonly
95
96## Optional Input parameters
97\htmlonly
98
99<div style="display: block;">
100<button type="button" class="droppy2" style=
101"
102background-color: #edf0f5;
103color: #9373A5;
104cursor: pointer;
105border: none;
106text-align: left;
107outline: none;
108font-size: 15px;
109margin: 2px 2px;
110border: 2px solid #687372;
111display: block;
112width: 100%;
113vertical-align: middle;
114padding-top: 4px;
115padding-bottom: 0px;
116"
117><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>
118<div class="content" style="display: none;">
119 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. List of events at which the post-processor will execute.
120</p>
121 <p>Default value: <TT style="color:grey">"SolverInitialized", "SolverAdvanced", "SolverExecuted", "ProgramExecuted",</TT></p>
122</div>
123
124<button type="button" class="droppy2" style=
125"
126background-color: #edf0f5;
127color: #9373A5;
128cursor: pointer;
129border: none;
130text-align: left;
131outline: none;
132font-size: 15px;
133margin: 2px 2px;
134border: 2px solid #687372;
135display: block;
136width: 100%;
137vertical-align: middle;
138padding-top: 4px;
139padding-bottom: 0px;
140"
141><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>
142<div class="content" style="display: none;">
143 <p><I>type=</I><span style="color: blue;"><TT>BLOCK</TT></span>. An initial value.
144</p>
145</div>
146
147<button type="button" class="droppy2" style=
148"
149background-color: #edf0f5;
150color: #9373A5;
151cursor: pointer;
152border: none;
153text-align: left;
154outline: none;
155font-size: 15px;
156margin: 2px 2px;
157border: 2px solid #687372;
158display: block;
159width: 100%;
160vertical-align: middle;
161padding-top: 4px;
162padding-bottom: 0px;
163"
164><span class="arrow" style="padding-left: 0px;">►</span><TT><B>logical_volume</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspHandle to a logical_volume</span></button>
165<div class="content" style="display: none;">
166 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Handle to a logical_volume.
167</p>
168 <p>Default value: <TT style="color:grey">0</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_numeric_format</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspNumeric format to use</span></button>
189<div class="content" style="display: none;">
190 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Numeric format to use.
191</p>
192 <p>Default value: <TT style="color:grey">"general"</TT></p>
193 <p>Allowable values: <TT>"fixed", "floating_point", "scientific", "general"</TT></p>
194</div>
195
196<button type="button" class="droppy2" style=
197"
198background-color: #edf0f5;
199color: #9373A5;
200cursor: pointer;
201border: none;
202text-align: left;
203outline: none;
204font-size: 15px;
205margin: 2px 2px;
206border: 2px solid #687372;
207display: block;
208width: 100%;
209vertical-align: middle;
210padding-top: 4px;
211padding-bottom: 0px;
212"
213><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>
214<div class="content" style="display: none;">
215 <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.
216</p>
217 <p>Default value: <TT style="color:grey">"SolverInitialized", "SolverAdvanced", "SolverExecuted", "ProgramExecuted",</TT></p>
218</div>
219
220<button type="button" class="droppy2" style=
221"
222background-color: #edf0f5;
223color: #9373A5;
224cursor: pointer;
225border: none;
226text-align: left;
227outline: none;
228font-size: 15px;
229margin: 2px 2px;
230border: 2px solid #687372;
231display: block;
232width: 100%;
233vertical-align: middle;
234padding-top: 4px;
235padding-bottom: 0px;
236"
237><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>
238<div class="content" style="display: none;">
239 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Number of digits to display after decimal point
240</p>
241 <p>Default value: <TT style="color:grey">6</TT></p>
242</div>
243
244<button type="button" class="droppy2" style=
245"
246background-color: #edf0f5;
247color: #9373A5;
248cursor: pointer;
249border: none;
250text-align: left;
251outline: none;
252font-size: 15px;
253margin: 2px 2px;
254border: 2px solid #687372;
255display: block;
256width: 100%;
257vertical-align: middle;
258padding-top: 4px;
259padding-bottom: 0px;
260"
261><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>
262<div class="content" style="display: none;">
263 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Controls update events to only execute on the relevant solver'sevent calls.
264</p>
265 <p>Default value: <TT style="color:grey">""</TT></p>
266</div>
267
268</div>
269\endhtmlonly
270
271\htmlonly
272
273<script>
274
275{
276 var coll = document.getElementsByClassName("droppy2");
277 var i;
278
279 for (i = 0; i < coll.length; i++) {
280 coll[i].addEventListener("click", function() {
281 this.classList.toggle("active");
282 var content = this.nextElementSibling;
283 if (content.style.display === "block") {
284 content.style.display = "none";
285 this.childNodes[0].innerText = "►"
286 } else {
287 content.style.display = "block";
288 this.children[0].innerText = "▼"
289 }
290 });
291 }
292}</script>
293
294\endhtmlonly
295
296### Usage Examples:
297\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
298\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
299\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
300*/