<![CDATA[
<table cellspacing="0" cellpadding="0">
<tr height="150">
<td align="left"><img src="../../../../img/logo.gif" alt="IAC logo"></img></td>
<td width="100%" rowspan="2" align="left" valign="center">
<table cellspacing="0" cellpadding="0">
<tr>
<td>
<table class="navigate_doc" width="100%" border="0" align="center">
<tr bgcolor="c6c6e0" align="center">
<th nowrap width="1%" height="32">P0008</th>
<th nowrap width="98%">CFDVals</th>
<th nowrap width="1%">27th November 1998</th>
</tr>
<tr>
<td align="left" colspan="3">
<p><b>Author:</b> Ian Curington
<b>Version:</b> 1.0
<b>Path:</b> iac_proj/cfdvals/</p>
<a href="../../filters.shtml" target="_top"><img src="../../../../img/filter.gif" width="44" height="30" border="0" alt="Filter"></a>
<a href="doc_mod.shtml" target="_top">
<img src="../../../../img/doc_mod.gif" border="0"
width="30" height="30"
alt="Module Document - CFDValsNodeData"></a>
<a href="doc_umac.shtml" target="_top">
<img src="../../../../img/doc_umac.gif" border="0"
width="30" height="30"
alt="User Macro Document - cfd_values"></a>
<a href="source/filters/cfdvals/cfdvals.tar.gz">
<img src="../../../../img/targz.gif"
border="0" width="52" height="30"
alt="Archive - cfdvals.tar.gz"></a>
<a href="source/filters/cfdvals/cfdvals.tar.Z">
<img src="../../../../img/tarz.gif"
border="0" width="52" height="30"
alt="Archive - cfdvals.tar.Z"></a>
<a href="source/filters/cfdvals/cfdvals.zip">
<img src="../../../../img/zip.gif"
border="0" width="52" height="30"
alt="Archive - cfdvals.zip"></a>
</td>
</tr>
</table>
<br>
</td>
</tr>
<tr>
<td>
<!-- BEGIN CONTENT PAGE -->
<h1>cfd_values</h1>
<h3>Synopsis</h3>
<p>
The User Macro cfd_values computes derived CFD field quantities from base values in the PLOT3D format (density, momentum, and stagnation).
</p>
<h4>Input Ports</h4>
<table class="parameters">
<tr>
<td width="100"><b>Name</b></td>
<td width="100"><b>Type</b></td>
<td width="425"><b>Description</b></td>
</tr>
<tr>
<td colspan="4"><hr></td>
</tr>
<tr>
<td width="100"><i>&in</i></td>
<td width="100">Node_Data[]</td>
<td width="425">Input CFD NodeData multiblock array</td>
</tr>
<tr>
<td colspan="4"><hr></td>
</tr>
</table>
<h4>Parameters</h4>
<p>
The following lists all of the parameters found in the parameter block CFDValsParams, which are accessed by the module CFDValsNodeData and the UI Macro CFDValsUI.
</p>
<table class="parameters">
<tr>
<td width="100"><b>Name</b></td>
<td width="100"><b>Type</b></td>
<td width="300"><b>Description</b></td>
<td width="100"><b>UI Control</b></td>
</tr>
<tr>
<td colspan="4"><hr></td>
</tr>
<tr>
<td width="100"><i>gamma</i></td>
<td width="100">double</td>
<td width="300">gamma constant (default 1.4)</td>
<td width="100">Gamma</td>
</tr>
<tr>
<td width="100"><i>gas_constant</i></td>
<td width="100">double</td>
<td width="300">gas constant (default 1)</td>
<td width="100">Gas Constant</td>
</tr>
<tr>
<td width="100"><i>do_energy</i></td>
<td width="100">boolean</td>
<td width="300">Toggle energy calculation</td>
<td width="100">Energy</td>
</tr>
<tr>
<td width="100"><i>do_pres</i></td>
<td width="100">boolean</td>
<td width="300">Toggle pressure calulation</td>
<td width="100">Pressure</td>
</tr>
<tr>
<td width="100"><i>do_enthalpy</i></td>
<td width="100">boolean</td>
<td width="300">Toggle enthalpy calculation</td>
<td width="100">Enthalpy</td>
</tr>
<tr>
<td width="100"><i>do_mach</i></td>
<td width="100">boolean</td>
<td width="300">Toggle mach number calculation</td>
<td width="100">Mach Number</td>
</tr>
<tr>
<td width="100"><i>do_temp</i></td>
<td width="100">boolean</td>
<td width="300">Toggle temperature calculation</td>
<td width="100">Temperature</td>
</tr>
<tr>
<td width="100"><i>tot_pres</i></td>
<td width="100">boolean</td>
<td width="300">Toggle total pressure calculation</td>
<td width="100">Total Pressure</td>
</tr>
<tr>
<td width="100"><i>tot_temp</i></td>
<td width="100">boolean</td>
<td width="300">Toggle total temperature calculation</td>
<td width="100">Total Temperature</td>
</tr>
<tr>
<td colspan="4"><hr></td>
</tr>
</table>
<h4>Output Ports</h4>
<table class="parameters">
<tr>
<td width="100"><b>Name</b></td>
<td width="100"><b>Type</b></td>
<td width="425"><b>Description</b></td>
</tr>
<tr>
<td colspan="4"><hr></td>
</tr>
<tr>
<td width="100"><i>out</i></td>
<td width="100">Mesh+ Node_Data []</td>
<td width="425">Output CFD Field array</td>
</tr>
<tr>
<td colspan="4"><hr></td>
</tr>
</table>
<h3>Description</h3>
<p>
The module CFDValsNodeData computes derived CFD field quantities from base values in the PLOT3D format. It inputs an array of Structured Fields (5-vector data at nodes)
<ul>
<li>density
<li>x-momentum
<li>y-momentum
<li>z-momentum
<li>stagnation
</ul>
<p>
This module takes input in the form produced by the Read PLOT3D
module, with an array of fields (multiblock) with 5 scalar
components. Based on the toggle parameters, this module
computes numerically derived quantities, usefull for
flow visualization.
</p>
<p>
Two scalar parameters, Gamma and Gas Constant may be set
in the user interface.
</p>
<p>
The field that cfd values receives from read plot3D has the following
5 values: density, X momentum, Y momentum, Z momentum, and stagnation.
</p>
<p>
From these 5 values cfd values computes 7 new values:
<ul>
<li>energy
<li>pressure
<li>enthalpy
<li>mach number
<li>temperature
<li>total pressure
<li>total temp
</ul>
<p>
The gamma constant and the gas constant are user controllable parameters, and the following variables are defined:
</p>
<pre>
d = density
xm = x momentum
ym = y momentum
zm = z momentum
st = stagnation
</pre>
<p>
The equations used to derive the <i>new</i> values are as follows:
</p>
<pre>
energy = stag / d
pressure = (gamma - 1)(stag - ((0.5/d)(xm^2+ym^2+zm^2))
enthalpy = (gamma/(gamma - 1))pressure/d
mach number (M) = square_root(xm^2+ym^2+zm^2)
---------------------------------------
(d * square_root(gamma * pressure /d ))
temperature(T) = pressure / (d * gas constant)
total pressure = pressure * exp(log(x) * gamma/(gamma - 1)
where x = 1 - 0.5(gamma - 1) M * M
total temperature = T(1 + (0.5*(gamma - 1) M * M
</pre>
<p>
Note that, in calculating the 7 derived quantities, cfd values uses
the same assumptions about the non-dimensionality, or normalization,
of data that the National Aeronautics and Space Administration's
PLOT3D, and the read plot3D module themselves use.
</p>
<p>
The min/max range of data is set on all blocks for consistancy.
The module will compile and run in the user or express process.
</p>
<p>
The reader is written in an "omethod" style in C, with
a multi-block (arrays of fields) output data structure.
The DVswitch module can be used to select just one of the blocks
for visualization with Main-Page modules, otherwise use the
ARR modules for multiblock processing.
</p>
<p>
The low level code module takes a parameter block
with default values as input. It only operates on Node_Data,
and ignores the mesh. The user interface is in a separate
macro and can be removed or replaced.
</p>
<h3>Input Ports</h3>
<p>
<i><b>&in</b></i>
</p>
<p>
The input Node_Data array.
</p>
<h3>Parameters</h3>
<p>
<i><b>gamma</b></i>
</p>
<p>
Specifies the gamma value to be used in the equations.
A floating point value between 1 and 5, which determines the
value of the constant. The formulas assume an ideal gas with
a constant ratio of specific heats. The default value is 1.4.
</p>
<p>
<i><b>gas_constant</b></i>
</p>
<p>
Specifies the gas constant value to be used in the equations.
A floating point value between 0 and 5, which determines the
value of the gas constant. The default value is 1.
</p>
<p>
<i><b>do_energy</b></i>
</p>
<p>
Toggle the calculation of the energy.
</p>
<p>
<i><b>do_pres</b></i>
</p>
<p>
Toggle the calculation of the pressure.
</p>
<p>
<i><b>do_enthalpy</b></i>
</p>
<p>
Toggle the calculation of the enthalpy.
</p>
<p>
<i><b>do_mach</b></i>
</p>
<p>
Toggle the calculation of mach number.
</p>
<p>
<i><b>do_temp</b></i>
</p>
<p>
Toggle the calculation of the temperature.
</p>
<p>
<i><b>do_totpres</b></i>
</p>
<p>
Toggle the calculation of the total pressure.
</p>
<p>
<i><b>do_tottemp</b></i>
</p>
<p>
Toggle the calculation of the total temperature.
</p>
<h3>Output Ports</h3>
<p>
<i><b>out</b></i>
</p>
<p>
Output field array with modified Node_Data.
</p>
<h3>Utility Macros</h3>
<p>
The Functional Macro CFDVals and the UI Macro CFDValsUI are used in this User Macro cfd_values. The functional macro contains an instance of the low-level module <a href="doc_mod.shtml" target="_top">CFDValsNodeData</a>.
</p>
<h3>Example</h3>
<p>
An example application CFDValsEg is provided.
</p>
<h3>Files</h3>
<p>
<i>iac_proj/cfdvals/cfdvmacs.v</i> contains the cfd_values User Macro, the CFDVals Functional Macro, the CFDValsUI UI Macro, and the example application CFDValsEg V definitions.
</p>
<h3>Other Notes</h3>
<p>
The CFDValsMacs library inherits its process. As this library contains no procedural code, the process is not important. The low-level CFDValsNodeData module, executes under the process specified in its library, not the process defined in the high-level library.
</p>
<h3>Authors</h3>
<p>
<pre>
Ian Curington, AVS Inc. (March 97)
</pre>
</p>
<h3>Modifications</h3>
<p>
<pre>
Paul G. Lever
</pre>
</p>
<h3>Contact</h3>
<p>
<pre>
International AVS Centre
Manchester Visualization Centre
Manchester Computing
University of Manchester
Oxford Road
Manchester
United Kingdom
M13 9PL
</pre>
</p>
<h3>See Also</h3>
<p>
CFDValsParams, CFDValsUI, CFDVals and <a href="doc_mod.shtml" target="_top">CFDValsNodeData</a>.
</p>
<!-- END CONTENT PAGE -->
</td>
</tr>
</table>
</td>
</tr>
<tr height="100%">
<td class="sideLink" width="25%" align="left" valign="top" nowrap="nowrap">
<p><a href="../../../../general/index.shtml" target="_top">General Information</a></p>
<p><a href="../../../../repository/index.shtml" target="_top">Repositories</a></p>
<p class="sideLinkLevel2"><a href="../../../new/index.shtml" target="_top"> New Releases</a></p>
<p class="sideLinkLevel2"><a href="../../../download/index.shtml" target="_top"> Download</a></p>
<p class="sideLinkLevel2"><a href="../../../submit/index.shtml" target="_top"> Submit</a></p>
<p class="sideLinkLevel2"><a href="../../../pfiles/index.shtml" target="_top"> Project Files</a></p>
<p class="sideLinkLevel2"><a href="../../../avs5/index.shtml" target="_top"> AVS5</a></p>
<p class="sideLinkLevel2"><a href="../../../express/index.shtml" target="_top"> AVS/Express</a></p>
<p class="sideLinkLevel3"><a href="../../atoz.shtml" target="_top"> A to Z</a></p>
<p class="sideLinkLevel3"><a href="../../number.shtml" target="_top"> Project #</a></p>
<p></p>
<p class="sideLinkLevel3"><a href="../../data_io.shtml" target="_top"> Data IO</a></p>
<p class="sideLinkLevel3"><a href="../../filters.shtml" target="_top"> Filters</a></p>
<p class="sideLinkLevel3"><a href="../../mappers.shtml" target="_top"> Mappers</a></p>
<p class="sideLinkLevel3"><a href="../../misc.shtml" target="_top"> Miscellaneous</a></p>
<p class="sideLinkLevel3"><a href="../../special.shtml" target="_top"> Special Projects</a></p>
<p class="sideLinkLevel2"><a href="../../../pog/index.shtml" target="_top"> Project Guidelines</a></p>
<p><a href="../../../../usergroup/index.shtml" target="_top">User Group</a></p>
<p><a href="../../../../training/index.shtml" target="_top">Training Materials</a></p>
</td>
</tr>
</table>
<table width="100%" border="0" cellspacing="0" cellpadding="0" bgcolor="c6c6e0">
<tr>
<td><img src="../../../../img/foot1.gif" alt="IAC" width="155" height="25"></td>
<td width="100%"> Last Updated:
<!-- #BeginEditable "date-stamp" -->
26th November 2002
<!-- #EndEditable --></td>
</tr>
</table>
]]>