CFD_VAR Schema

Parent Previous Next

CFD_VAR Schema

The idea here is that datasets use differently named variables for the same entities.  This makes it difficult for EnSight to "guess" that a variable might be pressure or density.  As a result, it is difficult to write GUI utilities that provide domain specific computation with datasets from different formats.  The CFD_VAR schema defines some fundamental variable quantities and tags the variables to let the GUI know that while this variable might be named "HELLO", it should be treated as "CFD_Velocity".  The schema includes a tag 'CFD_VAR' that is specified on the case object itself that reports that the case supports the schema and the version number of the schema employed.

Notes: It would be nice if the Meta Data included a way to tell it which direction was the axial_direction for use with RectToCyl to define the coordinate transformation X, Y, or Z, default is Z).  It would also be nice to define things like symmetry plane so that symmetry could be automatically turned on.

Note: if you use a format that supports CFD_VAR schema (EnSight or Fluent), then you must turn it on.  To turn it on, click on the User Defined Tools icon. Then open the Utilities folder. Then double click the Extended CFD variables. Then in that pop up window choose on File>Enable. This pop up window will tell you all the CFD variables which the schema is capable of enabling.

Dependencies

There are a number of variable quantities defined by the schema and they are listed here, along with their dependencies (in parenthesis) and the formulas.  One interesting feature of this schema is that there is an extension that can automatically figure out what other CFD variables can be computed based on the tagged variables present in the variable list.  For example, if the extension detects the presence of "Pressure_absolute", "Temperature", and "Density", it can automatically generate an "R_mass" variable for the user, using the table below.  The extension is also capable of chaining expressions from the table, using two or more sub-expressions to create the final variable.

Units are described as M=mass, L=length, K=temperature, T=time.  The first description of each variable has a => with units.

Example XML mapping for Fluent

<CEImetadata version="1.0">
  <vars>
    <metatags>
      <tag name="CFD_VAR" type="str"></tag>
    </metatags>
    <varlist>
      <var name="DENSITY" CFD_VAR="Density"></var>
      <var name="VELOCITY" CFD_VAR="Velocity"></var>
      <var name="TEMPERATURE" CFD_VAR="Temperature"></var>
      <var name="Pressure_Relative" CFD_VAR="Pressure_relative"></var>
      <var name="Pressure_stagnation" CFD_VAR="Pressure_stagnation"></var>
      <var name="Pressure_absolute" CFD_VAR="Pressure_absolute"></var>
      <var name="Temperature_stagnation" CFD_VAR="Temperature_stagnation"></var>
      <var name="DENSITY_FAR" CFD_VAR="Density_far"></var>
      <var name="SPEED_SOUND_FAR" CFD_VAR="Speed_sound_far"></var>
      <var name="PRESSURE_FAR" CFD_VAR="Pressure_far"></var>
      <var name="Mach" CFD_VAR="Mach"></var>
      <var name="BODY_FORCES" CFD_VAR="Wall_total_force"></var>
      <var name="MU_LAM" CFD_VAR="Viscosity_laminar"></var>
      <var name="MU_TURB" CFD_VAR="Viscosity_turbulent"></var>
      <var name="TED" CFD_VAR="Turbulence_eddy_dissipation"></var>
      <var name="TKE" CFD_VAR="Turbulence_kinetic_energy"></var>
      <var name="YPLUS" CFD_VAR="Yplus"></var>
      <var name="WALL_SHEAR_FORCE" CFD_VAR="Wall_shear_force"></var>
      <var name="Gamma_ref" CFD_VAR="Gamma_ref"></var>
      <var name="PRESSURE_ABS_INIT" CFD_VAR="Pressure_absolute_const"></var>
      <var name="R_ref" CFD_VAR="R_ref"></var>
      <var name="Gamma" CFD_VAR="Gamma "></var>
      <var name="R_universal" CFD_VAR="R_univ"></var>
      <var name="R_mass" CFD_VAR="R_mass"></var>
      <var name="Cp_mass" CFD_VAR="Cp_mass"></var>
      <var name="Vorticity" CFD_VAR="Vorticity"></var>
      <var name="Velocity_grad" CFD_VAR="Velocity_grad"></var>
      <var name="Velocity_x_grad" CFD_VAR="Velocity_x_grad"></var>
      <var name="Velocity_y_grad" CFD_VAR="Velocity_y_grad"></var>
      <var name="Velocity_z_grad" CFD_VAR="Velocity_z_grad"></var>
      <var name="Pressure_grad" CFD_VAR="Pressure_grad"></var>
      <var name="Element_size" CFD_VAR="Element_size"></var>
      <var name="Wall_pressure_force" CFD_VAR="Wall_pressure_force"></var>
      <var name="VELOCITY_X" CFD_VAR="Velocity_x"></var>
      <var name="VELOCITY_Y" CFD_VAR="Velocity_y"></var>
      <var name="VELOCITY_Z" CFD_VAR="Velocity_z"></var>
      <var name="COORDINATE_X" CFD_VAR="Coordinate_x"></var>
      <var name="COORDINATE_Y" CFD_VAR="Coordinate_y"></var>
      <var name="COORDINATE_Z" CFD_VAR="Coordinate_z"></var>
      <var name="Velocity_axial" CFD_VAR="Velocity_axial"></var>
      <var name="Velocity_radial" CFD_VAR="Velocity_radial"></var>
      <var name="Velocity_tangential" CFD_VAR="Velocity_tangential"></var>
      <var name="Coordinates_axial" CFD_VAR="Coordinates_axial"></var>
      <var name="Coordinates_radial" CFD_VAR="Coordinates_radial"></var>
      <var name="Coordinates_tangential" CFD_VAR="Coordinates_tangential"></var>
      <var name="Energy_total" CFD_VAR="Energy_total"></var>
      <var name="Speed_sound" CFD_VAR="Speed_sound"></var>
    </varlist>
  </vars>
  <case>
    <metatags>
      <tag name="CFD_VAR" type="flt">1.0</tag>
      <tag name="CFD_CYLINDRICAL_AXIS" type="str">Z</tag>
    </metatags>
  </case>
