<?xml version='1.0' encoding='UTF-8' ?>
<!DOCTYPE html
  SYSTEM "about:legacy-compat">
<html xmlns:mml = "http://www.w3.org/1998/Math/MathML" lang = "en"><head><meta charset = "UTF-8"/><meta name = "copyright" content = "(C) Copyright 2020"/><meta name = "DC.rights.owner" content = "(C) Copyright 2020"/><meta name = "DC.type" content = "reference"/><meta name = "abstract" content = "Combines optimization results to post-processing reports. These contain animation sequences of fringe plots of optimization results as well as result plots."/><meta name = "description" content = "Combines optimization results to post-processing reports. These contain animation sequences of fringe plots of optimization results as well as result plots."/><meta name = "DC.format" content = "HTML5"/><meta name = "DC.identifier" content = "tso-r-cmd-report"/><meta name = "DC.language" content = "en"/><link rel = "stylesheet" type = "text/css" href = "../DSDocUI_XML34.css"/><title>REPORT</title>
<script type = "text/javascript" src = "../DSDocUI_Highlight34.js">
  	/* */
  	</script></head><body onLoad = "highlightSearchTerms();" id = "tso-r-cmd-report">
<a name = "hj-top"> </a><table class = "table1" id = "table11"><tr><td><table class = "DocHeader"><tr><td class = "DocHeader1" colspan = "2"><h1>REPORT</h1></td></tr><tr><td class = "DocHeader4" colspan = "2"/></tr><tr><td class = "DocHeader3" colspan = "2"><table class = "DocThemeIntro" id = "table12"><tr><td class = "Intro1Only"><p class = "header"><p class = "abstract">
<span class = "shortdesc">Combines optimization results to post-processing reports. These contain animation sequences of fringe plots of optimization results as well as result plots. </span>

</p>
<ul><li><a href = "#tso-r-cmd-report__tso-r-cmd-report-rmk" id = "toc_rg" title = "">Remarks</a></li></ul>
</p></td></tr></table></td></tr></table>




<div class = "body refbody">
<table class = "table" id = "tso-r-cmd-report__aa1542197"><caption/><colgroup><col/><col/><col/></colgroup><tbody class = "tbody">
<tr class = "row">
<td class = "entry"><p><span class = "ph uicontrol">ID_NAME</span></p></td>
<td class = "entry"><p>= &lt;<code class = "ph codeph">id_name_of_report</code>&gt; </p></td>
<td class = "entry"><p>Name of the job.</p></td>
</tr>
<tr class = "row">
<td class = "entry"><p><span class = "ph uicontrol">DATABASE</span></p></td>
<td class = "entry"><p>= &lt;<code class = "ph codeph">opt_res_database</code>&gt;</p></td>
<td class = "entry"><p>Name of the results-database to read from. The typical name is <code class = "ph codeph">opt_res_database</code>.
                         If this parameter is provided, the parameters <code class = "ph codeph">MODEL</code>, <code class = "ph codeph">RESULT</code> and <code class = "ph codeph">GROUP_FILE</code> are not allowed. </p></td>
</tr>
<tr class = "row">
<td class = "entry"><p><span class = "ph uicontrol">MODEL</span></p></td>
<td class = "entry"><p>= &lt;<code class = "ph codeph">ONF_file_name</code>&gt;</p></td>
<td class = "entry"><p>Name and relative path of the ONF file, containing the model. This parameter is not allowed when a <code class = "ph codeph">DATABASE</code>-name is given.</p></td>
</tr>
<tr class = "row">
<td class = "entry"/>
<td class = "entry"><p><span class = "ph uicontrol">= SAVE.onf</span></p></td>
<td class = "entry"><p>First, tosca_report checks if the file with the given name exists.</p></td>
</tr>
<tr class = "row">
<td class = "entry"/>
<td class = "entry"><p><span class = "ph uicontrol">= MODEL_fem.onf</span></p></td>
<td class = "entry"><p>If not, the file &lt;<code class = "ph codeph">model</code>&gt;_fem.onf is loaded. </p></td>
</tr>
<tr class = "row">
<td class = "entry"><p><span class = "ph uicontrol">RESULT</span></p></td>
<td class = "entry"><p>= &lt;<code class = "ph codeph">ONF_result_file_path_and_prefix</code>&gt;</p><p><span class = "ph uicontrol">= SAVE.onf/TP</span></p>
                      <p><span class = "ph uicontrol">= SAVE.onf/SHAPE</span></p><p><span class = "ph uicontrol">= SAVE.onf/BEAD</span></p></td>
