ParaView/Users Guide/List of readers: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
No edit summary
Line 47: Line 47:


|}
==BYU Reader==
Read Movie.BYU files to produce polygonal data.
The BYU reader reads data stored in Movie.BYU format. The expected file extension is .g. The datasets resulting from reading these files are polygonal.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
This property specifies the file name for the BYU reader.
| �
| �
|}
|}


Line 212: Line 235:




==Enzo Reader==
==EnSight Master Server Reader==




Read multi-block dataset from an Enzo file.
Read files in EnSight's Master Server format.


This Enzo reader loads data stored in Enzo format. The output of this reader is a multi-block dataset.<br>
The EnSight Master Server reader reads EnSight's parallel files. The master file ususally has a .sos extension and may point to multiple .case files. The output is a multi-block dataset.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 226: Line 249:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Block Output Type'''<br>''(BlockOutputType)''
| '''Byte Order'''<br>''(ByteOrder)''
|
|
The property indicates the output type of each block, either vtkImageData (by default) or vtkRectilinearGrid.
This property indicates the byte order of the binary file(s).


| 0
| 0
|
|
The value must be one of the following: Image Data (0), Rectilinear Grid (1).
The value must be one of the following: BigEndian (0), LittleEndian (1).


|-
|-
| '''File Name'''<br>''(FileName)''
| '''Case File Name'''<br>''(CaseFileName)''
|
|
This property specifies the file name for the Enzo reader.
This property specifies the name of the .sos file for the EnSight Master Server reader.


| �
| �
| �
| �
|-
|-
| '''Load Particles'''<br>''(LoadParticles)''
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
|
Load particles when on.
This property lists which cell-centered arrays to read.


| 1
|
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.
 
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
 
| �
|
The list of array names is provided by the reader.


|-
|-
| '''Max Level'''<br>''(MaxLevel)''
| '''Set Time Value'''<br>''(SetTimeValue)''
|
|
Do not blocks above this level.
This property indicates which time value to read.


| 100
| 0
| �
| �
|}
|}




==ExodusIIReader==
==EnSight Reader==




Read an Exodus II file to produce an unstructured grid.
Read EnSight 6 and Gold files.


The Exodus reader loads Exodus II files and produces an unstructured grid output. The default file extensions are .g, .e, .ex2, .ex2v2, .exo, .gen, .exoII, .exii, .0, .00, .000, and .0000 .<br>
The EnSight reader reads files in the format produced by CEI's EnSight. EnSight 6 and Gold files (both ASCII and binary) are supported. The default extension is .case. The output of this reader is a multi-block dataset.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 276: Line 309:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
| '''Case File Name'''<br>''(CaseFileName)''
|
|
This property specifies the file name for the Exodus reader.
This property specifies the case file name for the EnSight reader.


| �
| �
| �
| �
|-
|-
| '''Use Meta File'''<br>''(UseMetaFile)''
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
|
This hidden property must always be set to 1 for this proxy to work.
This property lists which cell-centered arrays to read.


| 0
|
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.


|-
|-
| '''Animate Vibrations'''<br>''(AnimateVibrations)''
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
|
If this flag is on and HasModeShapes is also on, then this reader
This property lists which point-centered arrays to read.
will report a continuous time range [0,1] and animate the
 
displacements in a periodic sinusoid.  If this flag is off and
|
HasModeShapes is on, this reader ignores time.  This flag has no
effect if HasModeShapes is off.
 
| 1
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.


|}
==Enzo Reader==
Read multi-block dataset from an Enzo file.
This Enzo reader loads data stored in Enzo format. The output of this reader is a multi-block dataset.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Apply Displacements'''<br>''(ApplyDisplacements)''
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Block Output Type'''<br>''(BlockOutputType)''
|
|
Geometric locations can include displacements. When this option is on, the nodal positions are 'displaced' by the standard exodus displacement vector. If displacements are turned 'off', the user can explicitly add them by applying a warp filter.
The property indicates the output type of each block, either vtkImageData (by default) or vtkRectilinearGrid.


| 1
| 0
|
|
Only the values 0 and 1 are accepted.
The value must be one of the following: Image Data (0), Rectilinear Grid (1).


|-
|-
| '''Displacement Magnitude'''<br>''(DisplacementMagnitude)''
| '''File Name'''<br>''(FileName)''
|
|
When displacements are being applied, they are scaled by this amount.  Set to 1 for no scaling.
This property specifies the file name for the Enzo reader.


| 1
|
| �
| �
|-
|-
| '''Edge Blocks'''<br>''(EdgeBlocks)''
| '''Load Particles'''<br>''(LoadParticles)''
| �
| �
|
|
The list of array names is provided by the reader.
Load particles when on.


| 1
|-
| '''Edge Map Array Status'''<br>''(EdgeMapArrayStatus)''
| �
| �
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


|-
|-
| '''Edge Set Array Status'''<br>''(EdgeSetArrayStatus)''
| '''Max Level'''<br>''(MaxLevel)''
| �
| �
|
|
The list of array names is provided by the reader.
Do not blocks above this level.


| 100
|-
| '''Edge Set Result Array Status'''<br>''(EdgeSetResultArrayStatus)''
| �
| �
|
|}
|
The list of array names is provided by the reader.


|-
| '''Edge Variables'''<br>''(EdgeVariables)''
| �
| �
|
The list of array names is provided by the reader.


==ExodusIIReader==
 
 
Read an Exodus II file to produce an unstructured grid.
 
The Exodus reader loads Exodus II files and produces an unstructured grid output. The default file extensions are .g, .e, .ex2, .ex2v2, .exo, .gen, .exoII, .exii, .0, .00, .000, and .0000 .<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Element Blocks'''<br>''(ElementBlocks)''
| '''File Name'''<br>''(FileName)''
|
|
This property specifies the file name for the Exodus reader.
 
| �
| �
| �
| �
|-
|-
| '''Element Map Array Status'''<br>''(ElementMapArrayStatus)''
| '''Use Meta File'''<br>''(UseMetaFile)''
| �
| �
|
|
The list of array names is provided by the reader.
This hidden property must always be set to 1 for this proxy to work.


| 0
|-
| '''Element Set Array Status'''<br>''(ElementSetArrayStatus)''
| �
| �
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


|-
|-
| '''Element Set Result Array Status'''<br>''(ElementSetResultArrayStatus)''
| '''Animate Vibrations'''<br>''(AnimateVibrations)''
|
|
|
If this flag is on and HasModeShapes is also on, then this reader
will report a continuous time range [0,1] and animate the
displacements in a periodic sinusoid.  If this flag is off and
HasModeShapes is on, this reader ignores time.  This flag has no
effect if HasModeShapes is off.
 
| 1
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


|-
|-
| '''Element Variables'''<br>''(ElementVariables)''
| '''Apply Displacements'''<br>''(ApplyDisplacements)''
|
|
|
Geometric locations can include displacements. When this option is on, the nodal positions are 'displaced' by the standard exodus displacement vector. If displacements are turned 'off', the user can explicitly add them by applying a warp filter.
 
| 1
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


|-
|-
| '''Exodus Model Metadata'''<br>''(ExodusModelMetadata)''
| '''Displacement Magnitude'''<br>''(DisplacementMagnitude)''
| �
| 0
|
|
Only the values 0 and 1 are accepted.
When displacements are being applied, they are scaled by this amount.  Set to 1 for no scaling.


| 1
|
|-
|-
| '''Face Blocks'''<br>''(FaceBlocks)''
| '''Edge Blocks'''<br>''(EdgeBlocks)''
| �
| �
| �
| �
Line 417: Line 458:
|-
|-
| '''Face Map Array Status'''<br>''(FaceMapArrayStatus)''
| '''Edge Map Array Status'''<br>''(EdgeMapArrayStatus)''
| �
| �
| �
| �
Line 425: Line 466:
|-
|-
| '''Face Set Array Status'''<br>''(FaceSetArrayStatus)''
| '''Edge Set Array Status'''<br>''(EdgeSetArrayStatus)''
| �
| �
| �
| �
Line 433: Line 474:
|-
|-
| '''Face Set Result Array Status'''<br>''(FaceSetResultArrayStatus)''
| '''Edge Set Result Array Status'''<br>''(EdgeSetResultArrayStatus)''
| �
| �
| �
| �
Line 441: Line 482:
|-
|-
| '''Face Variables'''<br>''(FaceVariables)''
| '''Edge Variables'''<br>''(EdgeVariables)''
| �
| �
| �
| �
Line 449: Line 490:
|-
|-
| '''File Pattern'''<br>''(FilePattern)''
| '''Element Blocks'''<br>''(ElementBlocks)''
|
|
This property contains a text string specifying the pattern used to load files. There are two parts to it: the prefix (%s) and the file number (%i). The format used is the same as that used for printf.
 
| �
| �
| �
| �
|-
|-
| '''File Prefix'''<br>''(FilePrefix)''
| '''Element Map Array Status'''<br>''(ElementMapArrayStatus)''
|
This property specifies the file root used with the file pattern to format a file name. (See the File Pattern property.)
 
| �
| �
| �
| �
|-
| '''File Range'''<br>''(FileRange)''
|
|
This property controls the indices of the first and last files to be read.
The list of array names is provided by the reader.


| -1 -1
|-
| '''Element Set Array Status'''<br>''(ElementSetArrayStatus)''
| �
| �
|-
| '''Generate Global Element Id Array'''<br>''(GenerateGlobalElementIdArray)''
| �
| �
| 1
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.


|-
|-
| '''Generate Global Node Id Array'''<br>''(GenerateGlobalNodeIdArray)''
| '''Element Set Result Array Status'''<br>''(ElementSetResultArrayStatus)''
| �
| �
| �
| 1
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.


|-
|-
| '''Generate Object Id Cell Array'''<br>''(GenerateObjectIdCellArray)''
| '''Element Variables'''<br>''(ElementVariables)''
| �
| 1
|
Only the values 0 and 1 are accepted.
 
|-
| '''Global Variables'''<br>''(GlobalVariables)''
| �
| �
| �
| �
Line 502: Line 527:
|-
|-
| '''Has Mode Shapes'''<br>''(HasModeShapes)''
| '''Exodus Model Metadata'''<br>''(ExodusModelMetadata)''
|
|
Some simulations overload the Exodus time steps to represent mode
shapes.  In this case, it does not make sense to iterate over the
"time steps", because they are not meant to be played in order.
Rather, each represents the vibration at a different "mode."
Setting the value of this property to 1 changes the semantics of the reader to not
report the time steps to downstream filters.
 
| 0
| 0
|
|
Line 517: Line 535:
|-
|-
| '''Mode Shape'''<br>''(ModeShape)''
| '''Face Blocks'''<br>''(FaceBlocks)''
|
Specify the current mode shape when HasModeShapes in on.
 
| 1
| �
|-
| '''Node Map Array Status'''<br>''(NodeMapArrayStatus)''
| �
| �
| �
| �
Line 532: Line 543:
|-
|-
| '''Node Set Array Status'''<br>''(NodeSetArrayStatus)''
| '''Face Map Array Status'''<br>''(FaceMapArrayStatus)''
| �
| �
| �
| �
Line 540: Line 551:
|-
|-
| '''Node Set Result Array Status'''<br>''(NodeSetResultArrayStatus)''
| '''Face Set Array Status'''<br>''(FaceSetArrayStatus)''
| �
| �
| �
| �
Line 548: Line 559:
|-
|-
| '''Point Variables'''<br>''(PointVariables)''
| '''Face Set Result Array Status'''<br>''(FaceSetResultArrayStatus)''
| �
| �
| �
| �
Line 556: Line 567:
|-
|-
| '''Side Set Array Status'''<br>''(SideSetArrayStatus)''
| '''Face Variables'''<br>''(FaceVariables)''
| �
| �
| �
| �
Line 564: Line 575:
|-
|-
| '''Side Set Result Array Status'''<br>''(SideSetResultArrayStatus)''
| '''File Pattern'''<br>''(FilePattern)''
|
This property contains a text string specifying the pattern used to load files. There are two parts to it: the prefix (%s) and the file number (%i). The format used is the same as that used for printf.
 
| �
| �
| �
| �
|
The list of array names is provided by the reader.
|-
|-
| '''XML File Name'''<br>''(XMLFileName)''
| '''File Prefix'''<br>''(FilePrefix)''
|
|
This property specifies the name of an XML file containing part and material descriptions and a mapping to element blocks.
This property specifies the file root used with the file pattern to format a file name. (See the File Pattern property.)


| �
| �
| �
| �
|}
==Restarted Sim Exodus Reader==
Read collections of Exodus output files from simulations that were restarted.
When a simulation that outputs exodus files is restarted, typically you get a new set of output files.  When you read them in your visualization, you often want to string these file sets together as if it was one continuous dump of files.  This reader allows you to specify a metadata file that will implicitly string the files together.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''File Range'''<br>''(FileRange)''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
|
This points to a special metadata file that lists the output files for each restart.
This property controls the indices of the first and last files to be read.


|
| -1 -1
| �
| �
|-
|-
| '''Use Meta File'''<br>''(UseMetaFile)''
| '''Generate Global Element Id Array'''<br>''(GenerateGlobalElementIdArray)''
|
|
This hidden property must always be set to 1 for this proxy to work.
 
| 1
| 1
|
|
Line 612: Line 604:
|-
|-
| '''Animate Vibrations'''<br>''(AnimateVibrations)''
| '''Generate Global Node Id Array'''<br>''(GenerateGlobalNodeIdArray)''
|
|
If this flag is on and HasModeShapes is also on, then this reader
will report a continuous time range [0,1] and animate the
displacements in a periodic sinusoid.  If this flag is off and
HasModeShapes is on, this reader ignores time.  This flag has no
effect if HasModeShapes is off.
 
| 1
| 1
|
|
Line 626: Line 612:
|-
|-
| '''Apply Displacements'''<br>''(ApplyDisplacements)''
| '''Generate Object Id Cell Array'''<br>''(GenerateObjectIdCellArray)''
|
|
Geometric locations can include displacements. When this option is on, the nodal positions are 'displaced' by the standard exodus displacement vector. If displacements are turned 'off', the user can explicitly add them by applying a warp filter.
 
| 1
| 1
|
|
Line 636: Line 620:
|-
|-
| '''Displacement Magnitude'''<br>''(DisplacementMagnitude)''
| '''Global Variables'''<br>''(GlobalVariables)''
|
When displacements are being applied, they are scaled by this amount.  Set to 1 for no scaling.
 
| 1
| �
|-
| '''Edge Blocks'''<br>''(EdgeBlocks)''
| �
| �
| �
| �
Line 651: Line 628:
|-
|-
| '''Edge Map Array Status'''<br>''(EdgeMapArrayStatus)''
| '''Has Mode Shapes'''<br>''(HasModeShapes)''
| �
| �
|
|
The list of array names is provided by the reader.
Some simulations overload the Exodus time steps to represent mode
shapes.  In this case, it does not make sense to iterate over the
"time steps", because they are not meant to be played in order.
Rather, each represents the vibration at a different "mode."
Setting the value of this property to 1 changes the semantics of the reader to not
report the time steps to downstream filters.
 
| 0
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Edge Set Array Status'''<br>''(EdgeSetArrayStatus)''
| '''Mode Shape'''<br>''(ModeShape)''
| �
| �
|
|
The list of array names is provided by the reader.
Specify the current mode shape when HasModeShapes in on.


| 1
|
|-
|-
| '''Edge Set Result Array Status'''<br>''(EdgeSetResultArrayStatus)''
| '''Node Map Array Status'''<br>''(NodeMapArrayStatus)''
| �
| �
| �
| �
Line 675: Line 658:
|-
|-
| '''Edge Variables'''<br>''(EdgeVariables)''
| '''Node Set Array Status'''<br>''(NodeSetArrayStatus)''
| �
| �
| �
| �
Line 683: Line 666:
|-
|-
| '''Element Blocks'''<br>''(ElementBlocks)''
| '''Node Set Result Array Status'''<br>''(NodeSetResultArrayStatus)''
| �
| �
| �
|-
| '''Element Map Array Status'''<br>''(ElementMapArrayStatus)''
| �
| �
| �
| �
Line 696: Line 674:
|-
|-
| '''Element Set Array Status'''<br>''(ElementSetArrayStatus)''
| '''Point Variables'''<br>''(PointVariables)''
| �
| �
| �
| �
Line 704: Line 682:
|-
|-
| '''Element Set Result Array Status'''<br>''(ElementSetResultArrayStatus)''
| '''Side Set Array Status'''<br>''(SideSetArrayStatus)''
| �
| �
| �
| �
Line 712: Line 690:
|-
|-
| '''Element Variables'''<br>''(ElementVariables)''
| '''Side Set Result Array Status'''<br>''(SideSetResultArrayStatus)''
| �
| �
| �
| �
Line 720: Line 698:
|-
|-
| '''Exodus Model Metadata'''<br>''(ExodusModelMetadata)''
| '''XML File Name'''<br>''(XMLFileName)''
| �
| 0
|
|
Only the values 0 and 1 are accepted.
This property specifies the name of an XML file containing part and material descriptions and a mapping to element blocks.


|-
| '''Face Blocks'''<br>''(FaceBlocks)''
| �
| �
| �
| �
|}
==FLUENTReader==
Reads a dataset in Fluent file format.
FLUENTReader creates an unstructured grid dataset. It reads .cas and<br>
.dat files stored in FLUENT native format.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
|
The list of array names is provided by the reader.
Select which cell-centered arrays to read.


|-
| '''Face Map Array Status'''<br>''(FaceMapArrayStatus)''
| �
| �
| �
|
|
Line 744: Line 732:
|-
|-
| '''Face Set Array Status'''<br>''(FaceSetArrayStatus)''
| '''File Name'''<br>''(FileName)''
|
Set the file  name for the FLUENT reader.
 
| �
| �
| �
| �
|}
==Flash Reader==
Read multi-block dataset from a Flash file.
This Flash reader loads data stored in Flash format. The output of this reader is a multi-block dataset.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Block Output Type'''<br>''(BlockOutputType)''
|
|
The list of array names is provided by the reader.
The property indicates the output type of each block, either vtkImageData (by default) or vtkRectilinearGrid.
 