</CEImetadata>

 

Example XML mapping for STARCCM Plus

STAR3 - discontinued around 2003. Export EnSight Case Gold to read.

STAR4 = STARCCM - transition product between 3 and plus uses .ccm. Can be read by VKI.

STARCCM Plus is fifth generation product released 2004. Cannot be read by VKI (3/09), users must export case gold. uses .sim file.

All three export EnSight case gold and all name variables differently. This work is for STARCCM Plus.

 

<CEImetadata version="1.0">
<vars>
  <metatags>
    <tag name="CFD_VAR" type="str"></tag>
  </metatags>
  <varlist>
    <var name="Density" CFD_VAR="Density"></var>
    <var name="Velocity" CFD_VAR="Velocity"></var>
    <var name="Pressure" CFD_VAR="Pressure_relative"></var>
    <var name="TotalPressure" CFD_VAR="Pressure_stagnation"></var>
    <var name="AbsolutePressure" CFD_VAR="Pressure_absolute"></var>
    <var name="WallYplus" CFD_VAR="Yplus"></var>
    <var name="WallShearStress" CFD_VAR="Wall_shear_stress"></var>
    <var name="VorticityVector" CFD_VAR="Vorticity"></var>
    <var name="Temperature" CFD_VAR="Temperature"></var>
    <var name="TotalTemperature" CFD_VAR="Temperature_stagnation"></var>
    <var name="MachNumber" CFD_VAR="Mach"></var>
    <var name="LaminarViscosity" CFD_VAR="Viscosity_laminar"></var>
    <var name="TurbulentViscosity" CFD_VAR="Viscosity_turbulent"></var>
    <var name="TurbDissipationRate" CFD_VAR="Turbulence_eddy_dissipation"></var>
    <var name="TurbKineticEnergy" CFD_VAR="Turbulence_kinetic_energy"></var>
 
    <var name="EltDensity" CFD_VAR="Density"></var>
    <var name="EltVelocity" CFD_VAR="Velocity"></var>
    <var name="EltPressure" CFD_VAR="Pressure_relative"></var>
    <var name="EltAbsTotalPressure" CFD_VAR="Pressure_stagnation"></var>
    <var name="EltAbsolutePressure" CFD_VAR="Pressure_absolute"></var>
    <var name="EltWallYplus" CFD_VAR="Yplus"></var>
    <var name="EltWallShearStress" CFD_VAR="Wall_shear_stress"></var>
    <var name="EltVorticityVector" CFD_VAR="Vorticity"></var>
    <var name="EltTemperature" CFD_VAR="Temperature"></var>
    <var name="EltTotalTemperature" CFD_VAR="Temperature_stagnation"></var>
    <var name="EltMachNumber" CFD_VAR="Mach"></var>
    <var name="EltLaminarViscosity" CFD_VAR="Viscosity_laminar"></var>
    <var name="EltTurbulentViscosi" CFD_VAR="Viscosity_turbulent"></var>
    <var name="EltTurbDissipationR" CFD_VAR="Turbulence_eddy_dissipation"></var>
    <var name="EltTurbKineticEnerg" CFD_VAR="Turbulence_kinetic_energy"></var>
    <var name="Gamma_ref" CFD_VAR="Gamma_ref"></var>
    <var name="Pressure_abs_const" CFD_VAR="Pressure_absolute_const"></var>
    <var name="R_ref" CFD_VAR="R_ref"></var>
    <var name="R_universal" CFD_VAR="R_univ"></var>
    <var name="R_mass" CFD_VAR="R_mass"></var>
 
    <var name="Velocity_grad" CFD_VAR="Velocity_grad"></var>
    <var name="Velocity_x_grad" CFD_VAR="Velocity_x_grad"></var>
    <var name="Velocity_y_grad" CFD_VAR="Velocity_y_grad"></var>
    <var name="Velocity_z_grad" CFD_VAR="Velocity_z_grad"></var>
    <var name="Pressure_grad" CFD_VAR="Pressure_grad"></var>
    <var name="Element_size" CFD_VAR="Element_size"></var>
    <var name="Wall_pressure_force" CFD_VAR="Wall_pressure_force"></var>
 
    <var name="Velocity_X" CFD_VAR="Velocity_x"></var>
    <var name="Velocity_Y" CFD_VAR="Velocity_y"></var>
    <var name="Velocity_Z" CFD_VAR="Velocity_z"></var>
    <var name="Coordinate_X" CFD_VAR="Coordinate_x"></var>
    <var name="Coordinate_Y" CFD_VAR="Coordinate_y"></var>
    <var name="Coordinate_Z" CFD_VAR="Coordinate_z"></var>
    <var name="AxialVelocity" CFD_VAR="Velocity_axial"></var>
    <var name="RadialVelocity" CFD_VAR="Velocity_radial"></var>
    <var name="TangentialVelocity" CFD_VAR="Velocity_tangential"></var>
    <var name="Coordinates_axial" CFD_VAR="Coordinates_axial"></var>
    <var name="Coordinates_radial" CFD_VAR="Coordinates_radial"></var>
    <var name="Coordinates_tangential" CFD_VAR="Coordinates_tangential"></var>
    <var name="Energy_total" CFD_VAR="Energy_total"></var>
    <var name="Speed_sound" CFD_VAR="Speed_sound"></var>
 
  </varlist>
