chi__PostProcessor.h

Go to the documentation of this file.

/** \defgroup chi__PostProcessor chi.PostProcessor
 
 
\ingroup doc_PostProcessors
Base class for Post-Processors. For more generalinformation see \ref doc_PostProcessors
 
<B>Note:</B> This object is not constructable
## Required Input parameters
\htmlonly
 
<div style="display: block;">
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><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>
<div class="content" style="display: none;">
  <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.
</p>
</div>
 
</div>
\endhtmlonly
 
## Optional Input parameters
\htmlonly
 
<div style="display: block;">
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><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>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. List of events at which the post-processor will execute.
</p>
  <p>Default value: <TT style="color:grey">"SolverInitialized", "SolverAdvanced", "SolverExecuted", "ProgramExecuted",</TT></p>
</div>
 
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><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>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>BLOCK</TT></span>. An initial value.
</p>
</div>
 
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><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>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Numeric format to use.
</p>
  <p>Default value: <TT style="color:grey">"general"</TT></p>
  <p>Allowable values: <TT>"fixed", "floating_point", "scientific", "general"</TT></p>
</div>
 
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><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>
<div class="content" style="display: none;">
  <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.
</p>
  <p>Default value: <TT style="color:grey">"SolverInitialized", "SolverAdvanced", "SolverExecuted", "ProgramExecuted",</TT></p>
</div>
 
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><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>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Number of digits to display after decimal point
</p>
  <p>Default value: <TT style="color:grey">6</TT></p>
</div>
 
<button type="button" class="droppy2" style=
"
background-color: #edf0f5;
color: #9373A5;
cursor: pointer;
border: none;
text-align: left;
outline: none;
font-size: 15px;
margin: 2px 2px;
border: 2px solid #687372;
display: block;
width: 100%;
vertical-align: middle;
padding-top: 4px;
padding-bottom: 0px;
"
><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>
<div class="content" style="display: none;">
  <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Controls update events to only execute on the relevant solver'sevent calls.
</p>
  <p>Default value: <TT style="color:grey">""</TT></p>
</div>
 
</div>
\endhtmlonly
 
\htmlonly
 
<script>
 
{
    var coll = document.getElementsByClassName("droppy2");
    var i;
    
    for (i = 0; i < coll.length; i++) {
      coll[i].addEventListener("click", function() {
        this.classList.toggle("active");
        var content = this.nextElementSibling;
        if (content.style.display === "block") {
          content.style.display = "none";
          this.childNodes[0].innerText = "►"
        } else {
          content.style.display = "block";
          this.children[0].innerText = "▼"
        }
      });
    }
}</script>
 
\endhtmlonly
 
### Usage Examples:
\ref test_framework_post_processors_solver_info_01_lua  
\ref test_framework_post_processors_solver_info_02_lua  
*/