| 0
|
The value must be one of the following: Image Data (0), Rectilinear Grid (1).


|-
|-
| '''Face Set Result Array Status'''<br>''(FaceSetResultArrayStatus)''
| '''File Name'''<br>''(FileName)''
| �
| �
|
|
The list of array names is provided by the reader.
This property specifies the file name for the Flash reader.


|-
| '''Face Variables'''<br>''(FaceVariables)''
| �
| �
| �
| �
|-
| '''Load Morton Curve'''<br>''(LoadMortonCurve)''
|
|
The list of array names is provided by the reader.
Generate morton curve when on.


| 0
|-
| '''Generate Global Element Id Array'''<br>''(GenerateGlobalElementIdArray)''
| �
| 1
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.
Line 776: Line 782:
|-
|-
| '''Generate Global Node Id Array'''<br>''(GenerateGlobalNodeIdArray)''
| '''Load Particles'''<br>''(LoadParticles)''
| �
| 1
|
|
Only the values 0 and 1 are accepted.
Load particles when on.


|-
| '''Generate Object Id Cell Array'''<br>''(GenerateObjectIdCellArray)''
| �
| 1
| 1
|
|
Line 791: Line 791:


|-
|}
| '''Global Variables'''<br>''(GlobalVariables)''
 
| �
 
| �
==Gaussian Cube Reader==
|
 
The list of array names is provided by the reader.
 
Produce polygonal data by reading a Gaussian Cube file.
 
The Gaussian Cube reader produces polygonal data by reading data files produced by the Gaussian software package. The expected file extension is .cube.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Has Mode Shapes'''<br>''(HasModeShapes)''
| '''Property'''
|
| '''Description'''
Some simulations overload the Exodus time steps to represent mode
| '''Default Value(s)'''
shapes.  In this case, it does not make sense to iterate over the
| '''Restrictions'''
"time steps", because they are not meant to be played in order.
Rather, each represents the vibration at a different "mode."
Setting the value of this property to 1 changes the semantics of the reader to not
report the time steps to downstream filters.
 
| 0
|
Only the values 0 and 1 are accepted.
 
|-
|-
| '''Mode Shape'''<br>''(ModeShape)''
| '''B Scale'''<br>''(BScale)''
|
|
Specify the current mode shape when HasModeShapes in on.
A scaling factor to compute bonds between non-hydrogen atoms


| 1
| 1
| �
| �
|-
|-
| '''Node Map Array Status'''<br>''(NodeMapArrayStatus)''
| '''File Name'''<br>''(FileName)''
| �
| �
|
|
The list of array names is provided by the reader.
This property specifies the file name for the Gaussian Cube reader.


|-
| '''Node Set Array Status'''<br>''(NodeSetArrayStatus)''
| �
| �
| �
| �
|-
| '''H BScale'''<br>''(HBScale)''
|
|
The list of array names is provided by the reader.
A scaling factor to compute bonds with hydrogen atoms.


| 1
|-
| '''Node Set Result Array Status'''<br>''(NodeSetResultArrayStatus)''
| �
| �
|
|}
|
The list of array names is provided by the reader.


 
==Image Reader==
 
 
Read raw regular rectilinear grid data from a file. The dimensions and type of the data must be specified.
 
The Image reader reads raw regular rectilinear grid (image/volume) data from a file. Because no metadata is provided, the user must specify information about the size, spacing, dimensionality, etc. about the dataset.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Point Variables'''<br>''(PointVariables)''
| '''Data Byte Order'''<br>''(DataByteOrder)''
| �
| �
|
|
The list of array names is provided by the reader.
This property indicates the byte order of the binary file(s).


| 0
|-
| '''Side Set Array Status'''<br>''(SideSetArrayStatus)''
| �
| �
|
|
The list of array names is provided by the reader.
The value must be one of the following: BigEndian (0), LittleEndian (1).


|-
|-
| '''Side Set Result Array Status'''<br>''(SideSetResultArrayStatus)''
| '''Data Extent'''<br>''(DataExtent)''
| �
| �
|
|
The list of array names is provided by the reader.
This property specifies the minimum and maximum index values of the data in each dimension (xmin, xmax, ymin, ymax, zmin, zmax).


| 0 0 0 0 0 0
|
|-
|-
| '''XML File Name'''<br>''(XMLFileName)''
| '''Data Origin'''<br>''(DataOrigin)''
|
|
This property specifies the name of an XML file containing part and material descriptions and a mapping to element blocks.
The coordinate contained in this property specifies the position of the point with index (0,0,0).


| 0 0 0
| �
| �
| �
|}
==Flash Reader==
Read multi-block dataset from a Flash file.
This Flash reader loads data stored in Flash format. The output of this reader is a multi-block dataset.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Data Scalar Type'''<br>''(DataScalarType)''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Block Output Type'''<br>''(BlockOutputType)''
|
|
The property indicates the output type of each block, either vtkImageData (by default) or vtkRectilinearGrid.
The value of this property indicates the scalar type of the pixels/voxels in the file(s): short, int, float ...


| 0
| 4
|
|
The value must be one of the following: Image Data (0), Rectilinear Grid (1).
The value must be one of the following: char (2), unsigned char (3), short (4), unsigned short (5), int (6), unsigned int (7), long (8), unsigned long (9), float (10), double (11).


|-
|-
| '''File Name'''<br>''(FileName)''
| '''Data Spacing'''<br>''(DataSpacing)''
|
|
This property specifies the file name for the Flash reader.
This property specifies the size of a voxel in each dimension.


|
| 1 1 1
| �
| �
|-
|-
| '''Load Morton Curve'''<br>''(LoadMortonCurve)''
| '''File Dimensionality'''<br>''(FileDimensionality)''
|
|
Generate morton curve when on.
This property indicates whether the file(s) in this dataset contain slices (2D) or volumes (3D).


| 0
| 3
|
|
Only the values 0 and 1 are accepted.
The value must be one of the following: 2 (2), 3 (3).


|-
|-
| '''Load Particles'''<br>''(LoadParticles)''
| '''File Lower Left'''<br>''(FileLowerLeft)''
|
|
Load particles when on.
This property determines whether the data originates in the lower left corner (on) or the upper left corner (off).  Most scientific data is written with a right-handed axes that originates in the lower left corner.  However, several 2D image file formats write the image from the upper left corner.


| 1
| 1
Line 929: Line 905:


|}
==FLUENTReader==
Reads a dataset in Fluent file format.
FLUENTReader creates an unstructured grid dataset. It reads .cas and<br>
.dat files stored in FLUENT native format.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''File Pattern'''<br>''(FilePattern)''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
|
Select which cell-centered arrays to read.
The text string contained in the property specifies the format string to determine the file names necessary for reading this dataset. In creating the filenames, %s will be replaced by the prefix and %d by a digit which represents the slice number in Z. The format string is the same as that used by printf.


| %s
| �
| �
|-
| '''File Prefix'''<br>''(FilePrefix)''
|
|
The list of array names is provided by the reader.
The text string contained in this property specifies the file prefix (directory plus common initial part of file name) for the raw binary uniform rectilinear grid dataset.


| �
|
|-
|-
| '''File Name'''<br>''(FileName)''
| '''Number Of Scalar Components'''<br>''(NumberOfScalarComponents)''
|
|
Set the file  name for the FLUENT reader.
This property specifies the number of componenets the scalar value at each pixel or voxel has (e.g., RGB - 3 scalar components).


| 1
| �
| �
|-
| '''Scalar Array Name'''<br>''(ScalarArrayName)''
|
This property contains a text string listing a name to assign to the point-centered data array read.
| ImageFile
| �
| �
|}
|}




==Image Reader==
==LSDynaReader==




Read raw regular rectilinear grid data from a file. The dimensions and type of the data must be specified.
Read LS-Dyna databases (d3plot).


The Image reader reads raw regular rectilinear grid (image/volume) data from a file. Because no metadata is provided, the user must specify information about the size, spacing, dimensionality, etc. about the dataset.<br>
This reader reads LS-Dyna databases.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 980: Line 950:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Data Byte Order'''<br>''(DataByteOrder)''
| '''Beam Arrays'''<br>''(BeamArrayStatus)''
|
|
This property indicates the byte order of the binary file(s).
Select which beam arrays to read.


| 0
|
|
|
The value must be one of the following: BigEndian (0), LittleEndian (1).
The list of array names is provided by the reader.


|-
|-
| '''Data Extent'''<br>''(DataExtent)''
| '''Deformed Mesh'''<br>''(DeformedMesh)''
|
|
This property specifies the minimum and maximum index values of the data in each dimension (xmin, xmax, ymin, ymax, zmin, zmax).
Should the mesh be deformed over time (if the Deflection node array is set to load)?


| 0 0 0 0 0 0
| 1
|
|
Only the values 0 and 1 are accepted.
 
|-
|-
| '''Data Origin'''<br>''(DataOrigin)''
| '''File Name'''<br>''(FileName)''
|
|
The coordinate contained in this property specifies the position of the point with index (0,0,0).
Set the file name for the LSDyna reader.


| 0 0 0
|
| �
| �
|-
|-
| '''Data Scalar Type'''<br>''(DataScalarType)''
| '''Part Arrays'''<br>''(PartArrayStatus)''
|
|
The value of this property indicates the scalar type of the pixels/voxels in the file(s): short, int, float ...
Select which part arrays to read.


| 4
|
|
|
The value must be one of the following: char (2), unsigned char (3), short (4), unsigned short (5), int (6), unsigned int (7), long (8), unsigned long (9), float (10), double (11).
The list of array names is provided by the reader.


|-
|-
| '''Data Spacing'''<br>''(DataSpacing)''
| '''Particle Arrays'''<br>''(ParticleArrayStatus)''
|
|
This property specifies the size of a voxel in each dimension.
Select which particle arrays to read.


| 1 1 1
| �
| �
|-
| '''File Dimensionality'''<br>''(FileDimensionality)''
|
|
This property indicates whether the file(s) in this dataset contain slices (2D) or volumes (3D).
The list of array names is provided by the reader.
 
| 3
|
The value must be one of the following: 2 (2), 3 (3).


|-
|-
| '''File Lower Left'''<br>''(FileLowerLeft)''
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
|
This property determines whether the data originates in the lower left corner (on) or the upper left corner (off).  Most scientific data is written with a right-handed axes that originates in the lower left corner.  However, several 2D image file formats write the image from the upper left corner.
Select which point-centered arrays to read.
 
| �
|
The list of array names is provided by the reader.
 
|-
| '''Remove Deleted Cells'''<br>''(RemoveDeletedCells)''
|
Should cells that have been deleted (failed structurally, for example) be removed from the mesh?


| 1
| 1
Line 1,041: Line 1,017:
|-
|-
| '''File Pattern'''<br>''(FilePattern)''
| '''Rigid Body Arrays'''<br>''(RigidBodyArrayStatus)''
|
|
The text string contained in the property specifies the format string to determine the file names necessary for reading this dataset. In creating the filenames, %s will be replaced by the prefix and %d by a digit which represents the slice number in Z. The format string is the same as that used by printf.
Select which rigid body arrays to load.


| %s
| �
| �
|
The list of array names is provided by the reader.
|-
|-
| '''File Prefix'''<br>''(FilePrefix)''
| '''Road Surface Arrays'''<br>''(RoadSurfaceArrayStatus)''
|
|
The text string contained in this property specifies the file prefix (directory plus common initial part of file name) for the raw binary uniform rectilinear grid dataset.
Select which road surface arrays to read.


| �
| �
| �
|-
| '''Number Of Scalar Components'''<br>''(NumberOfScalarComponents)''
|
|
This property specifies the number of componenets the scalar value at each pixel or voxel has (e.g., RGB - 3 scalar components).
The list of array names is provided by the reader.


| 1
|
|-
|-
| '''Scalar Array Name'''<br>''(ScalarArrayName)''
| '''Shell Arrays'''<br>''(ShellArrayStatus)''
|
|
This property contains a text string listing a name to assign to the point-centered data array read.
Select which shell arrays to read.
 
| �
|
The list of array names is provided by the reader.
 
|-
| '''Solid Arrays'''<br>''(SolidArrayStatus)''
|
Select which solid arrays to read.
 
| �
|
The list of array names is provided by the reader.
 
|-
| '''Split by Material Id'''<br>''(SplitByMaterialId)''
|
Should each material have its own mesh, or should there be one mesh for all materials?
 
| 0
|
Only the values 0 and 1 are accepted.
 
|-
| '''Thick Shell Arrays'''<br>''(ThickShellArrayStatus)''
|
Select which thick shell arrays to read.


| ImageFile
| �
| �
|
The list of array names is provided by the reader.
|}
|}


Line 1,094: Line 1,102:




==LSDynaReader==
==MFIXReader==




Read LS-Dyna databases (d3plot).
Reads a dataset in MFIX file format.


This reader reads LS-Dyna databases.<br>
vtkMFIXReader creates an unstructured grid dataset. It reads a restart<br>
file and a set of sp files.  The restart file contains the mesh <br>
information.  MFIX meshes are either cylindrical or rectilinear, but <br>
this reader will convert them to an unstructured grid.  The sp files <br>
contain transient data for the cells.  Each sp file has one or more <br>
variables stored inside it.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,108: Line 1,121:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Beam Arrays'''<br>''(BeamArrayStatus)''
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
|
Select which beam arrays to read.
Select which cell-centered arrays to read.


| �
| �
|
|
The list of array names is provided by the reader.
The list of array names is provided by the reader.
|-
| '''Deformed Mesh'''<br>''(DeformedMesh)''
|
Should the mesh be deformed over time (if the Deflection node array is set to load)?
| 1
|
Only the values 0 and 1 are accepted.


Line 1,130: Line 1,133:
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
Set the file name for the LSDyna reader.
Set the file name for the MFIX reader.


| �
| �
| �
| �
|-
|}
| '''Part Arrays'''<br>''(PartArrayStatus)''
|
Select which part arrays to read.


| �
|
The list of array names is provided by the reader.


==Meta Image reader==
|-
 
| '''Particle Arrays'''<br>''(ParticleArrayStatus)''
 
|
Read binary UNC meta image data.
Select which particle arrays to read.


| �
The Meta Image Reader reads binary UNC meta image data, and produces uniform rectilinear (image/volume) data. The default file extensions are .mhd and .mha.<br>
|
The list of array names is provided by the reader.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| '''File Name'''<br>''(FileName)''
|
|
Select which point-centered arrays to read.
This property specifies the file name for the Meta Image reader.


| �
| �
|
|
The list of array names is provided by the reader.
|}


|-
| '''Remove Deleted Cells'''<br>''(RemoveDeletedCells)''
|
Should cells that have been deleted (failed structurally, for example) be removed from the mesh?


| 1
==NetCDF MPAS reader==
|
Only the values 0 and 1 are accepted.


|-
| '''Rigid Body Arrays'''<br>''(RigidBodyArrayStatus)''
|
Select which rigid body arrays to load.


| �
Read unstructured grid data from a file.
|
 
The list of array names is provided by the reader.
The Image reader reads unstructured grid from a file.  Grid is dual grid.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Road Surface Arrays'''<br>''(RoadSurfaceArrayStatus)''
| '''Cell Array Status'''<br>''(CellArrayStatus)''
|
|
Select which road surface arrays to read.
This property lists which netCDF dual-grid cell variables to load.


| �
| �
Line 1,195: Line 1,187:
|-
|-
| '''Shell Arrays'''<br>''(ShellArrayStatus)''
| '''File Name'''<br>''(FileName)''
|
|
Select which shell arrays to read.
This property specifies the file name to read.


| �
| �
|
| �
The list of array names is provided by the reader.
 