<td class = "entry"><p>Use this parameter to specify the path and the prefix of the result onf files (one of TP, SHAPE or BEAD).
                         The default value of this parameter depends upon which files out of these actually exist. This parameter is not allowed when a <code class = "ph codeph">DATABASE</code>-name is given.</p></td>
</tr>
<tr class = "row">
<td class = "entry"><p><span class = "ph uicontrol">OUTPUT_FILE</span></p></td>
<td class = "entry"><p>= &lt;<code class = "ph codeph">name_of_vtfx_file</code>&gt;</p></td>
<td class = "entry"><p>Name of the VTFX file to be created.</p><p>If the name ends with .vtfx, no extension will be added.
                         If this is not the case – the extension .vtfx will be added. </p></td>
</tr>
<tr class = "row">
<td class = "entry"><p>CONTOURPLOT</p></td>
<td class = "entry"><p>= &lt;<code class = "ph codeph">name_of_contour_plot</code>&gt;</p></td>
<td class = "entry"><p>Name of contour plot to be written as separate case in the vtfx file. More than one entry is allowed.</p></td>
</tr>
<tr class = "row">
<td class = "entry"><p>DEFAULT_GROUP</p></td>
<td class = "entry"><p>= &lt;<code class = "ph codeph">name_of_element_group</code>&gt;</p></td>
<td class = "entry"><p>Default group for contour plots; visualization model and fringe plot will be restricted to this group.</p></td>
</tr>
<tr class = "row">
<td class = "entry"><p>APPEND_TO_VTFX</p></td>
<td class = "entry"><p><span class = "ph uicontrol">=</span><span class = "ph uicontrol">YES</span></p>
                      <p>=NO</p></td>
<td class = "entry"><p>Appends report to file specified with parameter <code class = "ph codeph">OUTPUT_FILE</code>. </p></td>
</tr>

</tbody></table>

<div class = "section" id = "tso-r-cmd-report__tso-r-cmd-report-rmk"><h2 class = "title sectiontitle">Remarks</h2>

<ol class = "ol">
<li class = "li">
Note that <code class = "ph codeph">MODEL</code>, <code class = "ph codeph">RESULT</code> and <code class = "ph codeph">OUTPUT_FILE</code>
should be specified using absolute paths or relative paths starting from the job directory
(more precisely, from the directory where tosca_report is started).</li>
<li class = "li">
To add sensitivity plots to your report file, you must first write the sensitivity information
to ONF using a <code class = "ph codeph">USER_FILE</code> command. Then use the following command contained in
your original parameter file (because <span class = "ph">Tosca Structure</span>
control must know all objective functions and constraint definitions):
<pre class = "codeblock">REPORT
  ID_NAME          = sens_plots
  SENSITIVITY_PLOT = YES
END_
</pre>
The procedure in detail is described in <a class = "xref" href = "../TsoUserMap/tso-c-usr-post-genData-stdRep.htm#tso-c-usr-post-genData-stdRep__tso-c-usr-post-genData-stdRep-sensPlot">Sensitivity Plots</a>.</li>
<li class = "li">
<code class = "ph codeph">APPEND_TO_VTFX</code> allows to combine reports with several smooth results
into one vtfx archive. Note, if <code class = "ph codeph"> APPEND_TO_VTFX=NO</code> and the file
specified with parameter <code class = "ph codeph">OUTPUT_FILE</code> exists, it is overwritten. Otherwise
a new file is created.
</li>
<li class = "li">
Using <code class = "ph codeph">DEFAULT_GROUP</code> in the <code class = "ph codeph">REPORT</code> command the
<span class = "ph">Tosca Structure</span>
control appends the specified group to all referenced <code class = "ph codeph">CONTOURPLOT</code>s. In
the example below <code class = "ph codeph">GROUP = MESHSMOOTH</code> is added to the<code class = "ph codeph"> CONTOURPLOT</code>s
<code class = "ph codeph">MODEL</code>, <code class = "ph codeph">SHAPE_CTRL</code> and <code class = "ph codeph">SHAPE_DISP</code> if they do not already reference a group.
Thus, the visualization model is restricted to the referenced
group which might reduce file size significantly.
<pre class = "codeblock">
REPORT
  ID_NAME        = default_shape
  DATABASE       = "opt_res_database"
  CONTOURPLOT    = MODEL
  CONTOURPLOT    = SHAPE_CTRL
  CONTOURPLOT    = SHAPE_DISP
  OUTPUT_FILE    = "TOSCA_POST/default_shape"
  DEFAULT_GROUP  = MESHSMOOTH
END_
</pre>
</li>

</ol>
</div>

</div>

</td></tr></table><script type = "text/javascript" src = "../DSDocUI_Bottom34.js">/* */</script></body>
</html>