</vars>
<case>
  <metatags>
    <tag name="CFD_VAR" type="flt">1.0</tag>
    <tag name="CFD_CYLINDRICAL_AXIS" type="str">Z</tag>
  </metatags>
</case>
</CEImetadata>

 

Example XML mapping for CFX5

<CEImetadata version="1.0">
<vars>
  <metatags>
    <tag name="CFD_VAR" type="str"></tag>
  </metatags>
  <varlist>
    <var name="Density" CFD_VAR="Density"></var>
    <var name="Velocity" CFD_VAR="Velocity"></var>
    <var name="Pressure" CFD_VAR="Pressure_relative"></var>
    <var name="TotalPressure" CFD_VAR="Pressure_stagnation"></var>
    <var name="AbsolutePressure" CFD_VAR="Pressure_absolute"></var>
    <var name="WallYplus" CFD_VAR="Yplus"></var>
    <var name="WallShearStress" CFD_VAR="Wall_shear_stress"></var>
    <var name="VorticityVector" CFD_VAR="Vorticity"></var>
    <var name="Temperature" CFD_VAR="Temperature"></var>
    <var name="TotalTemperature" CFD_VAR="Temperature_stagnation"></var>
    <var name="MachNumber" CFD_VAR="Mach"></var>
    <var name="LaminarViscosity" CFD_VAR="Viscosity_laminar"></var>
    <var name="TurbulentViscosity" CFD_VAR="Viscosity_turbulent"></var>
    <var name="TurbDissipationRate" CFD_VAR="Turbulence_eddy_dissipation"></var>
    <var name="TurbKineticEnergy" CFD_VAR="Turbulence_kinetic_energy"></var>
 
    <var name="EltDensity" CFD_VAR="Density"></var>
    <var name="EltVelocity" CFD_VAR="Velocity"></var>
    <var name="EltPressure" CFD_VAR="Pressure_relative"></var>
    <var name="EltAbsTotalPressure" CFD_VAR="Pressure_stagnation"></var>
    <var name="EltAbsolutePressure" CFD_VAR="Pressure_absolute"></var>
    <var name="EltWallYplus" CFD_VAR="Yplus"></var>
    <var name="EltWallShearStress" CFD_VAR="Wall_shear_stress"></var>
    <var name="EltVorticityVector" CFD_VAR="Vorticity"></var>
    <var name="EltTemperature" CFD_VAR="Temperature"></var>
    <var name="EltTotalTemperature" CFD_VAR="Temperature_stagnation"></var>
    <var name="EltMachNumber" CFD_VAR="Mach"></var>
    <var name="EltLaminarViscosity" CFD_VAR="Viscosity_laminar"></var>
    <var name="EltTurbulentViscosi" CFD_VAR="Viscosity_turbulent"></var>
    <var name="EltTurbDissipationR" CFD_VAR="Turbulence_eddy_dissipation"></var>
    <var name="EltTurbKineticEnerg" CFD_VAR="Turbulence_kinetic_energy"></var>
    <var name="Gamma_ref" CFD_VAR="Gamma_ref"></var>
    <var name="Pressure_abs_const" CFD_VAR="Pressure_absolute_const"></var>
    <var name="R_ref" CFD_VAR="R_ref"></var>
    <var name="R_universal" CFD_VAR="R_univ"></var>
    <var name="R_mass" CFD_VAR="R_mass"></var>
 
    <var name="Velocity_grad" CFD_VAR="Velocity_grad"></var>
    <var name="Velocity_x_grad" CFD_VAR="Velocity_x_grad"></var>
    <var name="Velocity_y_grad" CFD_VAR="Velocity_y_grad"></var>
    <var name="Velocity_z_grad" CFD_VAR="Velocity_z_grad"></var>
    <var name="Pressure_grad" CFD_VAR="Pressure_grad"></var>
    <var name="Element_size" CFD_VAR="Element_size"></var>
    <var name="Wall_pressure_force" CFD_VAR="Wall_pressure_force"></var>
 
    <var name="Velocity_X" CFD_VAR="Velocity_x"></var>
    <var name="Velocity_Y" CFD_VAR="Velocity_y"></var>
    <var name="Velocity_Z" CFD_VAR="Velocity_z"></var>
    <var name="Coordinate_X" CFD_VAR="Coordinate_x"></var>
    <var name="Coordinate_Y" CFD_VAR="Coordinate_y"></var>
    <var name="Coordinate_Z" CFD_VAR="Coordinate_z"></var>
    <var name="AxialVelocity" CFD_VAR="Velocity_axial"></var>
    <var name="RadialVelocity" CFD_VAR="Velocity_radial"></var>
    <var name="TangentialVelocity" CFD_VAR="Velocity_tangential"></var>
    <var name="Coordinates_axial" CFD_VAR="Coordinates_axial"></var>
    <var name="Coordinates_radial" CFD_VAR="Coordinates_radial"></var>
    <var name="Coordinates_tangential" CFD_VAR="Coordinates_tangential"></var>
    <var name="Energy_total" CFD_VAR="Energy_total"></var>
    <var name="Speed_sound" CFD_VAR="Speed_sound"></var>
 
  </varlist>
</vars>
<case>
  <metatags>
    <tag name="CFD_VAR" type="flt">1.0</tag>
    <tag name="CFD_CYLINDRICAL_AXIS" type="str">Z</tag>
  </metatags>
</case>
</CEImetadata>