|-
|-
| '''Solid Arrays'''<br>''(SolidArrayStatus)''
| '''Point Array Status'''<br>''(PointArrayStatus)''
|
|
Select which solid arrays to read.
This property lists which netCDF dual-grid point variables to load.


| �
| �
Line 1,215: Line 1,204:
|-
|-
| '''Split by Material Id'''<br>''(SplitByMaterialId)''
| '''Vertical Level'''<br>''(VerticalLevel)''
|
|
Should each material have its own mesh, or should there be one mesh for all materials?
 
| 0
| 0
|
Only the values 0 and 1 are accepted.
|-
| '''Thick Shell Arrays'''<br>''(ThickShellArrayStatus)''
|
Select which thick shell arrays to read.
| �
| �
|
The list of array names is provided by the reader.
|}
|}




==Meta Image reader==
==NetCDF POP reader==




Read binary UNC meta image data.
Read raw regular rectilinear grid data from a file. The dimensions and type of the data must be specified.


The Meta Image Reader reads binary UNC meta image data, and produces uniform rectilinear (image/volume) data. The default file extensions are .mhd and .mha.<br>
The Image reader reads raw regular rectilinear grid (image/volume) data from a file. Because no metadata is provided, the user must specify information about the size, spacing, dimensionality, etc. about the dataset.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,253: Line 1,227:
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
This property specifies the file name for the Meta Image reader.
This property specifies the file name to read.


| �
| �
| �
| �
|}
|-
| '''Stride'''<br>''(Stride)''
|
This property indicate the number of indices per dimension (i,j,k) to skip between each point included
in this output.


| 1 1 1
|
The value must be greater than or equal to (1, 1, 1).


==MFIXReader==
 
 
Reads a dataset in MFIX file format.
 
vtkMFIXReader creates an unstructured grid dataset. It reads a restart<br>
file and a set of sp files.  The restart file contains the mesh <br>
information.  MFIX meshes are either cylindrical or rectilinear, but <br>
this reader will convert them to an unstructured grid.  The sp files <br>
contain transient data for the cells.  Each sp file has one or more <br>
variables stored inside it.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Variables'''<br>''(VariableArrayStatus)''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
|
Select which cell-centered arrays to read.
This property lists which netCDF variables to load.


| �
| �
Line 1,288: Line 1,252:


|-
| '''File Name'''<br>''(FileName)''
|
Set the file name for the MFIX reader.
| �
| �
|}
|}




==NetCDF MPAS reader==
==NetCDF Reader==




Read unstructured grid data from a file.
Read regular arrays from netCDF files.  Will also read any topological information specified by the COARDS and CF conventions.


The Image reader reads unstructured grid from a fileGrid is dual grid.<br>
Reads arrays from netCDF files into structured VTK data sets.  In<br>
the absence of any other information, the files will be read as<br>
image data.  This reader will also look for meta information<br>
specified by the CF convention that specify things like topology<br>
and time.  This information can cause the output to be a nonuniform<br>
rectilinear grid or curvilinear (structured) grid.  Details on the<br>
CF convention can be found at http://cf-pcmdi.llnl.gov/It should<br>
be noted that the CF convention is a superset of the COARDS<br>
convention, so COARDS conventions will also be recognized.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,311: Line 1,276:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''Cell Array Status'''<br>''(CellArrayStatus)''
|
This property lists which netCDF dual-grid cell variables to load.
| �
|
The list of array names is provided by the reader.
|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
This property specifies the file name to read.
The name of the files to load.


| �
| �
| �
| �
|-
|-
| '''Point Array Status'''<br>''(PointArrayStatus)''
| '''Dimensions'''<br>''(Dimensions)''
|
|
This property lists which netCDF dual-grid point variables to load.
Load the grid with the given dimensions.  Any arrays that conform
to these dimensions will be loaded.


| �
| �
|
|
The list of array names is provided by the reader.
.


|-
|-
| '''Vertical Level'''<br>''(VerticalLevel)''
| '''Replace Fill Value With Nan'''<br>''(ReplaceFillValueWithNan)''
|
|
| 0
If on, any float or double variable read that has a _FillValue
| �
attribute will have that fill value replaced with a not-a-number
|}
(NaN) value.  The advantage of setting these to NaN values is
that, if implemented properly by the system and careful math
operations are used, they can implicitly be ignored by
calculations like finding the range of the values.  That said,
this option should be used with caution as VTK does not fully
support NaN values and therefore odd calculations may occur.


| 0
|
Only the values 0 and 1 are accepted.


==NetCDF POP reader==
|-
| '''Spherical Coordinates'''<br>''(SphericalCoordinates)''
|
If on, then data with latitude/longitude dimensions will be
read in as curvilinear data shaped like spherical coordinates.
If false, then the data will always be read in Cartesian
coordinates.


 
| 1
Read raw regular rectilinear grid data from a file. The dimensions and type of the data must be specified.
 
The Image reader reads raw regular rectilinear grid (image/volume) data from a file. Because no metadata is provided, the user must specify information about the size, spacing, dimensionality, etc. about the dataset.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
|
This property specifies the file name to read.
Only the values 0 and 1 are accepted.


| �
|
|-
|-
| '''Stride'''<br>''(Stride)''
| '''Vertical Bias'''<br>''(VerticalBias)''
|
|
This property indicate the number of indices per dimension (i,j,k) to skip between each point included
The bias of the vertical component of spherical coordinates.  It
in this output.
is common to write the vertical component with respect to
something other than the center of the sphere (for example, the
surface).  In this case, it might be necessary to scale and/or
bias the vertical height.  The height will become height*scale +
bias.  Keep in mind that if the positive attribute of the
vertical dimension is down, then the height is negated.  The
scaling will be adjusted if it results in invalid (negative)
vertical values.


| 1 1 1
| 0
|
| �
The value must be greater than or equal to (1, 1, 1).
 
|-
|-
| '''Variables'''<br>''(VariableArrayStatus)''
| '''Vertical Scale'''<br>''(VerticalScale)''
|
|
This property lists which netCDF variables to load.
The scale of the vertical component of spherical coordinates.  It
is common to write the vertical component with respect to
something other than the center of the sphere (for example, the
surface).  In this case, it might be necessary to scale and/or
bias the vertical height.  The height will become height*scale +
bias.  Keep in mind that if the positive attribute of the
vertical dimension is down, then the height is negated.  The
scaling will be adjusted if it results in invalid (negative)
vertical values.


| 1
| �
| �
|
|}
The list of array names is provided by the reader.


|}


==Nrrd Reader==


==NetCDF Reader==


Read raw image files with Nrrd meta data.


Read regular arrays from netCDF files.  Will also read any topological information specified by the COARDS and CF conventions.
The Nrrd reader reads raw image data much like the Raw Image Reader<br>
 
except that it will also read metadata information in the Nrrd format.<br>
Reads arrays from netCDF files into structured VTK data sets.  In<br>
This means that the reader will automatically set information like file<br>
the absence of any other information, the files will be read as<br>
dimensions.<br><br><br>
image data. This reader will also look for meta information<br>
There are several limitations on what type of nrrd files we can<br>
specified by the CF convention that specify things like topology<br>
read.  This reader only supports nrrd files in raw formatOther<br>
and time.  This information can cause the output to be a nonuniform<br>
encodings like ascii and hex will result in errorsWhen reading in<br>
rectilinear grid or curvilinear (structured) gridDetails on the<br>
detached headers, this only supports reading one file that is<br>
CF convention can be found at http://cf-pcmdi.llnl.gov/It should<br>
detached.<br>
be noted that the CF convention is a superset of the COARDS<br>
convention, so COARDS conventions will also be recognized.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,412: Line 1,379:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
| '''Data VOI'''<br>''(DataVOI)''
|
|
The name of the files to load.
The data volume of interest (VOI).  The VOI is a sub-extent of the
data that you want loaded.  Setting a VOI is useful when reading
from a large data set and you are only interested in a small
portion of the data.  If left containing all 0's, then the reader
will load in the entire data set.


|
| 0 0 0 0 0 0
| �
| �
|-
|-
| '''Dimensions'''<br>''(Dimensions)''
| '''File Name'''<br>''(FileName)''
|
|
Load the grid with the given dimensions.  Any arrays that conform
The name of the file to read (or the meta data file that will
to these dimensions will be loaded.
point to the actual file).


| �
| �
|
|
.
|}
 
 
==OpenFOAMReader==
 
 
Sorry, no help is currently available.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Replace Fill Value With Nan'''<br>''(ReplaceFillValueWithNan)''
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Add dimensional units to array names'''<br>''(AddDimensionsToArrayNames)''
|
|
If on, any float or double variable read that has a _FillValue
Read dimensional units from field data and add them to array names as human-readable string.
attribute will have that fill value replaced with a not-a-number
(NaN) value.  The advantage of setting these to NaN values is
that, if implemented properly by the system and careful math
operations are used, they can implicitly be ignored by
calculations like finding the range of the values.  That said,
this option should be used with caution as VTK does not fully
support NaN values and therefore odd calculations may occur.


| 0
| 0
Line 1,447: Line 1,425:
|-
|-
| '''Spherical Coordinates'''<br>''(SphericalCoordinates)''
| '''Cache mesh'''<br>''(CacheMesh)''
|
|
If on, then data with latitude/longitude dimensions will be
Cache the OpenFOAM mesh between GUI selection changes.
read in as curvilinear data shaped like spherical coordinates.
If false, then the data will always be read in Cartesian
coordinates.


| 1
| 1
Line 1,460: Line 1,435:
|-
|-
| '''Vertical Bias'''<br>''(VerticalBias)''
| '''Case Type'''<br>''(CaseType)''
|
The property indicates whether decomposed mesh or reconstructed mesh should be read
 
| 1
|
|
The bias of the vertical component of spherical coordinates.  It
The value must be one of the following: Decomposed Case (0), Reconstructed Case (1).
is common to write the vertical component with respect to
something other than the center of the sphere (for example, the
surface).  In this case, it might be necessary to scale and/or
bias the vertical height.  The height will become height*scale +
bias.  Keep in mind that if the positive attribute of the
vertical dimension is down, then the height is negated.  The
scaling will be adjusted if it results in invalid (negative)
vertical values.


| 0
|-
| '''Cell Arrays'''<br>''(CellArrays)''
| �
| �
| �
|
The list of array names is provided by the reader.
|-
|-
| '''Vertical Scale'''<br>''(VerticalScale)''
| '''Create cell-to-point filtered data'''<br>''(CreateCellToPoint)''
|
|
The scale of the vertical component of spherical coordinates.  It
Create point data from cell data. Beware: the filter does not do inverse distance weighting.
is common to write the vertical component with respect to
 
something other than the center of the sphere (for example, the
surface).  In this case, it might be necessary to scale and/or
bias the vertical height.  The height will become height*scale +
bias. Keep in mind that if the positive attribute of the
vertical dimension is down, then the height is negated.  The
scaling will be adjusted if it results in invalid (negative)
vertical values.
 
| 1
| 1
|
|
|}
Only the values 0 and 1 are accepted.


|-
| '''Decompose polyhedra'''<br>''(DecomposePolyhedra)''
|
Decompose polyhedra into tetrahedra and pyramids.


==Nrrd Reader==
| 1
|
Only the values 0 and 1 are accepted.


|-
| '''File Name'''<br>''(FileName)''
| �
| �
| �
|-
| '''Lagrangian Arrays'''<br>''(LagrangianArrays)''
| �
| �
|
The list of array names is provided by the reader.


Read raw image files with Nrrd meta data.
|-
| '''List timesteps according to controlDict'''<br>''(ListTimeStepsByControlDict)''
|
List time directories listed according to the settings in controlDict.


The Nrrd reader reads raw image data much like the Raw Image Reader<br>
| 0
except that it will also read metadata information in the Nrrd format.<br>
|
This means that the reader will automatically set information like file<br>
Only the values 0 and 1 are accepted.
dimensions.<br><br><br>
There are several limitations on what type of nrrd files we can<br>
read.  This reader only supports nrrd files in raw format.  Other<br>
encodings like ascii and hex will result in errors.  When reading in<br>
detached headers, this only supports reading one file that is<br>
detached.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Mesh Regions'''<br>''(MeshRegions)''
| '''Description'''
|
| '''Default Value(s)'''
|
| '''Restrictions'''
|-
| '''Data VOI'''<br>''(DataVOI)''
|
|
The data volume of interest (VOI).  The VOI is a sub-extent of the
The list of array names is provided by the reader.
data that you want loaded.  Setting a VOI is useful when reading
from a large data set and you are only interested in a small
portion of the data.  If left containing all 0's, then the reader
will load in the entire data set.


| 0 0 0 0 0 0
|
|-
|-
| '''File Name'''<br>''(FileName)''
| '''Point Arrays'''<br>''(PointArrays)''
|
The name of the file to read (or the meta data file that will
point to the actual file).
 
| �
| �
| �
| �
|}
|
 
The list of array names is provided by the reader.
 
==OpenFOAMReader==
 
 
Sorry, no help is currently available.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Lagrangian positions are in OF 1.3 binary format'''<br>''(PositionsIsIn13Format)''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Add dimensional units to array names'''<br>''(AddDimensionsToArrayNames)''
|
|
Read dimensional units from field data and add them to array names as human-readable string.
Set if Lagrangian positions files are in OpenFOAM 1.3 binary format.


| 0
| 0
Line 1,560: Line 1,522:
|-
|-
| '''Cache mesh'''<br>''(CacheMesh)''
| '''Read zones'''<br>''(ReadZones)''
|
|
Cache the OpenFOAM mesh between GUI selection changes.
Read point/face/cell-Zones?


| 1
| 0
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.


|}
==PDB Reader==
Read PDB molecule files.
The PDB reader reads files in the format used by the Protein Data Bank (an archive of experimentally determined three-dimensional structures of biological macromolecules). The expected file extension is .pdb. The output datasets are polygonal.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Case Type'''<br>''(CaseType)''
| '''File Name'''<br>''(FileName)''
|
|
The property indicates whether decomposed mesh or reconstructed mesh should be read
This property specifies the file name for the PDB reader.


| 1
|
The value must be one of the following: Decomposed Case (0), Reconstructed Case (1).
|-
| '''Cell Arrays'''<br>''(CellArrays)''
| �
| �
| �
| �
|
|}
The list of array names is provided by the reader.


|-
| '''Create cell-to-point filtered data'''<br>''(CreateCellToPoint)''
|
Create point data from cell data. Beware: the filter does not do inverse distance weighting.


| 1
==PLOT3D Reader==
|
Only the values 0 and 1 are accepted.


|-
| '''Decompose polyhedra'''<br>''(DecomposePolyhedra)''
|
Decompose polyhedra into tetrahedra and pyramids.


| 1
Read ASCII or binary PLOT3D files.
|
 
Only the values 0 and 1 are accepted.
PLOT3D is a plotting package developed at NASA. The PLOT3D reader can read both ASCII and binary PLOT3D files. The default file extension for the geometry files is .xyz, and the default file extension for the solution files is .q. The output of this reader is a multi-block dataset containing curvilinear (structured grid) datasets.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''File Name'''<br>''(FileName)''
| '''Property'''
|
| '''Description'''
| �
| '''Default Value(s)'''
| �
| '''Restrictions'''
|-
|-
| '''Lagrangian Arrays'''<br>''(LagrangianArrays)''
| '''Q File Name'''<br>''(QFileName)''
|
The list of .q (solution) files for the PLOT3D reader. This can be
more than 1. If more that 1 file is specified, the reader will switch
to file-series mode in which it will pretend that it can support time
and provide 1 file per time step.
 
| �
| �
| �
| �
|
The list of array names is provided by the reader.
|-
|-
| '''List timesteps according to controlDict'''<br>''(ListTimeStepsByControlDict)''
| '''Binary File'''<br>''(BinaryFile)''
|
|
List time directories listed according to the settings in controlDict.
This property indicates whether the data files are binary.


| 0
| 1
|
|
Only the values 0 and 1 are accepted.
Only the values 0 and 1 are accepted.
Line 1,631: Line 1,591:
|-
|-
| '''Mesh Regions'''<br>''(MeshRegions)''
| '''Byte Order'''<br>''(ByteOrder)''
|
|
|
This property specifies the byte order of any binary file(s).
 
| 0
|
|
The list of array names is provided by the reader.
The value must be one of the following: BigEndian (0), LittleEndian (1).


|-
|-
| '''Point Arrays'''<br>''(PointArrays)''
| '''File Name'''<br>''(FileName)''
|
This property specifies the .xyz (geometry) file name for the PLOT3D reader.
 
| �
| �
| �
| �
|-
| '''Force Read'''<br>''(ForceRead)''
|
This property indicates whether to attempt to read the file even if it appears corrupt
| 0
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


|-
|-
| '''Lagrangian positions are in OF 1.3 binary format'''<br>''(PositionsIsIn13Format)''
| '''Functions'''<br>''(Functions)''
|
|
Set if Lagrangian positions files are in OpenFOAM 1.3 binary format.
This property lists which functions (point-centered arrays) to compute.


| 0
|
|
|
Only the values 0 and 1 are accepted.
The value must be one of the following: Scalar - Pressure (110), Scalar - Temperature (120), Scalar - Enthalpy (130), Scalar - Internal energy (140), Scalar - Kinetic energy (144), Scalar - Velocity magnitude (153), Scalar - Entropy (170), Scalar - Swirl. (184), Vector - Velocity (200), Vector - Vorticity (201), Vector - Pressure gradient (210).


|-
|-
| '''Read zones'''<br>''(ReadZones)''
| '''Has Byte Count'''<br>''(HasByteCount)''
|
|
Read point/face/cell-Zones?
This property indicates whether this file uses Fortran leading-trailing byte counts.


| 0
| 0
Line 1,666: Line 1,637:


|}
|-
| '''I Blanking'''<br>''(IBlanking)''
|
This property indicates whether this dataset has visibility information.
 
| 0
|
Only the values 0 and 1 are accepted.
 
|-
| '''Multi Grid'''<br>''(MultiGrid)''
|
This property indicates whether these files have multiple-block information.
 
| 0
|
Only the values 0 and 1 are accepted.
 
|-
| '''Two Dimensional Geometry'''<br>''(TwoDimensionalGeometry)''
|
This property indicates whether the data is two- or three-dimensional.
 
| 0
|
Only the values 0 and 1 are accepted.
 
|}




==PLOT3D Reader==
==PLY Reader==




Read ASCII or binary PLOT3D files.
Read files stored in Stanford University's PLY polygonal file format.


PLOT3D is a plotting package developed at NASA. The PLOT3D reader can read both ASCII and binary PLOT3D files. The default file extension for the geometry files is .xyz, and the default file extension for the solution files is .q. The output of this reader is a multi-block dataset containing curvilinear (structured grid) datasets.<br>
The PLY reader reads files stored in the PLY polygonal file format developed at Stanford University. The PLY files that ParaView can read must have the elements "vertex" and "face" defined. The "vertex" elements must have the propertys "x", "y", and "z". The "face" elements must have the property "vertex_indices" defined. The default file extension for this reader is .ply.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,683: Line 1,684:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Q File Name'''<br>''(QFileName)''
| '''File Name'''<br>''(FileName)''
|
|
The list of .q (solution) files for the PLOT3D reader. This can be
This property specifies the file name for the PLY reader.
more than 1. If more that 1 file is specified, the reader will switch
 
to file-series mode in which it will pretend that it can support time
and provide 1 file per time step.
 
| �
| �
| �
| �
|-
|}
| '''Binary File'''<br>''(BinaryFile)''
 
|
 
This property indicates whether the data files are binary.
==POP Reader==
 
 
Read data files from the Parallel Ocean Program (POP).


| 1
The POP reader reads data files from the Parallel Ocean Program (POP). The expected file extension is .pop. The output of this reader is a structured grid dataset. <br>
|
Only the values 0 and 1 are accepted.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Byte Order'''<br>''(ByteOrder)''
| '''Clip Extent'''<br>''(ClipExtent)''
|
|
This property specifies the byte order of any binary file(s).
This property indicates the minimum and maximum extent in each dimension of the dataset (X, Y, and Z) to read.


| 0
| -2147483647 2147483647 -2147483647 2147483647 -2147483647 2147483647
|
| �
The value must be one of the following: BigEndian (0), LittleEndian (1).
 
|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
This property specifies the .xyz (geometry) file name for the PLOT3D reader.
This property specifies the file name for the POP Ocean file reader.


| �
| �
| �
| �
|-
|-
| '''Force Read'''<br>''(ForceRead)''
| '''Number Of Ghost Levels'''<br>''(NumberOfGhostLevels)''
|
|
This property indicates whether to attempt to read the file even if it appears corrupt
This property indicates the number of ghost levels to generate.


| 0
| 1
|
| �
Only the values 0 and 1 are accepted.
 
|-
|-
| '''Functions'''<br>''(Functions)''
| '''Radius'''<br>''(Radius)''
|
|
This property lists which functions (point-centered arrays) to compute.
This property specifies the radius of the dataset.


| 60000
| �
| �
|
|}
The value must be one of the following: Scalar - Pressure (110), Scalar - Temperature (120), Scalar - Enthalpy (130), Scalar - Internal energy (140), Scalar - Kinetic energy (144), Scalar - Velocity magnitude (153), Scalar - Entropy (170), Scalar - Swirl. (184), Vector - Velocity (200), Vector - Vorticity (201), Vector - Pressure gradient (210).
 


==PVD Reader==
|-
| '''Has Byte Count'''<br>''(HasByteCount)''
|
This property indicates whether this file uses Fortran leading-trailing byte counts.


| 0
|
Only the values 0 and 1 are accepted.


Load a dataset stored in ParaView's PVD file format.
|-
| '''I Blanking'''<br>''(IBlanking)''
|
This property indicates whether this dataset has visibility information.


| 0
The PVD reader reads data stored in ParaView's PVD file format. The .pvd file is essentially a header file that collects together other data files stored in VTK's XML-based file format.<br>
|
Only the values 0 and 1 are accepted.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Multi Grid'''<br>''(MultiGrid)''
| '''Property'''
|
| '''Description'''
This property indicates whether these files have multiple-block information.
| '''Default Value(s)'''
 
| '''Restrictions'''
| 0
|
Only the values 0 and 1 are accepted.
 
|-
|-
| '''Two Dimensional Geometry'''<br>''(TwoDimensionalGeometry)''
| '''File Name'''<br>''(FileName)''
|
|
This property indicates whether the data is two- or three-dimensional.
This property specifies the file name for the PVD reader.


| 0
|
|
| �
Only the values 0 and 1 are accepted.
 
|}
|}


Line 1,858: Line 1,836:




==Phasta Reader==
==Partitioned Legacy VTK Reader==




Read the parallel Phasta meta-file and the underlying Phasta files.
Read files stored in VTK partitioned legacy format.


This Phasta reader reads files stored in the Phasta (a CFD package) format. The expected file extension is .pht. The output of this reader is a multipiece data set.<br>
The Partitioned Legacy VTK reader loads files stored in VTK's partitioned legac file format (before VTK 4.2, although still supported). The expected file extension is .pvtk. The type of the dataset may be structured grid, uniform rectilinear grid (image/volume), non-uniform rectilinear grid, unstructured grid, or polygonal.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,874: Line 1,852:
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
This property specifies the file name for the Phasta reader.
This property specifies the file name for the Partitioned Legacy VTK reader.


| �
| �
Line 1,881: Line 1,859:




==proSTAR (STARCD) Reader==
==Phasta Reader==




Reads geometry in proSTAR (STARCD) file format.
Read the parallel Phasta meta-file and the underlying Phasta files.


ProStarReader creates an unstructured grid dataset.<br>
This Phasta reader reads files stored in the Phasta (a CFD package) format. The expected file extension is .pht. The output of this reader is a multipiece data set.<br>
It reads .cel/.vrt files stored in proSTAR (STARCD) ASCII format.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,898: Line 1,875:
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
Set the file name for the proSTAR (STARCD) reader.
This property specifies the file name for the Phasta reader.


| �
| �
| �
| �
|-
|}
| '''Scale Factor'''<br>''(ScaleFactor)''
 
|
Scaling factor for the points


| 0
==Restarted Sim Exodus Reader==
| �
|}




==PVD Reader==
Read collections of Exodus output files from simulations that were restarted.


 
When a simulation that outputs exodus files is restarted, typically you get a new set of output files.  When you read them in your visualization, you often want to string these file sets together as if it was one continuous dump of files. This reader allows you to specify a metadata file that will implicitly string the files together.<br>
Load a dataset stored in ParaView's PVD file format.
 
The PVD reader reads data stored in ParaView's PVD file format. The .pvd file is essentially a header file that collects together other data files stored in VTK's XML-based file format.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,928: Line 1,898:
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
This property specifies the file name for the PVD reader.
This points to a special metadata file that lists the output files for each restart.


| �
| �
| �
| �
|}
|-
| '''Use Meta File'''<br>''(UseMetaFile)''
|
This hidden property must always be set to 1 for this proxy to work.


| 1
|
Only the values 0 and 1 are accepted.


==SESAME Reader==
 
 
Read SESAME data files, producing rectilinear grids.
 
The SESAME reader reads SESAME data files, and outputs rectilinear grids. The expected file extension is .sesame.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Animate Vibrations'''<br>''(AnimateVibrations)''
| '''Description'''
|
| '''Default Value(s)'''
If this flag is on and HasModeShapes is also on, then this reader
| '''Restrictions'''
will report a continuous time range [0,1] and animate the
|-
displacements in a periodic sinusoid.  If this flag is off and
| '''File Name'''<br>''(FileName)''
HasModeShapes is on, this reader ignores time.  This flag has no
effect if HasModeShapes is off.
 
| 1
|
|
This property specifies the file name for the SESAME reader.
Only the values 0 and 1 are accepted.


| �
|
|-
|-
| '''Table Id'''<br>''(TableId)''
| '''Apply Displacements'''<br>''(ApplyDisplacements)''
|
|
This proeprty indicates which table to read.
Geometric locations can include displacements. When this option is on, the nodal positions are 'displaced' by the standard exodus displacement vector. If displacements are turned 'off', the user can explicitly add them by applying a warp filter.


| -1
| 1
|
|
The value must be one of the following:.
Only the values 0 and 1 are accepted.


|}
|-
 
| '''Displacement Magnitude'''<br>''(DisplacementMagnitude)''
 
|
==SLAC Particle Data Reader==
When displacements are being applied, they are scaled by this amount.  Set to 1 for no scaling.


| 1
| �
|-
| '''Edge Blocks'''<br>''(EdgeBlocks)''
| �
| �
|
The list of array names is provided by the reader.


|-
| '''Edge Map Array Status'''<br>''(EdgeMapArrayStatus)''
| �
| �
|
The list of array names is provided by the reader.


The SLAC Particle data reader.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Edge Set Array Status'''<br>''(EdgeSetArrayStatus)''
| '''Description'''
|
| '''Default Value(s)'''
|
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
|
A list of files to be read in a time series.
The list of array names is provided by the reader.


|-
| '''Edge Set Result Array Status'''<br>''(EdgeSetResultArrayStatus)''
| �
| �
| �
| �
|}
|
 
The list of array names is provided by the reader.
 
==SLAC Data Reader==
 


A reader for a data format used by Omega3p, Tau3p, and several<br>
other tools used at the Standford Linear Accelerator Center (SLAC).<br>
The underlying format uses netCDF to store arrays, but also imposes<br>
several conventions to form an unstructured grid of elements.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Edge Variables'''<br>''(EdgeVariables)''
| '''Description'''
|
| '''Default Value(s)'''
|
| '''Restrictions'''
|-
| '''Mesh File Name'''<br>''(MeshFileName)''
|
|
The name of the mesh file to load.
The list of array names is provided by the reader.


|-
| '''Element Blocks'''<br>''(ElementBlocks)''
| �
| �
| �
| �
| �
|-
|-
| '''Mode File Name'''<br>''(ModeFileName)''
| '''Element Map Array Status'''<br>''(ElementMapArrayStatus)''
| �
| �
|
|
The name of the mode files to load.  The points in the mode file should be the same as the mesh file.
The list of array names is provided by the reader.


|-
| '''Element Set Array Status'''<br>''(ElementSetArrayStatus)''
| �
| �
| �
| �
|-
| '''Read External Surface'''<br>''(ReadExternalSurface)''
|
|
If on, read the external surfaces of the data set.
The list of array names is provided by the reader.


| 1
|-
| '''Element Set Result Array Status'''<br>''(ElementSetResultArrayStatus)''
| �
| �
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.


|-
|-
| '''Read Internal Volume'''<br>''(ReadInternalVolume)''
| '''Element Variables'''<br>''(ElementVariables)''
| �
| �
|
|
If on, read the internal volume of the data set.
The list of array names is provided by the reader.


|-
| '''Exodus Model Metadata'''<br>''(ExodusModelMetadata)''
| �
| 0
| 0
|
|
Line 2,042: Line 2,029:
|-
|-
| '''Read Midpoints'''<br>''(ReadMidpoints)''
| '''Face Blocks'''<br>''(FaceBlocks)''
| �
| �
|
|
If on, reads midpoint information for external surfaces and builds
The list of array names is provided by the reader.
quadratic surface triangles.


| 0
|-
| '''Face Map Array Status'''<br>''(FaceMapArrayStatus)''
| �
| �
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.


|}
|-
 
| '''Face Set Array Status'''<br>''(FaceSetArrayStatus)''
| �
| �
|
The list of array names is provided by the reader.


==Restarted Sim Spy Plot Reader==
 
 
Read collections of SPCTH files from simulations that were restarted.
 
When a CTH simulation is restarted, typically you get a new set of output files.  When you read them in your visualization, you often want to string these file sets together as if it was one continuous dump of files.  This reader allows you to specify a metadata file that will implicitly string the files together.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Face Set Result Array Status'''<br>''(FaceSetResultArrayStatus)''
| '''Description'''
|
| '''Default Value(s)'''
|
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
|
This points to a special metadata file that lists the output files for each restart.
The list of array names is provided by the reader.


|-
| '''Face Variables'''<br>''(FaceVariables)''
| �
| �
| �
| �
|-
| '''Use Meta File'''<br>''(UseMetaFile)''
|
|
This hidden property must always be set to 1 for this proxy to work.
The list of array names is provided by the reader.


|-
| '''Generate Global Element Id Array'''<br>''(GenerateGlobalElementIdArray)''
| �
| 1
| 1
|
|
Line 2,086: Line 2,077:
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
| '''Generate Global Node Id Array'''<br>''(GenerateGlobalNodeIdArray)''
|
This property lists which cell-centered arrays to read.
 
| �
| �
| 1
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


|-
|-
| '''Distribute Files'''<br>''(DistributeFiles)''
| '''Generate Object Id Cell Array'''<br>''(GenerateObjectIdCellArray)''
|
|
In parallel mode, if this property is set to 1, the reader will distribute files or blocks.
 
| 1
| 1
|
|
Line 2,106: Line 2,093:
|-
|-
| '''Down Convert Volume Fraction'''<br>''(DownConvertVolumeFraction)''
| '''Global Variables'''<br>''(GlobalVariables)''
| �
| �
|
|
If this property is set to 0, the type of the volume fraction is float; is set to 1, the type is unsigned char.
The list of array names is provided by the reader.
 
| 1
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Generate Active Block Array'''<br>''(GenerateActiveBlockArray)''
| '''Has Mode Shapes'''<br>''(HasModeShapes)''
|
|
If this property is set to 1, a cell array will be generated that stores the active status of a block.
Some simulations overload the Exodus time steps to represent mode
shapes.  In this case, it does not make sense to iterate over the
"time steps", because they are not meant to be played in order.
Rather, each represents the vibration at a different "mode."
Setting the value of this property to 1 changes the semantics of the reader to not
report the time steps to downstream filters.


| 0
| 0
Line 2,126: Line 2,116:
|-
|-
| '''Generate Block Id Array'''<br>''(GenerateBlockIdArray)''
| '''Mode Shape'''<br>''(ModeShape)''
|
|
If this property is set to 1, a cell array will be generated that stores a unique blockId for each block.
Specify the current mode shape when HasModeShapes in on.


| 0
| 1
| �
|-
| '''Node Map Array Status'''<br>''(NodeMapArrayStatus)''
| �
| �
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.


|-
|-
| '''Generate Level Array'''<br>''(GenerateLevelArray)''
| '''Node Set Array Status'''<br>''(NodeSetArrayStatus)''
| �
| �
|
|
If this property is set to 1, a cell array will be generated that stores the level of each block.
The list of array names is provided by the reader.


| 0
|-
| '''Node Set Result Array Status'''<br>''(NodeSetResultArrayStatus)''
| �
| �
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.


|}
|-
 
| '''Point Variables'''<br>''(PointVariables)''
 
|
==Tecplot Reader==
|
 
|
 
The list of array names is provided by the reader.
Read files in the Tecplot ASCII file format.
 
The Tecplot reader extracts multiple zones (blocks) of data from a Tecplot ASCII file, in which a zone is stored in either point packing mode (i.e., tuple-based, with only point data supported) or block packing mode (i.e., component-based, with point data and cell data supported). The output of the reader is a vtkMultiBlockDataset, of which each block is either a vtkStructuredGrid or a vtkUnstructuredGrid. This supports reading a file series.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Names'''<br>''(FileNames)''
|
The list of files to be read by the reader.


|-
| '''Side Set Array Status'''<br>''(SideSetArrayStatus)''
| �
| �
| �
| �
|-
| '''Data Arrays'''<br>''(DataArrayStatus)''
|
|
This property lists what dataset attribute arrays (point data and cell data) to read.
The list of array names is provided by the reader.


|-
| '''Side Set Result Array Status'''<br>''(SideSetResultArrayStatus)''
| �
| �
| �
|
|
Line 2,178: Line 2,170:


|-
| '''XML File Name'''<br>''(XMLFileName)''
|
This property specifies the name of an XML file containing part and material descriptions and a mapping to element blocks.
| �
| �
|}
|}




==TIFF Reader==
==Restarted Sim Spy Plot Reader==




Read a TIFF file into an image data.
Read collections of SPCTH files from simulations that were restarted.


The TIFF reader reads TIFF (Tagged Image File Format) files, and the output is a uniform rectilinear (image/volume) dataset. The default file extension is .png.<br>
When a CTH simulation is restarted, typically you get a new set of output files. When you read them in your visualization, you often want to string these file sets together as if it was one continuous dump of files. This reader allows you to specify a metadata file that will implicitly string the files together.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,197: Line 2,196:
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
This property specifies the file name for the TIFF reader.
This points to a special metadata file that lists the output files for each restart.


| �
| �
| �
| �
|}
|-
| '''Use Meta File'''<br>''(UseMetaFile)''
|
This hidden property must always be set to 1 for this proxy to work.


 
| 1
==VPIC Reader==
|
 
Only the values 0 and 1 are accepted.
 
Sorry, no help is currently available.


|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which cell-centered arrays to read.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
| �
| �
| �
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| �
| �
| �
|
|
Line 2,232: Line 2,221:
|-
|-
| '''Stride'''<br>''(SetStride)''
| '''Distribute Files'''<br>''(DistributeFiles)''
|
|
| 1 1 1
In parallel mode, if this property is set to 1, the reader will distribute files or blocks.
 
| 1
|
|
The value must be greater than or equal to 1.
Only the values 0 and 1 are accepted.


|-
|-
| '''X Extent'''<br>''(XExtent)''
| '''Down Convert Volume Fraction'''<br>''(DownConvertVolumeFraction)''
|
|
| -1 -1
If this property is set to 0, the type of the volume fraction is float; is set to 1, the type is unsigned char.
| �
|-
| '''Y Extent'''<br>''(YExtent)''
| �
| -1 -1
| �
|-
| '''Z Extent'''<br>''(ZExtent)''
| �
| -1 -1
| �
|}


 
| 1
==WindBlade reader==
|
 
Only the values 0 and 1 are accepted.
 
Sorry, no help is currently available.


|-
| '''Generate Active Block Array'''<br>''(GenerateActiveBlockArray)''
|
If this property is set to 1, a cell array will be generated that stores the active status of a block.


| 0
|
Only the values 0 and 1 are accepted.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Generate Block Id Array'''<br>''(GenerateBlockIdArray)''
| '''Description'''
|
| '''Default Value(s)'''
If this property is set to 1, a cell array will be generated that stores a unique blockId for each block.
| '''Restrictions'''
 
| 0
|
Only the values 0 and 1 are accepted.
 
|-
|-
| '''File Name'''<br>''(FileName)''
| '''Generate Level Array'''<br>''(GenerateLevelArray)''
|
|
| �
If this property is set to 1, a cell array will be generated that stores the level of each block.
| �
 
|-
| 0
| '''Point Arrays'''<br>''(PointArrayStatus)''
| �
|
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


Line 2,287: Line 2,273:




==XDMF Reader==
==SESAME Reader==




Read XDMF (eXtensible Data Model and Format) files.
Read SESAME data files, producing rectilinear grids.


The XDMF reader reads files in XDMF format. The expected file extension<br>
The SESAME reader reads SESAME data files, and outputs rectilinear grids. The expected file extension is .sesame.<br>
is .xmf. Metadata is stored in the XDMF file using an XML format, and<br>
large attribute arrays are stored in a corresponding HDF5 file. The<br>
output may be unstructured grid, structured grid, or rectiliner grid.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,303: Line 2,286:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which the cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
This property specifies the file name for the XDMF reader.
This property specifies the file name for the SESAME reader.


| �
| �
| �
| �
|-
|-
| '''Grids'''<br>''(GridStatus)''
| '''Table Id'''<br>''(TableId)''
| �
| �
| �
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
|
This property lists which the point-centered arrays to read.
This proeprty indicates which table to read.


|
| -1
|
|
The list of array names is provided by the reader.
The value must be one of the following:.


|-
|}
| '''Sets'''<br>''(SetStatus)''
|
Select the sets to be loaded from the dataset, if any.


| �
|
The list of array names is provided by the reader.


==SLAC Data Reader==
|-
| '''Stride'''<br>''(Stride)''
|
If loading structured data, this property indicate the number of
indices per dimension (X, Y, or Z) to skip between each point included
in this output.


| 1 1 1
|
The value must be greater than or equal to (1, 1, 1).


|}


 
A reader for a data format used by Omega3p, Tau3p, and several<br>
==XML Hierarchical Box Data reader==
other tools used at the Standford Linear Accelerator Center (SLAC).<br>
 
The underlying format uses netCDF to store arrays, but also imposes<br>
 
several conventions to form an unstructured grid of elements.<br>
Read a VTK XML-based data file containing a hierarchical dataset containing vtkUniformGrids.
 
The XML Hierarchical Box Data reader reads VTK's XML-based file format<br>
containing a vtkHierarchicalBoxDataSet. The expected file extensions is<br>
either .vthb or .vth.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,376: Line 2,323:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
| '''Mesh File Name'''<br>''(MeshFileName)''
|
|
The list of files to be read by the reader. Each file is expected to be
The name of the mesh file to load.
in the VTK XML polygonal dataset format. The standard extension is
 
.vtp. If more than 1 file is specified, the reader will switch to file
series mode in which it will pretend that it can support time and
provide 1 file per time step.
 
| �
| �
| �
| �
|}
==XML Image Data Reader==
Read serial VTK XML image data files.
The XML Image Data reader reads the VTK XML image data file format. The standard extension is .vti. This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Mode File Name'''<br>''(ModeFileName)''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
|
The list of files to be read by the reader. Each file is expected to be in the VTK XML image data format. The standard extension is .vti. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
The name of the mode files to load.  The points in the mode file should be the same as the mesh file.


| �
| �
| �
| �
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
| '''Read External Surface'''<br>''(ReadExternalSurface)''
|
|
This property lists which cell-centered arrays to read.
If on, read the external surfaces of the data set.


|
| 1
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


|-
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| '''Read Internal Volume'''<br>''(ReadInternalVolume)''
|
|
This property lists which point-centered arrays to read.
If on, read the internal volume of the data set.
 
| 0
|
Only the values 0 and 1 are accepted.
 
|-
| '''Read Midpoints'''<br>''(ReadMidpoints)''
|
If on, reads midpoint information for external surfaces and builds
quadratic surface triangles.


|
| 0
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


Line 2,432: Line 2,370:




==XML MultiBlock Data Reader==
==SLAC Particle Data Reader==




Read a VTK XML multi-block data file and the serial VTK XML data files to which it points.


The XML Multi-Block Data reader reads the VTK XML multi-block data file<br>
The SLAC Particle data reader.<br>
format. XML multi-block data files are meta-files that point to a list of<br>
serial VTK XML files. When reading in parallel, this reader will<br>
distribute sub-blocks among processors. The expected file extensions are<br>
.vtm and .vtmb.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,452: Line 2,386:
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
The list of files to be read by the reader. Each file is expected to be
A list of files to be read in a time series.
in the VTK XML polygonal dataset format. The standard extension is
.vtp. If more than 1 file is specified, the reader will switch to file
series mode in which it will pretend that it can support time and
provide 1 file per time step.


| �
| �
Line 2,463: Line 2,393:




==XML Partitioned Image Data Reader==
==STL Reader==




Read the summary file and the associated VTK XML image data files.
Read ASCII or binary stereo lithography (STL) files.


The XML Partitioned Image Data reader reads the partitioned VTK image data file format. It reads the partitioned format's summary file and then the associated VTK XML image data files. The expected file extension is .pvti. This reader also supports file series.<br>
The STL reader reads ASCII or binary stereo lithography (STL) files. The expected file extension is .stl. The output of this reader is a polygonal dataset. This reader also supports file series.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,477: Line 2,407:
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Names'''<br>''(FileNames)''
|
|
The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML image data format. The standard extension is .pvti. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
The list of files to be read by the reader. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
 
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This propert lists which cell-centered arrays to read.


| �
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
| �
|
The list of array names is provided by the reader.
|}
|}




==XML PolyData Reader==
==Spy Plot Reader==




Read serial VTK XML polydata files.
Read files in the SPCTH Spy Plot file format.


The XML Polydata reader reads the VTK XML polydata file format. The standard extension is .vtp. This reader also supports file series.<br>
The Spy Plot reader loads an ASCII meta-file called the "case" file (extension .spcth). The case file lists all the binary files containing the dataset. This reader produces hierarchical datasets.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,519: Line 2,429:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the VTK XML polygonal dataset format. The standard extension is .vtp. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
| '''Cell Arrays'''<br>''(CellArrayStatus)''
Line 2,537: Line 2,440:
|-
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| '''Distribute Files'''<br>''(DistributeFiles)''
|
|
This property lists which point-centered arrays to read.
In parallel mode, if this property is set to 1, the reader will distribute files or blocks.


|
| 1
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


|}
|-
| '''Down Convert Volume Fraction'''<br>''(DownConvertVolumeFraction)''
|
If this property is set to 0, the type of the volume fraction is float; is set to 1, the type is unsigned char.


| 1
|
Only the values 0 and 1 are accepted.


==XML Partitioned Polydata Reader==
 
 
Read the summary file and the assicoated VTK XML polydata files.
 
The XML Partitioned Polydata reader reads the partitioned VTK polydata file format. It reads the partitioned format's summary file and then the associated VTK XML polydata files. The expected file extension is .pvtp.  This reader also supports file series.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML polygonal dataset format. The standard extension is .pvtp. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
This property specifies the file name for the Spy Plot reader.


| �
| �
| �
| �
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
| '''Generate Active Block Array'''<br>''(GenerateActiveBlockArray)''
|
|
This property lists which cell-centered arrays to read.
If this property is set to 1, a cell array will be generated that stores the active status of a block.


|
| 0
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


|-
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| '''Generate Block Id Array'''<br>''(GenerateBlockIdArray)''
|
|
This property lists which point-centered arrays to read.
If this property is set to 1, a cell array will be generated that stores a unique blockId for each block.


|
| 0
|
|
The list of array names is provided by the reader.
Only the values 0 and 1 are accepted.


|}
|-
| '''Generate Level Array'''<br>''(GenerateLevelArray)''
|
If this property is set to 1, a cell array will be generated that stores the level of each block.


| 0
|
Only the values 0 and 1 are accepted.


==XML Partitioned Rectilinear Grid Reader==
|-
| '''Generate Tracer Array'''<br>''(GenerateTracerArray)''
|
If this property is set to 1, a cell array will be generated that stores the coordinates of any tracers.


| 0
|
Only the values 0 and 1 are accepted.


Read the summary file and the associated VTK XML rectilinear grid data files.
 
The XML Partitioned Rectilinear Grid reader reads the partitioned VTK rectilinear grid file format. It reads the partitioned format's summary file and then the associated VTK XML rectilinear grid files. The expected file extension is .pvtr. This reader also supports file series.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Merge XYZComponents'''<br>''(MergeXYZComponents)''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
|
The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML rectilinear grid data format. The standard extension is .pvtr. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
If this property is set to 1, cell arrays named (for example) X velocity, Y velocity and Z velocity will be combined into a single vector array named velocity.


|
| 1
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
|
This property lists which cell-centered arrays to read.
Only the values 0 and 1 are accepted.
 
| �
|
The list of array names is provided by the reader.
 
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
 
| �
|
The list of array names is provided by the reader.


Line 2,635: Line 2,519:




==XML Partitioned Structured Grid Reader==
==TIFF Reader==




Read the summary file and the associated VTK XML structured grid data files.
Read a TIFF file into an image data.


The XML Partitioned Structured Grid reader reads the partitioned VTK structured grid data file format. It reads the partitioned format's summary file and then the associated VTK XML structured grid data files. The expected file extension is .pvts. This reader also supports file series.<br>
The TIFF reader reads TIFF (Tagged Image File Format) files, and the output is a uniform rectilinear (image/volume) dataset. The default file extension is .png.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,651: Line 2,535:
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML structured grid data format. The standard extension is .pvts. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
This property specifies the file name for the TIFF reader.


| �
| �
| �
| �
|-
|}
| '''Cell Arrays'''<br>''(CellArrayStatus)''
 
|
This property lists which cell-centered arrays to read.


|
==Tecplot Reader==
 
 
Read files in the Tecplot ASCII file format.
 
The Tecplot reader extracts multiple zones (blocks) of data from a Tecplot ASCII file, in which a zone is stored in either point packing mode (i.e., tuple-based, with only point data supported) or block packing mode (i.e., component-based, with point data and cell data supported). The output of the reader is a vtkMultiBlockDataset, of which each block is either a vtkStructuredGrid or a vtkUnstructuredGrid. This supports reading a file series.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Names'''<br>''(FileNames)''
|
|
The list of array names is provided by the reader.
The list of files to be read by the reader.


| �
|
|-
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| '''Data Arrays'''<br>''(DataArrayStatus)''
|
|
This property lists which point-centered arrays to read.
This property lists what dataset attribute arrays (point data and cell data) to read.


| �
| �
Line 2,678: Line 2,575:




==XML Partitioned Unstructured Grid Reader==
==VPIC Reader==
 


Sorry, no help is currently available.


Read the summary file and the associated VTK XML unstructured grid data files.


The XML Partitioned Unstructured Grid reader reads the partitioned VTK unstructured grid data file format. It reads the partitioned format's summary file and then the associated VTK XML unstructured grid data files. The expected file extension is .pvtu. This reader also supports file series.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,693: Line 2,591:
|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML unstructured grid data format. The standard extension is .pvtu. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
 
| �
| �
| �
| �
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
|
This property lists which cell-centered arrays to read.
 
| �
| �
|
|
Line 2,709: Line 2,603:
|-
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| '''Stride'''<br>''(SetStride)''
|
This property lists which point-centered arrays to read.
 
| �
| �
| 1 1 1
|
|
The list of array names is provided by the reader.
The value must be greater than or equal to 1.


|-
| '''X Extent'''<br>''(XExtent)''
| �
| -1 -1
| �
|-
| '''Y Extent'''<br>''(YExtent)''
| �
| -1 -1
| �
|-
| '''Z Extent'''<br>''(ZExtent)''
| �
| -1 -1
| �
|}
|}




==XML Rectilinear Grid Reader==
==VRML Reader==




Read serial VTK XML rectilinear grid data files.
Load the geometry from a VRML 2.0 file.


The XML Rectilinear Grid reader reads the VTK XML rectilinear grid data file format. The standard extension is .vtr. This reader also supports file series.<br>
The VRML reader loads only the geometry from a VRML (Virtual Reality Modeling Language) 2.0 file. The expected file extension is .wrl. The output of this reader is a polygonal dataset.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,737: Line 2,644:
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
The list of files to be read by the reader. Each file is expected to be in the VTK XML rectilinear grid data format. The standard extension is .vtr. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
This property specifies the file name for the VRML reader.


| �
| �
| �
| �
|-
|}
| '''Cell Arrays'''<br>''(CellArrayStatus)''
 
|
 
This property lists which cell-centered arrays to read.
==Wavefront OBJ Reader==
 
 
Read Wavefront .OBJ files to produce polygonal and line data.


| �
The OBJ reader reads data stored in Wavefront .OBJ format.<br>
|
The expected file extension is .obj, the datasets resulting<br>
The list of array names is provided by the reader.
from reading these files are polygons and lines.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| '''File Name'''<br>''(FileName)''
|
|
This property lists which point-centered arrays to read.
This property specifies the file name for the OBJ reader.


| �
| �
|
|
The list of array names is provided by the reader.
|}


|}


==WindBlade reader==


==XML Structured Grid Reader==


Sorry, no help is currently available.


Read serial VTK XML structured grid data files.


The XML Structured Grid reader reads the VTK XML structured grid data file format. The standard extension is .vts. This reader also supports file series.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,779: Line 2,692:
|-
|-
| '''File Name'''<br>''(FileName)''
| '''File Name'''<br>''(FileName)''
|
|
The list of files to be read by the reader. Each file is expected to be in the VTK XML structured grid data format. The standard extension is .vts. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
 
| �
| �
| �
| �
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which cell-centered arrays to read.
 
| �
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
| �
|
|
Line 2,807: Line 2,706:




==XML Unstructured Grid Reader==
==XDMF Reader==




Read serial VTK XML unstructured grid data files.
Read XDMF (eXtensible Data Model and Format) files.


The XML Unstructured Grid reader reads the VTK XML unstructured grid data file format. The standard extension is .vtu. This reader also supports file series.<br>
The XDMF reader reads files in XDMF format. The expected file extension<br>
is .xmf. Metadata is stored in the XDMF file using an XML format, and<br>
large attribute arrays are stored in a corresponding HDF5 file. The<br>
output may be unstructured grid, structured grid, or rectiliner grid.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,820: Line 2,722:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the VTK XML unstructured grid data format. The standard extension is .vtu. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
|
This property lists which cell-centered arrays to read.
This property lists which the cell-centered arrays to read.


| �
| �
Line 2,838: Line 2,733:
|-
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| '''File Name'''<br>''(FileName)''
|
|
This property lists which point-centered arrays to read.
This property specifies the file name for the XDMF reader.


| �
| �
|
| �
|-
| '''Grids'''<br>''(GridStatus)''
| �
| �
| �
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which the point-centered arrays to read.
 
| �
|
The list of array names is provided by the reader.
 
|-
| '''Sets'''<br>''(SetStatus)''
|
Select the sets to be loaded from the dataset, if any.
 
| �
|
The list of array names is provided by the reader.
The list of array names is provided by the reader.


|-
| '''Stride'''<br>''(Stride)''
|
If loading structured data, this property indicate the number of
indices per dimension (X, Y, or Z) to skip between each point included
in this output.
| 1 1 1
|
The value must be greater than or equal to (1, 1, 1).
|}
==XML Hierarchical Box Data reader==
Read a VTK XML-based data file containing a hierarchical dataset containing vtkUniformGrids.
The XML Hierarchical Box Data reader reads VTK's XML-based file format<br>
containing a vtkHierarchicalBoxDataSet. The expected file extensions is<br>
either .vthb or .vth.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be
in the VTK XML polygonal dataset format. The standard extension is
.vtp. If more than 1 file is specified, the reader will switch to file
series mode in which it will pretend that it can support time and
provide 1 file per time step.
| �
| �
|}
==XML Image Data Reader==
Read serial VTK XML image data files.
The XML Image Data reader reads the VTK XML image data file format. The standard extension is .vti. This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the VTK XML image data format. The standard extension is .vti. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|}
==XML MultiBlock Data Reader==
Read a VTK XML multi-block data file and the serial VTK XML data files to which it points.
The XML Multi-Block Data reader reads the VTK XML multi-block data file<br>
format. XML multi-block data files are meta-files that point to a list of<br>
serial VTK XML files. When reading in parallel, this reader will<br>
distribute sub-blocks among processors. The expected file extensions are<br>
.vtm and .vtmb.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be
in the VTK XML polygonal dataset format. The standard extension is
.vtp. If more than 1 file is specified, the reader will switch to file
series mode in which it will pretend that it can support time and
provide 1 file per time step.
| �
| �
|}
==XML Partitioned Image Data Reader==
Read the summary file and the associated VTK XML image data files.
The XML Partitioned Image Data reader reads the partitioned VTK image data file format. It reads the partitioned format's summary file and then the associated VTK XML image data files. The expected file extension is .pvti. This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML image data format. The standard extension is .pvti. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This propert lists which cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|}
==XML Partitioned Polydata Reader==
Read the summary file and the assicoated VTK XML polydata files.
The XML Partitioned Polydata reader reads the partitioned VTK polydata file format. It reads the partitioned format's summary file and then the associated VTK XML polydata files. The expected file extension is .pvtp.  This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML polygonal dataset format. The standard extension is .pvtp. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|}
==XML Partitioned Rectilinear Grid Reader==
Read the summary file and the associated VTK XML rectilinear grid data files.
The XML Partitioned Rectilinear Grid reader reads the partitioned VTK rectilinear grid file format. It reads the partitioned format's summary file and then the associated VTK XML rectilinear grid files. The expected file extension is .pvtr. This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML rectilinear grid data format. The standard extension is .pvtr. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|}
==XML Partitioned Structured Grid Reader==
Read the summary file and the associated VTK XML structured grid data files.
The XML Partitioned Structured Grid reader reads the partitioned VTK structured grid data file format. It reads the partitioned format's summary file and then the associated VTK XML structured grid data files. The expected file extension is .pvts. This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML structured grid data format. The standard extension is .pvts. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|}
==XML Partitioned Unstructured Grid Reader==
Read the summary file and the associated VTK XML unstructured grid data files.
The XML Partitioned Unstructured Grid reader reads the partitioned VTK unstructured grid data file format. It reads the partitioned format's summary file and then the associated VTK XML unstructured grid data files. The expected file extension is .pvtu. This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML unstructured grid data format. The standard extension is .pvtu. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|}
==XML PolyData Reader==
Read serial VTK XML polydata files.
The XML Polydata reader reads the VTK XML polydata file format. The standard extension is .vtp.  This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the VTK XML polygonal dataset format. The standard extension is .vtp. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|}
==XML Rectilinear Grid Reader==
Read serial VTK XML rectilinear grid data files.
The XML Rectilinear Grid reader reads the VTK XML rectilinear grid data file format. The standard extension is .vtr. This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the VTK XML rectilinear grid data format. The standard extension is .vtr. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|}
==XML Structured Grid Reader==
Read serial VTK XML structured grid data files.
The XML Structured Grid reader reads the VTK XML structured grid data file format. The standard extension is .vts. This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the VTK XML structured grid data format. The standard extension is .vts. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|}
==XML Unstructured Grid Reader==
Read serial VTK XML unstructured grid data files.
The XML Unstructured Grid reader reads the VTK XML unstructured grid data file format. The standard extension is .vtu. This reader also supports file series.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
The list of files to be read by the reader. Each file is expected to be in the VTK XML unstructured grid data format. The standard extension is .vtu. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.
| �
| �
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|
This property lists which cell-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
This property lists which point-centered arrays to read.
| �
|
The list of array names is provided by the reader.
|}
==XYZ Reader==
Read XYZ molecular data files into a polygonal dataset.
The XYZ reader reads XYZ molecular data files. The expected file extension is .xyz. The output of this reader is a polygonal dataset.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
This property specifies the file name for the XYZ reader.
| �
| �
|-
| '''Time Step'''<br>''(TimeStep)''
|
This property specifies the timestep the XYZ reader should load.
| 0
| �
|}
==proSTAR (STARCD) Reader==
Reads geometry in proSTAR (STARCD) file format.
ProStarReader creates an unstructured grid dataset.<br>
It reads .cel/.vrt files stored in proSTAR (STARCD) ASCII format.<br>
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''File Name'''<br>''(FileName)''
|
Set the file name for the proSTAR (STARCD) reader.
| �
| �
|-
| '''Scale Factor'''<br>''(ScaleFactor)''
|
Scaling factor for the points
| 0
| �
|}
|}

Revision as of 15:36, 12 October 2010

ParaViewUsersGuide


AVS UCD Reader

Read binary or ASCII files stored in AVS UCD format.

The AVS UCD reader reads binary or ASCII files stored in AVS UCD format.
The default file extension is .inp. The output of this reader is
unstructured grid. This supports reading a file series.

Property Description Default Value(s) Restrictions
File Names
(FileNames)

The list of files to be read by the reader. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This property contains a list of the cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property contains a list of the point-centered arrays to read.

The list of array names is provided by the reader.


BYU Reader

Read Movie.BYU files to produce polygonal data.

The BYU reader reads data stored in Movie.BYU format. The expected file extension is .g. The datasets resulting from reading these files are polygonal.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the BYU reader.


COSMO Reader

Read a cosmology file into a vtkUnstructuredGrid.

The Cosmology reader reads a binary file of particle location,
velocity, and id creating a vtkUnstructuredGrid. The default
file extension is .cosmo. Reads LANL Cosmo format or Gadget format.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader.

Cosmo Format
(CosmoFormat)

If checked, the data will be read as the LANL Cosmo format. If unchecked, the data will be read as Gadget-2 format.

1

Only the values 0 and 1 are accepted.

overlap (shared point/ghost cell gap distance)
(Overlap)

The space in rL units to extend processor particle ownership for ghost particles/cells. Needed for correct halo calculation when halos cross processor boundaries in parallel computation.

5

The value must be greater than or equal to 0.

rL (physical box side length)
(RL)

The box side length used to wrap particles around if they exceed rL (or less than 0) in any dimension.

90.1408

The value must be greater than or equal to 0.


CSV Reader

Read a comma-separated values file into a 1D rectilinear grid.

The CSV reader reads a comma-separated values file into a 1D rectilinear
grid. If the file was saved using the CSVWriter, then the rectilinear
grid's points and point data can be restored as well as the cell data.
Otherwise all the data in the CSV file is treated as cell data. The
default file extension is .csv.
This can read file series as well.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be a csv file. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Detect Numeric Columns
(DetectNumericColumns)

When set to true, the reader will detect numeric columns and create vtkDoubleArray or vtkIntArray for those instead of vtkStringArray.

1

Only the values 0 and 1 are accepted.

Field Delimiter Characters
(FieldDelimiterCharacters)

This property lists the characters that may be used to separate fields. For example, a value of "," indicates a comma-separated value file. A value of ".:;" indicates that columns may be separated by a period, colon or semicolon. The order of the characters in the text string does not matter.

,
Have Headers
(HaveHeaders)

If the value of this property is 1, treat the first line of the file as headers.

1

Only the values 0 and 1 are accepted.

Merge Consecutive Delimiters
(MergeConsecutiveDelimiters)

Whether to merge successive delimiters. Use this if (for example) your fields are separated by spaces but you don't know exactly how many.

0

Only the values 0 and 1 are accepted.

Use String Delimiter
(UseStringDelimiter)

This property indicates whether to use the string delimiter.

1

Only the values 0 and 1 are accepted.


DEM Reader

Read a DEM (Digital Elevation Model) file.

The DEM reader reads Digital Elevation Model files containing elevation values derived from the U. S. Geologic Survey. The default file extension is .dem. This reader produces uniform rectilinear (image/volume) data output.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the DEM (Digital Elevation Map) reader.


EnSight Master Server Reader

Read files in EnSight's Master Server format.

The EnSight Master Server reader reads EnSight's parallel files. The master file ususally has a .sos extension and may point to multiple .case files. The output is a multi-block dataset.

Property Description Default Value(s) Restrictions
Byte Order
(ByteOrder)

This property indicates the byte order of the binary file(s).

0

The value must be one of the following: BigEndian (0), LittleEndian (1).

Case File Name
(CaseFileName)

This property specifies the name of the .sos file for the EnSight Master Server reader.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.

Set Time Value
(SetTimeValue)

This property indicates which time value to read.

0


EnSight Reader

Read EnSight 6 and Gold files.

The EnSight reader reads files in the format produced by CEI's EnSight. EnSight 6 and Gold files (both ASCII and binary) are supported. The default extension is .case. The output of this reader is a multi-block dataset.

Property Description Default Value(s) Restrictions
Case File Name
(CaseFileName)

This property specifies the case file name for the EnSight reader.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


Enzo Reader

Read multi-block dataset from an Enzo file.

This Enzo reader loads data stored in Enzo format. The output of this reader is a multi-block dataset.

Property Description Default Value(s) Restrictions
Block Output Type
(BlockOutputType)

The property indicates the output type of each block, either vtkImageData (by default) or vtkRectilinearGrid.

0

The value must be one of the following: Image Data (0), Rectilinear Grid (1).

File Name
(FileName)

This property specifies the file name for the Enzo reader.

Load Particles
(LoadParticles)

Load particles when on.

1

Only the values 0 and 1 are accepted.

Max Level
(MaxLevel)

Do not blocks above this level.

100


ExodusIIReader

Read an Exodus II file to produce an unstructured grid.

The Exodus reader loads Exodus II files and produces an unstructured grid output. The default file extensions are .g, .e, .ex2, .ex2v2, .exo, .gen, .exoII, .exii, .0, .00, .000, and .0000 .

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the Exodus reader.

Use Meta File
(UseMetaFile)

This hidden property must always be set to 1 for this proxy to work.

0

Only the values 0 and 1 are accepted.

Animate Vibrations
(AnimateVibrations)

If this flag is on and HasModeShapes is also on, then this reader will report a continuous time range [0,1] and animate the displacements in a periodic sinusoid. If this flag is off and HasModeShapes is on, this reader ignores time. This flag has no effect if HasModeShapes is off.

1

Only the values 0 and 1 are accepted.

Apply Displacements
(ApplyDisplacements)

Geometric locations can include displacements. When this option is on, the nodal positions are 'displaced' by the standard exodus displacement vector. If displacements are turned 'off', the user can explicitly add them by applying a warp filter.

1

Only the values 0 and 1 are accepted.

Displacement Magnitude
(DisplacementMagnitude)

When displacements are being applied, they are scaled by this amount. Set to 1 for no scaling.

1
Edge Blocks
(EdgeBlocks)

The list of array names is provided by the reader.

Edge Map Array Status
(EdgeMapArrayStatus)

The list of array names is provided by the reader.

Edge Set Array Status
(EdgeSetArrayStatus)

The list of array names is provided by the reader.

Edge Set Result Array Status
(EdgeSetResultArrayStatus)

The list of array names is provided by the reader.

Edge Variables
(EdgeVariables)

The list of array names is provided by the reader.

Element Blocks
(ElementBlocks)
Element Map Array Status
(ElementMapArrayStatus)

The list of array names is provided by the reader.

Element Set Array Status
(ElementSetArrayStatus)

The list of array names is provided by the reader.

Element Set Result Array Status
(ElementSetResultArrayStatus)

The list of array names is provided by the reader.

Element Variables
(ElementVariables)

The list of array names is provided by the reader.

Exodus Model Metadata
(ExodusModelMetadata)
0

Only the values 0 and 1 are accepted.

Face Blocks
(FaceBlocks)

The list of array names is provided by the reader.

Face Map Array Status
(FaceMapArrayStatus)

The list of array names is provided by the reader.

Face Set Array Status
(FaceSetArrayStatus)

The list of array names is provided by the reader.

Face Set Result Array Status
(FaceSetResultArrayStatus)

The list of array names is provided by the reader.

Face Variables
(FaceVariables)

The list of array names is provided by the reader.

File Pattern
(FilePattern)

This property contains a text string specifying the pattern used to load files. There are two parts to it: the prefix (%s) and the file number (%i). The format used is the same as that used for printf.

File Prefix
(FilePrefix)

This property specifies the file root used with the file pattern to format a file name. (See the File Pattern property.)

File Range
(FileRange)

This property controls the indices of the first and last files to be read.

-1 -1
Generate Global Element Id Array
(GenerateGlobalElementIdArray)
1

Only the values 0 and 1 are accepted.

Generate Global Node Id Array
(GenerateGlobalNodeIdArray)
1

Only the values 0 and 1 are accepted.

Generate Object Id Cell Array
(GenerateObjectIdCellArray)
1

Only the values 0 and 1 are accepted.

Global Variables
(GlobalVariables)

The list of array names is provided by the reader.

Has Mode Shapes
(HasModeShapes)

Some simulations overload the Exodus time steps to represent mode shapes. In this case, it does not make sense to iterate over the "time steps", because they are not meant to be played in order. Rather, each represents the vibration at a different "mode." Setting the value of this property to 1 changes the semantics of the reader to not report the time steps to downstream filters.

0

Only the values 0 and 1 are accepted.

Mode Shape
(ModeShape)

Specify the current mode shape when HasModeShapes in on.

1
Node Map Array Status
(NodeMapArrayStatus)

The list of array names is provided by the reader.

Node Set Array Status
(NodeSetArrayStatus)

The list of array names is provided by the reader.

Node Set Result Array Status
(NodeSetResultArrayStatus)

The list of array names is provided by the reader.

Point Variables
(PointVariables)

The list of array names is provided by the reader.

Side Set Array Status
(SideSetArrayStatus)

The list of array names is provided by the reader.

Side Set Result Array Status
(SideSetResultArrayStatus)

The list of array names is provided by the reader.

XML File Name
(XMLFileName)

This property specifies the name of an XML file containing part and material descriptions and a mapping to element blocks.


FLUENTReader

Reads a dataset in Fluent file format.

FLUENTReader creates an unstructured grid dataset. It reads .cas and
.dat files stored in FLUENT native format.

Property Description Default Value(s) Restrictions
Cell Arrays
(CellArrayStatus)

Select which cell-centered arrays to read.

The list of array names is provided by the reader.

File Name
(FileName)

Set the file name for the FLUENT reader.


Flash Reader

Read multi-block dataset from a Flash file.

This Flash reader loads data stored in Flash format. The output of this reader is a multi-block dataset.

Property Description Default Value(s) Restrictions
Block Output Type
(BlockOutputType)

The property indicates the output type of each block, either vtkImageData (by default) or vtkRectilinearGrid.

0

The value must be one of the following: Image Data (0), Rectilinear Grid (1).

File Name
(FileName)

This property specifies the file name for the Flash reader.

Load Morton Curve
(LoadMortonCurve)

Generate morton curve when on.

0

Only the values 0 and 1 are accepted.

Load Particles
(LoadParticles)

Load particles when on.

1

Only the values 0 and 1 are accepted.


Gaussian Cube Reader

Produce polygonal data by reading a Gaussian Cube file.

The Gaussian Cube reader produces polygonal data by reading data files produced by the Gaussian software package. The expected file extension is .cube.

Property Description Default Value(s) Restrictions
B Scale
(BScale)

A scaling factor to compute bonds between non-hydrogen atoms

1
File Name
(FileName)

This property specifies the file name for the Gaussian Cube reader.

H BScale
(HBScale)

A scaling factor to compute bonds with hydrogen atoms.

1


Image Reader

Read raw regular rectilinear grid data from a file. The dimensions and type of the data must be specified.

The Image reader reads raw regular rectilinear grid (image/volume) data from a file. Because no metadata is provided, the user must specify information about the size, spacing, dimensionality, etc. about the dataset.

Property Description Default Value(s) Restrictions
Data Byte Order
(DataByteOrder)

This property indicates the byte order of the binary file(s).

0

The value must be one of the following: BigEndian (0), LittleEndian (1).

Data Extent
(DataExtent)

This property specifies the minimum and maximum index values of the data in each dimension (xmin, xmax, ymin, ymax, zmin, zmax).

0 0 0 0 0 0
Data Origin
(DataOrigin)

The coordinate contained in this property specifies the position of the point with index (0,0,0).

0 0 0
Data Scalar Type
(DataScalarType)

The value of this property indicates the scalar type of the pixels/voxels in the file(s): short, int, float ...

4

The value must be one of the following: char (2), unsigned char (3), short (4), unsigned short (5), int (6), unsigned int (7), long (8), unsigned long (9), float (10), double (11).

Data Spacing
(DataSpacing)

This property specifies the size of a voxel in each dimension.

1 1 1
File Dimensionality
(FileDimensionality)

This property indicates whether the file(s) in this dataset contain slices (2D) or volumes (3D).

3

The value must be one of the following: 2 (2), 3 (3).

File Lower Left
(FileLowerLeft)

This property determines whether the data originates in the lower left corner (on) or the upper left corner (off). Most scientific data is written with a right-handed axes that originates in the lower left corner. However, several 2D image file formats write the image from the upper left corner.

1

Only the values 0 and 1 are accepted.

File Pattern
(FilePattern)

The text string contained in the property specifies the format string to determine the file names necessary for reading this dataset. In creating the filenames, %s will be replaced by the prefix and %d by a digit which represents the slice number in Z. The format string is the same as that used by printf.

%s
File Prefix
(FilePrefix)

The text string contained in this property specifies the file prefix (directory plus common initial part of file name) for the raw binary uniform rectilinear grid dataset.

Number Of Scalar Components
(NumberOfScalarComponents)

This property specifies the number of componenets the scalar value at each pixel or voxel has (e.g., RGB - 3 scalar components).

1
Scalar Array Name
(ScalarArrayName)

This property contains a text string listing a name to assign to the point-centered data array read.

ImageFile


LSDynaReader

Read LS-Dyna databases (d3plot).

This reader reads LS-Dyna databases.

Property Description Default Value(s) Restrictions
Beam Arrays
(BeamArrayStatus)

Select which beam arrays to read.

The list of array names is provided by the reader.

Deformed Mesh
(DeformedMesh)

Should the mesh be deformed over time (if the Deflection node array is set to load)?

1

Only the values 0 and 1 are accepted.

File Name
(FileName)

Set the file name for the LSDyna reader.

Part Arrays
(PartArrayStatus)

Select which part arrays to read.

The list of array names is provided by the reader.

Particle Arrays
(ParticleArrayStatus)

Select which particle arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

Select which point-centered arrays to read.

The list of array names is provided by the reader.

Remove Deleted Cells
(RemoveDeletedCells)

Should cells that have been deleted (failed structurally, for example) be removed from the mesh?

1

Only the values 0 and 1 are accepted.

Rigid Body Arrays
(RigidBodyArrayStatus)

Select which rigid body arrays to load.

The list of array names is provided by the reader.

Road Surface Arrays
(RoadSurfaceArrayStatus)

Select which road surface arrays to read.

The list of array names is provided by the reader.

Shell Arrays
(ShellArrayStatus)

Select which shell arrays to read.

The list of array names is provided by the reader.

Solid Arrays
(SolidArrayStatus)

Select which solid arrays to read.

The list of array names is provided by the reader.

Split by Material Id
(SplitByMaterialId)

Should each material have its own mesh, or should there be one mesh for all materials?

0

Only the values 0 and 1 are accepted.

Thick Shell Arrays
(ThickShellArrayStatus)

Select which thick shell arrays to read.

The list of array names is provided by the reader.


Legacy VTK Reader

Read files stored in VTK's legacy file format.

The Legacy VTK reader loads files stored in VTK's legacy file format (before VTK 4.2, although still supported). The expected file extension is .vtk. The type of the dataset may be structured grid, uniform rectilinear grid (image/volume), non-uniform rectiinear grid, unstructured grid, or polygonal. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Names
(FileNames)

The list of files to be read by the reader. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.


MFIXReader

Reads a dataset in MFIX file format.

vtkMFIXReader creates an unstructured grid dataset. It reads a restart
file and a set of sp files. The restart file contains the mesh
information. MFIX meshes are either cylindrical or rectilinear, but
this reader will convert them to an unstructured grid. The sp files
contain transient data for the cells. Each sp file has one or more
variables stored inside it.

Property Description Default Value(s) Restrictions
Cell Arrays
(CellArrayStatus)

Select which cell-centered arrays to read.

The list of array names is provided by the reader.

File Name
(FileName)

Set the file name for the MFIX reader.


Meta Image reader

Read binary UNC meta image data.

The Meta Image Reader reads binary UNC meta image data, and produces uniform rectilinear (image/volume) data. The default file extensions are .mhd and .mha.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the Meta Image reader.


NetCDF MPAS reader

Read unstructured grid data from a file.

The Image reader reads unstructured grid from a file. Grid is dual grid.

Property Description Default Value(s) Restrictions
Cell Array Status
(CellArrayStatus)

This property lists which netCDF dual-grid cell variables to load.

The list of array names is provided by the reader.

File Name
(FileName)

This property specifies the file name to read.

Point Array Status
(PointArrayStatus)

This property lists which netCDF dual-grid point variables to load.

The list of array names is provided by the reader.

Vertical Level
(VerticalLevel)
0


NetCDF POP reader

Read raw regular rectilinear grid data from a file. The dimensions and type of the data must be specified.

The Image reader reads raw regular rectilinear grid (image/volume) data from a file. Because no metadata is provided, the user must specify information about the size, spacing, dimensionality, etc. about the dataset.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name to read.

Stride
(Stride)

This property indicate the number of indices per dimension (i,j,k) to skip between each point included in this output.

1 1 1

The value must be greater than or equal to (1, 1, 1).

Variables
(VariableArrayStatus)

This property lists which netCDF variables to load.

The list of array names is provided by the reader.


NetCDF Reader

Read regular arrays from netCDF files. Will also read any topological information specified by the COARDS and CF conventions.

Reads arrays from netCDF files into structured VTK data sets. In
the absence of any other information, the files will be read as
image data. This reader will also look for meta information
specified by the CF convention that specify things like topology
and time. This information can cause the output to be a nonuniform
rectilinear grid or curvilinear (structured) grid. Details on the
CF convention can be found at http://cf-pcmdi.llnl.gov/. It should
be noted that the CF convention is a superset of the COARDS
convention, so COARDS conventions will also be recognized.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The name of the files to load.

Dimensions
(Dimensions)

Load the grid with the given dimensions. Any arrays that conform to these dimensions will be loaded.

.

Replace Fill Value With Nan
(ReplaceFillValueWithNan)

If on, any float or double variable read that has a _FillValue attribute will have that fill value replaced with a not-a-number (NaN) value. The advantage of setting these to NaN values is that, if implemented properly by the system and careful math operations are used, they can implicitly be ignored by calculations like finding the range of the values. That said, this option should be used with caution as VTK does not fully support NaN values and therefore odd calculations may occur.

0

Only the values 0 and 1 are accepted.

Spherical Coordinates
(SphericalCoordinates)

If on, then data with latitude/longitude dimensions will be read in as curvilinear data shaped like spherical coordinates. If false, then the data will always be read in Cartesian coordinates.

1

Only the values 0 and 1 are accepted.

Vertical Bias
(VerticalBias)

The bias of the vertical component of spherical coordinates. It is common to write the vertical component with respect to something other than the center of the sphere (for example, the surface). In this case, it might be necessary to scale and/or bias the vertical height. The height will become height*scale + bias. Keep in mind that if the positive attribute of the vertical dimension is down, then the height is negated. The scaling will be adjusted if it results in invalid (negative) vertical values.

0
Vertical Scale
(VerticalScale)

The scale of the vertical component of spherical coordinates. It is common to write the vertical component with respect to something other than the center of the sphere (for example, the surface). In this case, it might be necessary to scale and/or bias the vertical height. The height will become height*scale + bias. Keep in mind that if the positive attribute of the vertical dimension is down, then the height is negated. The scaling will be adjusted if it results in invalid (negative) vertical values.

1


Nrrd Reader

Read raw image files with Nrrd meta data.

The Nrrd reader reads raw image data much like the Raw Image Reader
except that it will also read metadata information in the Nrrd format.
This means that the reader will automatically set information like file
dimensions.


There are several limitations on what type of nrrd files we can
read. This reader only supports nrrd files in raw format. Other
encodings like ascii and hex will result in errors. When reading in
detached headers, this only supports reading one file that is
detached.

Property Description Default Value(s) Restrictions
Data VOI
(DataVOI)

The data volume of interest (VOI). The VOI is a sub-extent of the data that you want loaded. Setting a VOI is useful when reading from a large data set and you are only interested in a small portion of the data. If left containing all 0's, then the reader will load in the entire data set.

0 0 0 0 0 0
File Name
(FileName)

The name of the file to read (or the meta data file that will point to the actual file).


OpenFOAMReader

Sorry, no help is currently available.


Property Description Default Value(s) Restrictions
Add dimensional units to array names
(AddDimensionsToArrayNames)

Read dimensional units from field data and add them to array names as human-readable string.

0

Only the values 0 and 1 are accepted.

Cache mesh
(CacheMesh)

Cache the OpenFOAM mesh between GUI selection changes.

1

Only the values 0 and 1 are accepted.

Case Type
(CaseType)

The property indicates whether decomposed mesh or reconstructed mesh should be read

1

The value must be one of the following: Decomposed Case (0), Reconstructed Case (1).

Cell Arrays
(CellArrays)

The list of array names is provided by the reader.

Create cell-to-point filtered data
(CreateCellToPoint)

Create point data from cell data. Beware: the filter does not do inverse distance weighting.

1

Only the values 0 and 1 are accepted.

Decompose polyhedra
(DecomposePolyhedra)

Decompose polyhedra into tetrahedra and pyramids.

1

Only the values 0 and 1 are accepted.

File Name
(FileName)
Lagrangian Arrays
(LagrangianArrays)

The list of array names is provided by the reader.

List timesteps according to controlDict
(ListTimeStepsByControlDict)

List time directories listed according to the settings in controlDict.

0

Only the values 0 and 1 are accepted.

Mesh Regions
(MeshRegions)

The list of array names is provided by the reader.

Point Arrays
(PointArrays)

The list of array names is provided by the reader.

Lagrangian positions are in OF 1.3 binary format
(PositionsIsIn13Format)

Set if Lagrangian positions files are in OpenFOAM 1.3 binary format.

0

Only the values 0 and 1 are accepted.

Read zones
(ReadZones)

Read point/face/cell-Zones?

0

Only the values 0 and 1 are accepted.


PDB Reader

Read PDB molecule files.

The PDB reader reads files in the format used by the Protein Data Bank (an archive of experimentally determined three-dimensional structures of biological macromolecules). The expected file extension is .pdb. The output datasets are polygonal.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the PDB reader.


PLOT3D Reader

Read ASCII or binary PLOT3D files.

PLOT3D is a plotting package developed at NASA. The PLOT3D reader can read both ASCII and binary PLOT3D files. The default file extension for the geometry files is .xyz, and the default file extension for the solution files is .q. The output of this reader is a multi-block dataset containing curvilinear (structured grid) datasets.

Property Description Default Value(s) Restrictions
Q File Name
(QFileName)

The list of .q (solution) files for the PLOT3D reader. This can be more than 1. If more that 1 file is specified, the reader will switch to file-series mode in which it will pretend that it can support time and provide 1 file per time step.

Binary File
(BinaryFile)

This property indicates whether the data files are binary.

1

Only the values 0 and 1 are accepted.

Byte Order
(ByteOrder)

This property specifies the byte order of any binary file(s).

0

The value must be one of the following: BigEndian (0), LittleEndian (1).

File Name
(FileName)

This property specifies the .xyz (geometry) file name for the PLOT3D reader.

Force Read
(ForceRead)

This property indicates whether to attempt to read the file even if it appears corrupt

0

Only the values 0 and 1 are accepted.

Functions
(Functions)

This property lists which functions (point-centered arrays) to compute.

The value must be one of the following: Scalar - Pressure (110), Scalar - Temperature (120), Scalar - Enthalpy (130), Scalar - Internal energy (140), Scalar - Kinetic energy (144), Scalar - Velocity magnitude (153), Scalar - Entropy (170), Scalar - Swirl. (184), Vector - Velocity (200), Vector - Vorticity (201), Vector - Pressure gradient (210).

Has Byte Count
(HasByteCount)

This property indicates whether this file uses Fortran leading-trailing byte counts.

0

Only the values 0 and 1 are accepted.

I Blanking
(IBlanking)

This property indicates whether this dataset has visibility information.

0

Only the values 0 and 1 are accepted.

Multi Grid
(MultiGrid)

This property indicates whether these files have multiple-block information.

0

Only the values 0 and 1 are accepted.

Two Dimensional Geometry
(TwoDimensionalGeometry)

This property indicates whether the data is two- or three-dimensional.

0

Only the values 0 and 1 are accepted.


PLY Reader

Read files stored in Stanford University's PLY polygonal file format.

The PLY reader reads files stored in the PLY polygonal file format developed at Stanford University. The PLY files that ParaView can read must have the elements "vertex" and "face" defined. The "vertex" elements must have the propertys "x", "y", and "z". The "face" elements must have the property "vertex_indices" defined. The default file extension for this reader is .ply.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the PLY reader.


POP Reader

Read data files from the Parallel Ocean Program (POP).

The POP reader reads data files from the Parallel Ocean Program (POP). The expected file extension is .pop. The output of this reader is a structured grid dataset.

Property Description Default Value(s) Restrictions
Clip Extent
(ClipExtent)

This property indicates the minimum and maximum extent in each dimension of the dataset (X, Y, and Z) to read.

-2147483647 2147483647 -2147483647 2147483647 -2147483647 2147483647
File Name
(FileName)

This property specifies the file name for the POP Ocean file reader.

Number Of Ghost Levels
(NumberOfGhostLevels)

This property indicates the number of ghost levels to generate.

1
Radius
(Radius)

This property specifies the radius of the dataset.

60000


PVD Reader

Load a dataset stored in ParaView's PVD file format.

The PVD reader reads data stored in ParaView's PVD file format. The .pvd file is essentially a header file that collects together other data files stored in VTK's XML-based file format.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the PVD reader.


Particles Reader

Read particle data.

vtkParticleReader reads either a binary or a text file of particles.
Each particle can have associated with it an optional scalar value. So
the format is: x, y, z, scalar (all floats or doubles). The text file
can consist of a comma delimited set of values. In most cases
vtkParticleReader can automatically determine whether the file is text
or binary. The data can be either float or double. Progress updates
are provided. With respect to binary files, random access into the file
to read pieces is supported.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader.

Byte Order
(ByteOrder)

Set/Get the byte ordering of the file you are trying to read in.

0

The value must be one of the following: BigEndian (0), LittleEndian (1).

Data Type
(DataType)

Get/Set the data type. The options are: - Float (10) (default) single precision floating point. - Double (11) double precision floating point.

10

The value must be one of the following: Float (10), Double (11).

File Type
(FileType)

Set the file type. The options are: - Unknown (0) (default) the reader will attempt to determine the file type. If this fails then you should set the file type yourself. - Text (1) the file type is text. - Binary (2) the file type is binary.

0

The value must be one of the following: Unknown (0), Text (1), Binary (2).

Has Scalar
(HasScalar)

Default: 1. If 1 then each particle has a value associated with it.

1

Only the values 0 and 1 are accepted.


Partitioned Legacy VTK Reader

Read files stored in VTK partitioned legacy format.

The Partitioned Legacy VTK reader loads files stored in VTK's partitioned legac file format (before VTK 4.2, although still supported). The expected file extension is .pvtk. The type of the dataset may be structured grid, uniform rectilinear grid (image/volume), non-uniform rectilinear grid, unstructured grid, or polygonal.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the Partitioned Legacy VTK reader.


Phasta Reader

Read the parallel Phasta meta-file and the underlying Phasta files.

This Phasta reader reads files stored in the Phasta (a CFD package) format. The expected file extension is .pht. The output of this reader is a multipiece data set.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the Phasta reader.


Restarted Sim Exodus Reader

Read collections of Exodus output files from simulations that were restarted.

When a simulation that outputs exodus files is restarted, typically you get a new set of output files. When you read them in your visualization, you often want to string these file sets together as if it was one continuous dump of files. This reader allows you to specify a metadata file that will implicitly string the files together.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This points to a special metadata file that lists the output files for each restart.

Use Meta File
(UseMetaFile)

This hidden property must always be set to 1 for this proxy to work.

1

Only the values 0 and 1 are accepted.

Animate Vibrations
(AnimateVibrations)

If this flag is on and HasModeShapes is also on, then this reader will report a continuous time range [0,1] and animate the displacements in a periodic sinusoid. If this flag is off and HasModeShapes is on, this reader ignores time. This flag has no effect if HasModeShapes is off.

1

Only the values 0 and 1 are accepted.

Apply Displacements
(ApplyDisplacements)

Geometric locations can include displacements. When this option is on, the nodal positions are 'displaced' by the standard exodus displacement vector. If displacements are turned 'off', the user can explicitly add them by applying a warp filter.

1

Only the values 0 and 1 are accepted.

Displacement Magnitude
(DisplacementMagnitude)

When displacements are being applied, they are scaled by this amount. Set to 1 for no scaling.

1
Edge Blocks
(EdgeBlocks)

The list of array names is provided by the reader.

Edge Map Array Status
(EdgeMapArrayStatus)

The list of array names is provided by the reader.

Edge Set Array Status
(EdgeSetArrayStatus)

The list of array names is provided by the reader.

Edge Set Result Array Status
(EdgeSetResultArrayStatus)

The list of array names is provided by the reader.

Edge Variables
(EdgeVariables)

The list of array names is provided by the reader.

Element Blocks
(ElementBlocks)
Element Map Array Status
(ElementMapArrayStatus)

The list of array names is provided by the reader.

Element Set Array Status
(ElementSetArrayStatus)

The list of array names is provided by the reader.

Element Set Result Array Status
(ElementSetResultArrayStatus)

The list of array names is provided by the reader.

Element Variables
(ElementVariables)

The list of array names is provided by the reader.

Exodus Model Metadata
(ExodusModelMetadata)
0

Only the values 0 and 1 are accepted.

Face Blocks
(FaceBlocks)

The list of array names is provided by the reader.

Face Map Array Status
(FaceMapArrayStatus)

The list of array names is provided by the reader.

Face Set Array Status
(FaceSetArrayStatus)

The list of array names is provided by the reader.

Face Set Result Array Status
(FaceSetResultArrayStatus)

The list of array names is provided by the reader.

Face Variables
(FaceVariables)

The list of array names is provided by the reader.

Generate Global Element Id Array
(GenerateGlobalElementIdArray)
1

Only the values 0 and 1 are accepted.

Generate Global Node Id Array
(GenerateGlobalNodeIdArray)
1

Only the values 0 and 1 are accepted.

Generate Object Id Cell Array
(GenerateObjectIdCellArray)
1

Only the values 0 and 1 are accepted.

Global Variables
(GlobalVariables)

The list of array names is provided by the reader.

Has Mode Shapes
(HasModeShapes)

Some simulations overload the Exodus time steps to represent mode shapes. In this case, it does not make sense to iterate over the "time steps", because they are not meant to be played in order. Rather, each represents the vibration at a different "mode." Setting the value of this property to 1 changes the semantics of the reader to not report the time steps to downstream filters.

0

Only the values 0 and 1 are accepted.

Mode Shape
(ModeShape)

Specify the current mode shape when HasModeShapes in on.

1
Node Map Array Status
(NodeMapArrayStatus)

The list of array names is provided by the reader.

Node Set Array Status
(NodeSetArrayStatus)

The list of array names is provided by the reader.

Node Set Result Array Status
(NodeSetResultArrayStatus)

The list of array names is provided by the reader.

Point Variables
(PointVariables)

The list of array names is provided by the reader.

Side Set Array Status
(SideSetArrayStatus)

The list of array names is provided by the reader.

Side Set Result Array Status
(SideSetResultArrayStatus)

The list of array names is provided by the reader.

XML File Name
(XMLFileName)

This property specifies the name of an XML file containing part and material descriptions and a mapping to element blocks.


Restarted Sim Spy Plot Reader

Read collections of SPCTH files from simulations that were restarted.

When a CTH simulation is restarted, typically you get a new set of output files. When you read them in your visualization, you often want to string these file sets together as if it was one continuous dump of files. This reader allows you to specify a metadata file that will implicitly string the files together.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This points to a special metadata file that lists the output files for each restart.

Use Meta File
(UseMetaFile)

This hidden property must always be set to 1 for this proxy to work.

1

Only the values 0 and 1 are accepted.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Distribute Files
(DistributeFiles)

In parallel mode, if this property is set to 1, the reader will distribute files or blocks.

1

Only the values 0 and 1 are accepted.

Down Convert Volume Fraction
(DownConvertVolumeFraction)

If this property is set to 0, the type of the volume fraction is float; is set to 1, the type is unsigned char.

1

Only the values 0 and 1 are accepted.

Generate Active Block Array
(GenerateActiveBlockArray)

If this property is set to 1, a cell array will be generated that stores the active status of a block.

0

Only the values 0 and 1 are accepted.

Generate Block Id Array
(GenerateBlockIdArray)

If this property is set to 1, a cell array will be generated that stores a unique blockId for each block.

0

Only the values 0 and 1 are accepted.

Generate Level Array
(GenerateLevelArray)

If this property is set to 1, a cell array will be generated that stores the level of each block.

0

Only the values 0 and 1 are accepted.


SESAME Reader

Read SESAME data files, producing rectilinear grids.

The SESAME reader reads SESAME data files, and outputs rectilinear grids. The expected file extension is .sesame.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the SESAME reader.

Table Id
(TableId)

This proeprty indicates which table to read.

-1

The value must be one of the following:.


SLAC Data Reader

A reader for a data format used by Omega3p, Tau3p, and several
other tools used at the Standford Linear Accelerator Center (SLAC).
The underlying format uses netCDF to store arrays, but also imposes
several conventions to form an unstructured grid of elements.

Property Description Default Value(s) Restrictions
Mesh File Name
(MeshFileName)

The name of the mesh file to load.

Mode File Name
(ModeFileName)

The name of the mode files to load. The points in the mode file should be the same as the mesh file.

Read External Surface
(ReadExternalSurface)

If on, read the external surfaces of the data set.

1

Only the values 0 and 1 are accepted.

Read Internal Volume
(ReadInternalVolume)

If on, read the internal volume of the data set.

0

Only the values 0 and 1 are accepted.

Read Midpoints
(ReadMidpoints)

If on, reads midpoint information for external surfaces and builds quadratic surface triangles.

0

Only the values 0 and 1 are accepted.


SLAC Particle Data Reader

The SLAC Particle data reader.

Property Description Default Value(s) Restrictions
File Name
(FileName)

A list of files to be read in a time series.


STL Reader

Read ASCII or binary stereo lithography (STL) files.

The STL reader reads ASCII or binary stereo lithography (STL) files. The expected file extension is .stl. The output of this reader is a polygonal dataset. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Names
(FileNames)

The list of files to be read by the reader. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.


Spy Plot Reader

Read files in the SPCTH Spy Plot file format.

The Spy Plot reader loads an ASCII meta-file called the "case" file (extension .spcth). The case file lists all the binary files containing the dataset. This reader produces hierarchical datasets.

Property Description Default Value(s) Restrictions
Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Distribute Files
(DistributeFiles)

In parallel mode, if this property is set to 1, the reader will distribute files or blocks.

1

Only the values 0 and 1 are accepted.

Down Convert Volume Fraction
(DownConvertVolumeFraction)

If this property is set to 0, the type of the volume fraction is float; is set to 1, the type is unsigned char.

1

Only the values 0 and 1 are accepted.

File Name
(FileName)

This property specifies the file name for the Spy Plot reader.

Generate Active Block Array
(GenerateActiveBlockArray)

If this property is set to 1, a cell array will be generated that stores the active status of a block.

0

Only the values 0 and 1 are accepted.

Generate Block Id Array
(GenerateBlockIdArray)

If this property is set to 1, a cell array will be generated that stores a unique blockId for each block.

0

Only the values 0 and 1 are accepted.

Generate Level Array
(GenerateLevelArray)

If this property is set to 1, a cell array will be generated that stores the level of each block.

0

Only the values 0 and 1 are accepted.

Generate Tracer Array
(GenerateTracerArray)

If this property is set to 1, a cell array will be generated that stores the coordinates of any tracers.

0

Only the values 0 and 1 are accepted.

Merge XYZComponents
(MergeXYZComponents)

If this property is set to 1, cell arrays named (for example) X velocity, Y velocity and Z velocity will be combined into a single vector array named velocity.

1

Only the values 0 and 1 are accepted.


TIFF Reader

Read a TIFF file into an image data.

The TIFF reader reads TIFF (Tagged Image File Format) files, and the output is a uniform rectilinear (image/volume) dataset. The default file extension is .png.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the TIFF reader.


Tecplot Reader

Read files in the Tecplot ASCII file format.

The Tecplot reader extracts multiple zones (blocks) of data from a Tecplot ASCII file, in which a zone is stored in either point packing mode (i.e., tuple-based, with only point data supported) or block packing mode (i.e., component-based, with point data and cell data supported). The output of the reader is a vtkMultiBlockDataset, of which each block is either a vtkStructuredGrid or a vtkUnstructuredGrid. This supports reading a file series.

Property Description Default Value(s) Restrictions
File Names
(FileNames)

The list of files to be read by the reader.

Data Arrays
(DataArrayStatus)

This property lists what dataset attribute arrays (point data and cell data) to read.

The list of array names is provided by the reader.


VPIC Reader

Sorry, no help is currently available.


Property Description Default Value(s) Restrictions
File Name
(FileName)
Point Arrays
(PointArrayStatus)

The list of array names is provided by the reader.

Stride
(SetStride)
1 1 1

The value must be greater than or equal to 1.

X Extent
(XExtent)
-1 -1
Y Extent
(YExtent)
-1 -1
Z Extent
(ZExtent)
-1 -1


VRML Reader

Load the geometry from a VRML 2.0 file.

The VRML reader loads only the geometry from a VRML (Virtual Reality Modeling Language) 2.0 file. The expected file extension is .wrl. The output of this reader is a polygonal dataset.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the VRML reader.


Wavefront OBJ Reader

Read Wavefront .OBJ files to produce polygonal and line data.

The OBJ reader reads data stored in Wavefront .OBJ format.
The expected file extension is .obj, the datasets resulting
from reading these files are polygons and lines.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the OBJ reader.


WindBlade reader

Sorry, no help is currently available.


Property Description Default Value(s) Restrictions
File Name
(FileName)
Point Arrays
(PointArrayStatus)

The list of array names is provided by the reader.


XDMF Reader

Read XDMF (eXtensible Data Model and Format) files.

The XDMF reader reads files in XDMF format. The expected file extension
is .xmf. Metadata is stored in the XDMF file using an XML format, and
large attribute arrays are stored in a corresponding HDF5 file. The
output may be unstructured grid, structured grid, or rectiliner grid.

Property Description Default Value(s) Restrictions
Cell Arrays
(CellArrayStatus)

This property lists which the cell-centered arrays to read.

The list of array names is provided by the reader.

File Name
(FileName)

This property specifies the file name for the XDMF reader.

Grids
(GridStatus)
Point Arrays
(PointArrayStatus)

This property lists which the point-centered arrays to read.

The list of array names is provided by the reader.

Sets
(SetStatus)

Select the sets to be loaded from the dataset, if any.

The list of array names is provided by the reader.

Stride
(Stride)

If loading structured data, this property indicate the number of indices per dimension (X, Y, or Z) to skip between each point included in this output.

1 1 1

The value must be greater than or equal to (1, 1, 1).


XML Hierarchical Box Data reader

Read a VTK XML-based data file containing a hierarchical dataset containing vtkUniformGrids.

The XML Hierarchical Box Data reader reads VTK's XML-based file format
containing a vtkHierarchicalBoxDataSet. The expected file extensions is
either .vthb or .vth.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the VTK XML polygonal dataset format. The standard extension is .vtp. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.


XML Image Data Reader

Read serial VTK XML image data files.

The XML Image Data reader reads the VTK XML image data file format. The standard extension is .vti. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the VTK XML image data format. The standard extension is .vti. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


XML MultiBlock Data Reader

Read a VTK XML multi-block data file and the serial VTK XML data files to which it points.

The XML Multi-Block Data reader reads the VTK XML multi-block data file
format. XML multi-block data files are meta-files that point to a list of
serial VTK XML files. When reading in parallel, this reader will
distribute sub-blocks among processors. The expected file extensions are
.vtm and .vtmb.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the VTK XML polygonal dataset format. The standard extension is .vtp. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.


XML Partitioned Image Data Reader

Read the summary file and the associated VTK XML image data files.

The XML Partitioned Image Data reader reads the partitioned VTK image data file format. It reads the partitioned format's summary file and then the associated VTK XML image data files. The expected file extension is .pvti. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML image data format. The standard extension is .pvti. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This propert lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


XML Partitioned Polydata Reader

Read the summary file and the assicoated VTK XML polydata files.

The XML Partitioned Polydata reader reads the partitioned VTK polydata file format. It reads the partitioned format's summary file and then the associated VTK XML polydata files. The expected file extension is .pvtp. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML polygonal dataset format. The standard extension is .pvtp. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


XML Partitioned Rectilinear Grid Reader

Read the summary file and the associated VTK XML rectilinear grid data files.

The XML Partitioned Rectilinear Grid reader reads the partitioned VTK rectilinear grid file format. It reads the partitioned format's summary file and then the associated VTK XML rectilinear grid files. The expected file extension is .pvtr. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML rectilinear grid data format. The standard extension is .pvtr. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


XML Partitioned Structured Grid Reader

Read the summary file and the associated VTK XML structured grid data files.

The XML Partitioned Structured Grid reader reads the partitioned VTK structured grid data file format. It reads the partitioned format's summary file and then the associated VTK XML structured grid data files. The expected file extension is .pvts. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML structured grid data format. The standard extension is .pvts. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


XML Partitioned Unstructured Grid Reader

Read the summary file and the associated VTK XML unstructured grid data files.

The XML Partitioned Unstructured Grid reader reads the partitioned VTK unstructured grid data file format. It reads the partitioned format's summary file and then the associated VTK XML unstructured grid data files. The expected file extension is .pvtu. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the partitioned VTK XML unstructured grid data format. The standard extension is .pvtu. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


XML PolyData Reader

Read serial VTK XML polydata files.

The XML Polydata reader reads the VTK XML polydata file format. The standard extension is .vtp. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the VTK XML polygonal dataset format. The standard extension is .vtp. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


XML Rectilinear Grid Reader

Read serial VTK XML rectilinear grid data files.

The XML Rectilinear Grid reader reads the VTK XML rectilinear grid data file format. The standard extension is .vtr. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the VTK XML rectilinear grid data format. The standard extension is .vtr. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


XML Structured Grid Reader

Read serial VTK XML structured grid data files.

The XML Structured Grid reader reads the VTK XML structured grid data file format. The standard extension is .vts. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the VTK XML structured grid data format. The standard extension is .vts. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


XML Unstructured Grid Reader

Read serial VTK XML unstructured grid data files.

The XML Unstructured Grid reader reads the VTK XML unstructured grid data file format. The standard extension is .vtu. This reader also supports file series.

Property Description Default Value(s) Restrictions
File Name
(FileName)

The list of files to be read by the reader. Each file is expected to be in the VTK XML unstructured grid data format. The standard extension is .vtu. If more than 1 file is specified, the reader will switch to file series mode in which it will pretend that it can support time and provide 1 file per time step.

Cell Arrays
(CellArrayStatus)

This property lists which cell-centered arrays to read.

The list of array names is provided by the reader.

Point Arrays
(PointArrayStatus)

This property lists which point-centered arrays to read.

The list of array names is provided by the reader.


XYZ Reader

Read XYZ molecular data files into a polygonal dataset.

The XYZ reader reads XYZ molecular data files. The expected file extension is .xyz. The output of this reader is a polygonal dataset.

Property Description Default Value(s) Restrictions
File Name
(FileName)

This property specifies the file name for the XYZ reader.

Time Step
(TimeStep)

This property specifies the timestep the XYZ reader should load.

0


proSTAR (STARCD) Reader

Reads geometry in proSTAR (STARCD) file format.

ProStarReader creates an unstructured grid dataset.
It reads .cel/.vrt files stored in proSTAR (STARCD) ASCII format.

Property Description Default Value(s) Restrictions
File Name
(FileName)

Set the file name for the proSTAR (STARCD) reader.

Scale Factor
(ScaleFactor)

Scaling factor for the points

0