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

From KitwarePublic
Jump to navigationJump to search
 
(28 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==AVS UCD Reader==
==AVS UCD Reader==


 
Reads binary or ASCII files stored in AVS UCD format.The AVS UCD
Read binary or ASCII files stored in AVS UCD format.
reader reads binary or ASCII files stored in AVS UCD
 
format. The default file extension is .inp. The output of
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 an unstructured grid. This supports reading a file series.<br>
this reader is unstructured grid. This supports reading a
file series.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 12: Line 14:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Names'''<br>''(FileNames)''
|'''FileNameInfo''' (FileNameInfo)
|
|
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)''
|'''FileNames''' (FileNames)
|
The list of files to be read by the reader. If more than
one file is specified, the reader will switch to file series mode in
which it will pretend that it can support time and provide one file per
time step.
|
|
This property contains a list of the cell-centered arrays to read.


|
|
The value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
|
The list of array names is provided by the reader.




|}
==BYU Reader==
Reads 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.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| '''Property'''
|
| '''Description'''
This property contains a list of the point-centered arrays to read.
| '''Default Value(s)'''
| '''Restrictions'''


|-
|'''FileName''' (FileName)
|
|
This property specifies the file name for the BYU
reader.
|
|
The list of array names is provided by the reader.


|
The value(s) must be a filename (or filenames).


|}
|}


==CML Molecule Reader==


==BYU Reader==
A reader for Chemical Markup Language (CML)
This is a reader for Chemical Markup Language (CML) which
describes chemical information using XML.


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"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 57: Line 84:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
This property specifies the CML file
name
|
|
This property specifies the file name for the BYU reader.


|
|
|
The value(s) must be a filename (or filenames).
 
|}
|}


==CSV Reader==


==COSMO Reader==
Reads a Delimited Text values file into a 1D rectilinear grid.The CSV
 
reader reads a Delimited Text values file into a 1D
 
rectilinear grid. If the file was saved using the
Read a cosmology file into a vtkUnstructuredGrid.
CSVWriter, then the rectilinear grid's points and point
 
data can be restored as well as the cell data. Otherwise
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.<br>
all the data in the CSV file is treated as cell data. The
default file extension is .csv as well as .txt.
This can read file series as well.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 80: Line 114:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
The list of files to be read by the reader. Each file is
expected to be a csv file. If more than one file is specified, the
reader will switch to file series mode in which it will pretend that it
can support time and provide one file per time step.
|
|
The list of files to be read by the reader.


|
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''Cosmo Format'''<br>''(CosmoFormat)''
|'''FileNameInfo''' (FileNameInfo)
|
|
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)'''<br>''(Overlap)''
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
The space (in rL units) to extend processor particle ownership for ghost particles/cells. It is 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)'''<br>''(RL)''
|
The box side length is used to wrap particles around if they exceed rL (or less than 0) in any dimension.
| 100
|
The value must be greater than or equal to 0.




|}
|}


==DEM Reader==


==CSV Reader==
Reads 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
Reads comma-separated values files into a 1D rectilinear grid.
file extension is .dem. This reader produces uniform
 
rectilinear (image/volume) data output.
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.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 133: Line 159:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (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.
 
|
|
This property specifies the file name for the DEM
(Digital Elevation Map) reader.
|
|
|-
| '''Detect Numeric Columns'''<br>''(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.
The value(s) must be a filename (or filenames).


|}


|-
==DICOM Reader (Single File)==
| '''Field Delimiter Characters'''<br>''(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.


| ,
Reads DICOM regular rectilinear grid data from a lone file.
|
DICOM is a file format often used in medical imaging. This version
|-
of the reader reads a single file (as opposed to a collection of
| '''Have Headers'''<br>''(HaveHeaders)''
files). The DICOM reader currently only supports uncompressed
|
files.
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.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Merge Consecutive Delimiters'''<br>''(MergeConsecutiveDelimiters)''
|'''FileName''' (FileName)
|
|
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
DICOM file to load. This version of the reader only supports
|
loading one file at a time.
Only the values 0 and 1 are accepted.


|-
| '''Use String Delimiter'''<br>''(UseStringDelimiter)''
|
|
This property indicates whether to use the string delimiter.


| 1
|
|
Only the values 0 and 1 are accepted.
The value(s) must be a filename (or filenames).
 


|}
|}


==DICOM Reader (directory)==


==DEM Reader==
Reads DICOM regular rectilinear grid data from a directory containing a file.
DICOM is a file format often used in medical imaging. This version
of the reader will look at all files in the same directory of the
selected file and load them as planes of the same data set. It is
typically for 3D medical scanners to store planes as set of files
in a directory.


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.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 212: Line 218:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
|
This property specifies the file name for the DEM (Digital Elevation Map) reader.
 
A file in the directory of files to be loaded. The DICOM reader
will actually load all valid DICOM files in the same directory as
this file as part of the same dataset. This is typical of how
DICOM files are often stored.


|
|
|
|
The value(s) must be a filename (or filenames).
|}
|}


==ENZO AMR Particles Reader==


==EnSight Master Server Reader==
Reads AMR particles from an ENZO datasetThe
Enzo particles reader loads particle simulation data
stored in Enzo HDF5 format. The output of this reader is
MultiBlock dataset where each block is a vtkPolyData that
holds the particles (points) and corresponding particle
data.


 
{| class="PropertiesTable" border="1" cellpadding="5"
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.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
Line 235: Line 250:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Byte Order'''<br>''(ByteOrder)''
|'''FileNameInfo''' (FileNameInfo)
|
|
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'''<br>''(CaseFileName)''
|'''FileNames''' (FileNames)
|
The list of files to be read by the
reader.
|
|
This property specifies the name of the .sos file for the EnSight Master Server reader.


|
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|'''TimestepValues''' (TimestepValues)
|
This property lists which cell-centered arrays to read.
 
|
|
|
The list of array names is provided by the reader.
Available timestep values.
 
 
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
|
|
This property lists which point-centered arrays to read.


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




|-
| '''Set Time Value'''<br>''(SetTimeValue)''
|
This property indicates which time value to read.
| 0
|
|}
|}


==EnSight Master Server Reader==


==EnSight Reader==
Reads 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
Read EnSight 6 and Gold files.
multiple .case files. The output is a multi-block
 
dataset.
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 295: Line 293:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Case File Name'''<br>''(CaseFileName)''
|'''CaseFileName''' (CaseFileName)
|
This property specifies the name of the .sos file for
the EnSight Master Server reader.
|
|
This property specifies the case file name for the EnSight reader.


|
|
The value(s) must be a filename (or filenames).
|-
|'''ByteOrder''' (ByteOrder)
|
|
This property indicates the byte order of the binary
file(s).
|
0
|
The value(s) is an enumeration of the following:
* BigEndian (0)
* LittleEndian (1)
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
This property lists which cell-centered arrays to read.


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


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


|-
|'''CellArrayInfo''' (CellArrayInfo)
|


|}
|


|


==Enzo Reader==
|-
|'''Cell Arrays''' (CellArrayStatus)
|
This property lists which cell-centered arrays to
read.
|


 
|
Read multi-block dataset from an Enzo file.
The list of array names is provided by the reader.
 
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"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Block Output Type'''<br>''(BlockOutputType)''
|'''PointArrayInfo''' (PointArrayInfo)
|
|
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'''<br>''(FileName)''
|
|
This property specifies the file name for the Enzo reader.


|
|
|-
|-
| '''Load Particles'''<br>''(LoadParticles)''
|'''Point Arrays''' (PointArrayStatus)
|
|
Load particles when on.
This property lists which point-centered arrays to
 
read.
| 1
|
|
Only the values 0 and 1 are accepted.


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


| 100
|
|}
|}


==EnSight Reader==


==ExodusIIReader==
Reads 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
Read an Exodus II file to produce an unstructured grid.
default extension is .case. The output of this reader is a
 
multi-block dataset.
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. The file format is described fully at: http://endo.sandia.gov/SEACAS/Documentation/exodusII.pdf.<br><br>
Each Exodus file contains a single set of points with 2D or 3D coordinates plus one or more blocks, sets, and maps. Block group elements (or their bounding edges or faces) of the same type together. Sets select subsets (across all the blocks in a file) of elements, sides of elements (which may be of mixed dimensionality), bounding faces of volumetric elements, or bounding edges of volumetric or areal elements. Each block or set may have multiple result variables, each of which defines a value per element, per timestep.<br><br>
The elements (cells), faces of elements (when enumerated in face blocks), edges of elements (when enumerated in edge blocks), and nodes (points) in a file may be assigned an arbitrary integer number by an element map, face map, edge map, or node map, respectively. Usually, only a single map of each type exists and is employed to assign a unique global ID to entities across multiple files which partition a large mesh for a distributed-memory calculation. However here may be multiply maps of each type and there are no constraints which force the integers to be unique.<br><br>
The connectivity of elements is constant across all of the timesteps in any single Exodus II file. However, multiple files which specify a single time-evolution of a mesh may be used to represent meshes which exhibit changes in connectivity infrequently.<br><br>


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


|
|
The value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
|
|-
Available timestep values.
| '''Use Meta File'''<br>''(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'''<br>''(AnimateVibrations)''
|'''CellArrayInfo''' (CellArrayInfo)
|
|
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'''<br>''(ApplyDisplacements)''
|'''Cell Arrays''' (CellArrayStatus)
|
This property lists which cell-centered arrays 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
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.
|-
|'''PointArrayInfo''' (PointArrayInfo)
|


|


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


| 1
|-
|'''Point Arrays''' (PointArrayStatus)
|
|
|-
This property lists which point-centered arrays to
| '''Edge Blocks'''<br>''(EdgeBlocks)''
read.
|
|
Use this property to select which blocks of edges should be loaded.
All edges in the same block will have the same interpolant (linear, quadratic, etc.)
and have the same variables defined over them.


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


|}
==Enzo Reader==
Read hierarchical box dataset from an Enzo file.
This Enzo reader loads data stored in Enzo format. The
output of this reader is a hierarchical-box
dataset.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Edge Map Array Status'''<br>''(EdgeMapArrayStatus)''
|'''FileNameInfo''' (FileNameInfo)
|
|
Specify which maps defined over edges in the mesh should be loaded.
An edge map is a renumbering of all the edges (across all the edge blocks of a file) from their offset in the file
to some arbitrary integers, usually specifying a unique global ID across a set of files.


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


|-
|'''FileNames''' (FileNames)
|
The list of files to be read by the
reader.
|


|
The value(s) must be a filename (or filenames).
|-
|-
| '''Edge Set Array Status'''<br>''(EdgeSetArrayStatus)''
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
An Exodus II file may define subsets of all the edges (across all edge blocks) in a file as sets in their own right.
This property specifies which of those sets should be loaded.
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per edge.
The accompanying EdgeSetResultArrayStatus property specifies which variables defined over those sets should be loaded.


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




|}
==ExodusIIReader==
Reads 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. The
file format is described fully at:
http://endo.sandia.gov/SEACAS/Documentation/exodusII.pdf.
Each Exodus file contains a single set of points with 2-D
or 3-D coordinates plus one or more blocks, sets, and
maps. Block group elements (or their bounding edges or
faces) of the same type together. Sets select subsets
(across all the blocks in a file) of elements, sides of
elements (which may be of mixed dimensionality), bounding
faces of volumetric elements, or bounding edges of
volumetric or areal elements. Each block or set may have
multiple result variables, each of which defines a value
per element, per timestep. The elements (cells), faces of
elements (when enumerated in face blocks), edges of
elements (when enumerated in edge blocks), and nodes
(points) in a file may be assigned an arbitrary integer
number by an element map, face map, edge map, or node map,
respectively. Usually, only a single map of each type
exists and is employed to assign a unique global ID to
entities across multiple files which partition a large
mesh for a distributed-memory calculation. However here
may be multiply maps of each type and there are no
constraints which force the integers to be unique. The
connectivity of elements is constant across all of the
timesteps in any single Exodus II file. However, multiple
files which specify a single time-evolution of a mesh may
be used to represent meshes which exhibit changes in
connectivity infrequently. Field variable mode_shape[0]
represents the time step (t_index) if HasModeShapes is
not set or the ModeShape otherwise.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Edge Set Result Array Status'''<br>''(EdgeSetResultArrayStatus)''
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''FileNameInfo''' (FileNameInfo)
|
|
An Exodus II file may define subsets of all the edges (across all edge blocks) in a file as sets in their own right.
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per edge.
This property specifies which of those variables should be loaded.
The corresponding set must also be loaded using the EdgeSetArrayStatus property in order for the variable to appear.


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


|-
|-
| '''Edge Variables'''<br>''(EdgeVariables)''
|'''FileName''' (FileName)
|
This property specifies the file name for the Exodus
reader.
|
|
Use this property to select which variables defined over edges should be loaded.
Edges are oriented boundaries of one or more higher-dimensional cells also present in the mesh.
Edge variables specify a single value per entry in some edge block.


|
|
|
The value(s) must be a filename (or filenames).
The list of array names is provided by the reader.
 
 
|-
|-
| '''Element Blocks'''<br>''(ElementBlocks)''
|'''UseMetaFile''' (UseMetaFile)
|
|
Use this property to select which blocks of elements (cells) should be loaded.
This hidden property must always be set to 1 for this
All elements (cells) in the same block will have the same interpolant (tetrahedral, triangular, trilinear hexahedral, etc.)
proxy to work.
and have the same variables defined over them.
 
|
|
0
|
|
Accepts boolean values (0 or 1).
|-
|-
| '''Element Map Array Status'''<br>''(ElementMapArrayStatus)''
|'''TimestepValues''' (TimestepValues)
|
|
Specify which maps defined over elements (cells) in the mesh should be loaded.
An element map is a renumbering of all the elements (across all the element blocks of a file) from their offset in the file
to some arbitrary integers, usually specifying a unique global ID across a set of files.
These are sometimes called new-style maps because they are specified differently
than in older Exodus files, which only allowed a single element map.


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




|-
|}
| '''Element Set Array Status'''<br>''(ElementSetArrayStatus)''
|
An Exodus II file may define subsets of all the elements (across all element blocks) in a file as sets in their own right.
This property specifies which of those sets should be loaded.
Variables, such as feature classifiers, may then be defined over these sets by specifying a single number per element.
The accompanying ElementSetResultArrayStatus property specifies which variables defined over those sets should be loaded.


|
==FLASH AMR Particles Reader==
|
The list of array names is provided by the reader.


Reads AMR particles from FLASH datasetThe
Flash particles reader loads particle simulation data
stored in Flash format. The output of this reader is a
MultiBlock dataset where each block is vtkPolyData that
holds the particles and corresponding particle
data.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Element Set Result Array Status'''<br>''(ElementSetResultArrayStatus)''
| '''Property'''
|
| '''Description'''
An Exodus II file may define subsets of all the elements (across all element blocks) in a file as sets in their own right.
| '''Default Value(s)'''
Variables, such as feature classifiers, may then be defined over these sets by specifying a single number per element.
| '''Restrictions'''
This property specifies which of those variables should be loaded.
The corresponding set must also be loaded using the ElementSetArrayStatus property in order for the variable to appear.


|-
|'''FileNameInfo''' (FileNameInfo)
|
|
|
The list of array names is provided by the reader.


|-
| '''Element Variables'''<br>''(ElementVariables)''
|
|
Use this property to select which variables defined over elements (cells) should be loaded.
Element variables specify a single value per entry in some element block.


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


|-
|-
| '''Exodus Model Metadata'''<br>''(ExodusModelMetadata)''
|'''FileNames''' (FileNames)
|
The list of files to be read by the
reader.
|
|
Should metadata for the mesh be stored in the field data of the reader's output?


| 0
|
|
Only the values 0 and 1 are accepted.
The value(s) must be a filename (or filenames).
 
 
|-
|-
| '''Face Blocks'''<br>''(FaceBlocks)''
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
Use this property to select which blocks of faces should be loaded.
All faces in the same block will have the same interpolant (triangular, bilinear quadrilateral, etc.)
and have the same variables defined over them.


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




|-
|}
| '''Face Map Array Status'''<br>''(FaceMapArrayStatus)''
|
Specify which maps defined over faces in the mesh should be loaded.
A face map is a renumbering of all the faces (across all the face blocks of a file) from their offset in the file
to some arbitrary integers, usually specifying a unique global ID across a set of files.


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


Reads ASCII files stored in Facet format.The Facet
Reader reads files in Facet format: a simple ASCII file
format listing point coordinates and connectivity between
these points. The default file extension is .facet. The
output of the Facet Reader is polygonal.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Face Set Array Status'''<br>''(FaceSetArrayStatus)''
| '''Property'''
|
| '''Description'''
An Exodus II file may define subsets of all the faces (across all face blocks) in a file as sets in their own right.
| '''Default Value(s)'''
This property specifies which of those sets should be loaded.
| '''Restrictions'''
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per face.
The accompanying FaceSetResultArrayStatus property specifies which variables defined over those sets should be loaded.


|-
|'''FileName''' (FileName)
|
|
This property specifies the file name for the Facet
reader.
|
|
The list of array names is provided by the reader.


|-
| '''Face Set Result Array Status'''<br>''(FaceSetResultArrayStatus)''
|
|
An Exodus II file may define subsets of all the faces (across all face blocks) in a file as sets in their own right.
The value(s) must be a filename (or filenames).
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per face.
This property specifies which of those variables should be loaded.
The corresponding set must also be loaded using the FaceSetArrayStatus property in order for the variable to appear.


|
|}
|
 
The list of array names is provided by the reader.
==Flash Reader==
 
Read hierarchical box dataset from a Flash dataset.
This Flash reader loads data stored in Enzo format. The
output of this reader is a hierarchical-box
dataset.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Face Variables'''<br>''(FaceVariables)''
|'''FileNameInfo''' (FileNameInfo)
|
|
Use this property to select which variables defined over faces should be loaded.
Faces are oriented boundaries of one or more higher-dimensional cells also present in the mesh.
Face variables specify a single value per entry in some face block.


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


|-
|-
| '''File Pattern'''<br>''(FilePattern)''
|'''FileNames''' (FileNames)
|
|
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 files to be read by the
 
reader.
|
|
|
|-
| '''File Prefix'''<br>''(FilePrefix)''
|
This property specifies the file root used with the file pattern to format a file name. (See the File Pattern property.)


|
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''File Range'''<br>''(FileRange)''
|'''TimestepValues''' (TimestepValues)
|
|
This property controls the indices of the first and last files to be read.
Available timestep values.
 
| -1 -1
|
|
|-
| '''Generate Global Element Id Array'''<br>''(GenerateGlobalElementIdArray)''
|
Should the reader retrieve the first new-style element map, or if that is not present,
the solitary old-style element map (which always exists but may be procedurally generated
if it is not stored with the file)?


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




|-
|}
| '''Generate Global Node Id Array'''<br>''(GenerateGlobalNodeIdArray)''
|
Should the reader retrieve the first new-style node map, or if that is not present,
the solitary old-style node map (which always exists but may be procedurally generated
if it is not stored with the file)?


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


Reads a dataset in Fluent file format.
FLUENTReader creates an unstructured grid dataset. It
reads .cas and .dat files stored in FLUENT native format
(or a file series of the same.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Generate Object Id Cell Array'''<br>''(GenerateObjectIdCellArray)''
| '''Property'''
|
| '''Description'''
Specifies whether a variable named "ObjectId" should be created for each entry of each block and set being loaded
| '''Default Value(s)'''
and assigned the identifying number of the block or set, so that given a cell one can readily identify the block
| '''Restrictions'''
or set it came from.
This is useful for coloring a mesh by block ID or set ID.


| 1
|-
|'''FileName''' (FileName)
|
|
Only the values 0 and 1 are accepted.
The name of the files to load.
 
 
|-
| '''Global Variables'''<br>''(GlobalVariables)''
|
|
Use this property to select which global (i.e., per-mesh) variables should be loaded.
Global variables are stored as arrays in the field data of the reader's output.


|
|
|
The value(s) must be a filename (or filenames).
The list of array names is provided by the reader.


|}


|-
==Gaussian Cube Reader==
| '''Has Mode Shapes'''<br>''(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
Produce polygonal data by reading a Gaussian Cube file.The Gaussian
|
Cube reader produces polygonal data by reading data files
Only the values 0 and 1 are accepted.
produced by the Gaussian software package. The expected
file extension is .cube.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Mode Shape'''<br>''(ModeShape)''
|'''FileName''' (FileName)
|
This property specifies the file name for the Gaussian
Cube reader.
|
|
Specify which mode shape to animate when HasModeShapes is on.


| 1
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''Node Map Array Status'''<br>''(NodeMapArrayStatus)''
|'''HBScale''' (HBScale)
|
|
Specify which maps defined over nodes (points) in the mesh should be loaded.
A scaling factor to compute bonds with hydrogen
A node map is a renumbering of all the points in a file from their offset in the file
atoms.
to some arbitrary integers, usually specifying a unique global ID across a set of files.
These are sometimes called new-style maps because they are specified differently
than in older Exodus files, which only allowed a single node map.
 
|
|
1.0
|
|
The list of array names is provided by the reader.


|-
|-
| '''Node Set Array Status'''<br>''(NodeSetArrayStatus)''
|'''BScale''' (BScale)
|
|
An Exodus II file may define subsets of all the nodes (points) in a file as sets in their own right.
A scaling factor to compute bonds between non-hydrogen
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per node.
atoms
This property specifies which of those sets should be loaded.
The accompanying NodeSetResultArrayStatus property specifies which variables defined over those sets should be loaded.
 
|
|
1.0
|
|
The list of array names is provided by the reader.




|}
==Image Reader==
Reads 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.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Node Set Result Array Status'''<br>''(NodeSetResultArrayStatus)''
| '''Property'''
|
| '''Description'''
An Exodus II file may define subsets of all the nodes (points) in a file as sets in their own right.
| '''Default Value(s)'''
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per node.
| '''Restrictions'''
This property specifies which of those variables should be loaded.
The corresponding set must also be loaded using the NodeSetArrayStatus property in order for the variable to appear.


|-
|'''FilePrefix''' (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.
|
|
The list of array names is provided by the reader.


|
The value(s) must be a filename (or filenames).
|-
|-
| '''Point Variables'''<br>''(PointVariables)''
|'''FilePattern''' (FilePattern)
|
|
Use this property to select which nodal (i.e., per-point) variables should be loaded.
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
|
|
The list of array names is provided by the reader.


|-
|-
| '''Side Set Array Status'''<br>''(SideSetArrayStatus)''
|'''DataScalarType''' (DataScalarType)
|
|
An Exodus II file may define subsets of all the of all the elements in a file as sets in their own right.
The value of this property indicates the scalar type of
This property specifies which of those sets should be loaded.
the pixels/voxels in the file(s): short, int, float ...
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per side.
For example, a hexahedron has 18 sides: 6 faces and 12 edges.
Any of these sides may be individually called out in a set and assigned a result value.
The accompanying SideSetResultArrayStatus property specifies which variables defined over those sets should be loaded.
 
|
|
4
|
|
The list of array names is provided by the reader.
The value(s) is an enumeration 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)
|-
|-
| '''Side Set Result Array Status'''<br>''(SideSetResultArrayStatus)''
|'''DataByteOrder''' (DataByteOrder)
|
|
An Exodus II file may define subsets of all the of all the elements in a file as sets in their own right.
This property indicates the byte order of the binary
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per side.
file(s).
For example, a hexahedron has 18 sides: 6 faces and 12 edges.
Any of these sides may be individually called out in a set and assigned a result value.
This property specifies which of those variables should be loaded.
The corresponding set must also be loaded using the SideSetArrayStatus property in order for the variable to appear.
 
|
|
0
|
|
The list of array names is provided by the reader.
The value(s) is an enumeration of the following:
 
* BigEndian (0)
 
* LittleEndian (1)
|-
|-
| '''XML File Name'''<br>''(XMLFileName)''
|'''FileDimensionality''' (FileDimensionality)
|
|
This property specifies the name of an XML file containing part and material descriptions and a mapping to element blocks.
This property indicates whether the file(s) in this
 
dataset contain slices (2D) or volumes (3D).
|
|
3
|
The value(s) is an enumeration of the following:
* 2 (2)
* 3 (3)
|-
|'''DataOrigin''' (DataOrigin)
|
The coordinate contained in this property specifies the
position of the point with index (0,0,0).
|
0.0 0.0 0.0
|
|-
|'''DataSpacing''' (DataSpacing)
|
This property specifies the size of a voxel in each
dimension.
|
1.0 1.0 1.0
|
|
|}


|-
|'''DataExtent''' (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
|


==FLUENTReader==
|-
|'''NumberOfScalarComponents''' (NumberOfScalarComponents)
|
This property specifies the number of components the
scalar value at each pixel or voxel has (e.g., RGB - 3 scalar
components).
|
1
|


|-
|'''ScalarArrayName''' (ScalarArrayName)
|
This property contains a text string listing a name to
assign to the point-centered data array read.
|
ImageFile
|


Reads a dataset in Fluent file format.
|-
|'''FileLowerLeft''' (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
|
Accepts boolean values (0 or 1).
 
|}
 
==JPEG Series Reader==


FLUENTReader creates an unstructured grid dataset. It reads .cas and .dat files stored in FLUENT native format.<br>
Reads a series of JPEG files into an time sequence of image datas.The JPEG series
reader reads JPEG files. The output is a time sequence of
uniform rectilinear (image/volume) dataset. The default
file extension is .jpg or .jpeg.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 827: Line 895:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|'''FileNames''' (FileNames)
|
The list of files to be read by the reader. If more than
one file is specified, the reader will switch to file series mode in
which it will pretend that it can support time and provide one file per
time step.
|
|
Select which cell-centered arrays to read.


|
|
The value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
The list of array names is provided by the reader.


|


|-
|-
| '''File Name'''<br>''(FileName)''
|'''ReadAsImageStack''' (ReadAsImageStack)
|
|
Set the file name for the FLUENT reader.
 
When set, the reader will read the set of files as an image stack, rather than
a temporal file series.


|
|
1
|
|
Accepts boolean values (0 or 1).
|}
|}


==LSDynaReader==


==Facet Reader==
Read LS-Dyna databases (d3plot).This reader
 
reads LS-Dyna databases.
 
Read ASCII files stored in Facet format.
 
The Facet Reader reads files in Facet format: a simple ASCII file format listing point coordinates and connectivity between these points. The default file extension is .facet. The output of the Facet Reader is polygonal.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 860: Line 940:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
Set the file name for the LSDyna reader.
|
|
This property specifies the file name for the Facet reader.


|
|
The value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
|
|}


|


==Flash Reader==
|


|-
|'''SolidArrayInfo''' (SolidArrayInfo)
|


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'''
|'''Solid Arrays''' (SolidArrayStatus)
| '''Description'''
|
| '''Default Value(s)'''
Select which solid arrays to read.
| '''Restrictions'''
|
 
|
The list of array names is provided by the reader.
|-
|-
| '''Block Output Type'''<br>''(BlockOutputType)''
|'''ThickShellArrayInfo''' (ThickShellArrayInfo)
|
|
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'''<br>''(FileName)''
|'''Thick Shell Arrays''' (ThickShellArrayStatus)
|
Select which thick shell arrays to read.
|
|
This property specifies the file name for the Flash reader.


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


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


|


|-
|-
| '''Load Particles'''<br>''(LoadParticles)''
|'''Shell Arrays''' (ShellArrayStatus)
|
Select which shell arrays to read.
|
|
Load particles when on.


| 1
|
|
Only the values 0 and 1 are accepted.
The list of array names is provided by the reader.
|-
|'''RigidBodyArrayInfo''' (RigidBodyArrayInfo)
|


|


|}
|


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


==Gaussian Cube Reader==
|
 
The list of array names is provided by the reader.
|-
|'''RoadSurfaceArrayInfo''' (RoadSurfaceArrayInfo)
|


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"
|-
|-
| '''Property'''
|'''Road Surface Arrays''' (RoadSurfaceArrayStatus)
| '''Description'''
|
| '''Default Value(s)'''
Select which road surface arrays to
| '''Restrictions'''
read.
|-
| '''B Scale'''<br>''(BScale)''
|
|
A scaling factor to compute bonds between non-hydrogen atoms


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


|
|
|
|
|-
|-
| '''H BScale'''<br>''(HBScale)''
|'''Beam Arrays''' (BeamArrayStatus)
|
Select which beam arrays to read.
|
|
A scaling factor to compute bonds with hydrogen atoms.


| 1
|
|
|}
The list of array names is provided by the reader.
 
 
==Image Reader==
 
 
Reads 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'''
|'''ParticleArrayInfo''' (ParticleArrayInfo)
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Data Byte Order'''<br>''(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'''<br>''(DataExtent)''
|'''Particle Arrays''' (ParticleArrayStatus)
|
Select which particle arrays to read.
|
|
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
|
|
The list of array names is provided by the reader.
|-
|-
| '''Data Origin'''<br>''(DataOrigin)''
|'''PointArrayInfo''' (PointArrayInfo)
|
|
The coordinate contained in this property specifies the position of the point with index (0,0,0).


| 0 0 0
|
|-
| '''Data Scalar Type'''<br>''(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'''<br>''(DataSpacing)''
|'''Point Arrays''' (PointArrayStatus)
|
Select which point-centered arrays to
read.
|
|
This property specifies the size of a voxel in each dimension.


| 1 1 1
|
|
The list of array names is provided by the reader.
|-
|-
| '''File Dimensionality'''<br>''(FileDimensionality)''
|'''PartArrayInfo''' (PartArrayInfo)
|
|
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'''<br>''(FileLowerLeft)''
|'''Part Arrays''' (PartArrayStatus)
|
|
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 originate in the lower left corner. However, several 2D image file formats write the image from the upper left corner.
Select which part arrays to read.
 
| 1
|
Only the values 0 and 1 are accepted.
 
 
|-
| '''File Pattern'''<br>''(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 file names, %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
|
|
The list of array names is provided by the reader.
|-
|-
| '''File Prefix'''<br>''(FilePrefix)''
|'''DeformedMesh''' (DeformedMesh)
|
|
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.
Should the mesh be deformed over time (if the Deflection
 
node array is set to load)?
|
|
1
|
|
Accepts boolean values (0 or 1).
|-
|-
| '''Number Of Scalar Components'''<br>''(NumberOfScalarComponents)''
|'''RemoveDeletedCells''' (RemoveDeletedCells)
|
|
This property specifies the number of components the scalar value at each pixel or voxel has (e.g., RGB - 3 scalar components).
Should cells that have been deleted (failed
 
structurally, for example) be removed from the mesh?
| 1
|
|
|-
1
| '''Scalar Array Name'''<br>''(ScalarArrayName)''
|
|
This property contains a text string listing a name to assign to the point-centered data array read.
Accepts boolean values (0 or 1).


| ImageFile
|
|}
|}


==Legacy VTK Reader==


==JPEG Series Reader==
Reads 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
Reads a series of JPEG files into an time sequence of image datas.
extension is .vtk. The type of the dataset may be
 
structured grid, uniform rectilinear grid (image/volume),
The JPEG series reader reads JPEG files. The output is a time sequence of uniform rectilinear (image/volume) datasets. The default file extension is .jpg or .jpeg.<br>
non-uniform rectiinear grid, unstructured grid, or
polygonal. This reader also supports file
series.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,078: Line 1,141:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Names'''<br>''(FileNames)''
|'''FileNameInfo''' (FileNameInfo)
|
|
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.


|
|
|
|-
|'''FileNames''' (FileNames)
|
The list of files to be read by the reader. If more than
one file is specified, the reader will switch to file series mode in
which it will pretend that it can support time and provide one file per
time step.
|
|
The value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
|}


|


==LSDynaReader==


|}


Read LS-Dyna databases (d3plot).
==MFIXReader==


This reader reads LS-Dyna databases.<br>
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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,103: Line 1,189:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Beam Arrays'''<br>''(BeamArrayStatus)''
|'''FileName''' (FileName)
|
Set the file name for the MFIX reader.
|
|
Select which beam arrays to read.


|
|
The value(s) must be a filename (or filenames).
|-
|'''CellArrayInfo''' (CellArrayInfo)
|
|
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.


|-
|-
| '''File Name'''<br>''(FileName)''
|'''Cell Arrays''' (CellArrayStatus)
|
Select which cell-centered arrays to
read.
|
|
Set the file name for the LSDyna reader.


|
|
|
The list of array names is provided by the reader.
|-
|-
| '''Part Arrays'''<br>''(PartArrayStatus)''
|'''TimestepValues''' (TimestepValues)
|
|
Select which part arrays to read.


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




|-
|}
| '''Particle Arrays'''<br>''(ParticleArrayStatus)''
|
Select which particle arrays to read.


|
==MRC Series Reader==
|
The list of array names is provided by the reader.


Reads a series of MRC files into an time sequence of image datas.The MRC series
reader reads MRC files. The output is a time sequence of
uniform rectilinear (image/volume) dataset. The default
file extension is .mrc but .ali, .st and .rec are also
recognized.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Point Arrays'''<br>''(PointArrayStatus)''
| '''Property'''
|
| '''Description'''
Select which point-centered arrays to read.
| '''Default Value(s)'''
| '''Restrictions'''


|-
|'''FileNames''' (FileNames)
|
|
The list of files to be read by the reader. If more than
one file is specified, the reader will switch to file series mode in
which it will pretend that it can support time and provide one file per
time step.
|
|
The list of array names is provided by the reader.


|
The value(s) must be a filename (or filenames).
|-
|-
| '''Remove Deleted Cells'''<br>''(RemoveDeletedCells)''
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
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'''<br>''(RigidBodyArrayStatus)''
|
Select which rigid body arrays to load.


|
==Meta File Series Reader==
|
The list of array names is provided by the reader.


Reads a series of meta images.Read a series
of meta images. The file extension is .mhd


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Road Surface Arrays'''<br>''(RoadSurfaceArrayStatus)''
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''FileNameInfo''' (FileNameInfo)
|
|
Select which road surface arrays to read.


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


|-
|-
| '''Shell Arrays'''<br>''(ShellArrayStatus)''
|'''FileNames''' (FileNames)
|
The list of files to be read by the reader. Each file is
expected to be in the meta format. The standard extension is .mhd. If
more than one file is specified, the reader will switch to file series
mode in which it will pretend that it can support time and provide one
file per time step.
|
|
Select which shell arrays to read.


|
|
The value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
|
The list of array names is provided by the reader.


|}
==NetCDF CAM reader==
Reads unstructured grid data from NetCDF files. There are 2 files, a points+fields file which is set as FileName and a cell connectivity file set as ConnectivityFileName.
This reader reads in unstructured grid data from a NetCDF
file. The grid data is in a set of planes as quadrilateral
cells. The reader creates hex cells in order to create a
volumetric grid.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Solid Arrays'''<br>''(SolidArrayStatus)''
|'''FileNameInfo''' (FileNameInfo)
|
|
Select which solid arrays to read.


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


|-
|-
| '''Split by Material Id'''<br>''(SplitByMaterialId)''
|'''FileName''' (FileName)
|
The list of files to be read by the
reader.
|
|
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.
The value(s) must be a filename (or filenames).
 
 
|-
|-
| '''Thick Shell Arrays'''<br>''(ThickShellArrayStatus)''
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
Select which thick shell arrays to read.


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




|}
|}


==NetCDF MPAS reader==


==Legacy VTK Reader==
Reads unstructured grid MPAS data from a file.
 
This reader reads unstructured grid MPAS data from a file.
 
It creates a dual grid It assumes the grid is in the
Read files stored in VTK's legacy file format.
global domain. By default, it creates a spherical view of
 
vertical layer 0. It assumes it is ocean data. It gives
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.<br>
several options to change the view to multilayer (all
vertical layers will have a thickness determined by the
value in the slider), lat/lon projection or atmospheric
(vertical layers go out away from the center of the
sphere, instead of down towards the center as they do for
ocean data). It doesn't handle data in the rectangular
domain. This is not a parallel reader. It expects one .nc
file of data. It can display cell or vertex-centered data,
but not edge data. When converted to the dual grid,
cell-centered data becomes vertex-centered and vice-versa.
NOTES: When using this reader, it is important that you
remember to do the following: 1. When changing a selected
variable, remember to select it also in the drop down box
to color by. It doesn't color by that variable
automatically 2. When selecting multilayer sphere view,
start with layer thickness around 100,000 3. When
selecting multilayer lat/lon view, start with layer
thickness around 10 4. Always click the -Z orientation
after making a switch from lat/lon to sphere, from single
to multilayer or changing thickness. 5. Be conservative on
the number of changes you make before hitting Apply, since
there may be bugs in this reader. Just make one change and
then hit Apply. For problems, contact Christine Ahrens
(cahrens@lanl.gov)


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,246: Line 1,387:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Names'''<br>''(FileNames)''
|'''FileName''' (FileName)
|
This property specifies the file name to read. It should
be an MPAS format NetCDF file ending in .nc.
|
|
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.


|
|
The value(s) must be a filename (or filenames).
|-
|'''UseDimensionedArrayNames''' (UseDimensionedArrayNames)
|
This property ensures that the dimension info is always
shown in the ParaView GUI.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''PointArrayInfo''' (PointArrayInfo)
|
|
|}


|


==MFIXReader==
|


|-
|'''PointArrayStatus''' (PointArrayStatus)
|
This property lists which NetCDF dual-grid point
variables to load.
|


Reads a dataset in MFIX file format.
|
 
The list of array names is provided by the reader.
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.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|'''CellArrayInfo''' (CellArrayInfo)
|
|
Select which cell-centered arrays to read.


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


|-
|-
| '''File Name'''<br>''(FileName)''
|'''CellArrayStatus''' (CellArrayStatus)
|
This property lists which NetCDF dual-grid cell
variables to load.
|
|
Set the file name for the MFIX reader.


|
|
The list of array names is provided by the reader.
|-
|'''DimensionInfo''' (DimensionInfo)
|
|
|}


|


==Meta File Series Reader==
|


|-
|'''Extra Dimension Indices''' (DimensionCurrentIndex)
|


Read a series of meta images.
|


Read a series of meta images. The file extension is .mhd<br>
|


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
|'''ShowMultilayerView''' (ShowMultilayerView)
| '''Description'''
|
| '''Default Value(s)'''
This property indicates whether to show multiple layers
| '''Restrictions'''
in one view, with each vertical level having the same thickness,
specified by the layer thickness slider. For ocean data, the layers
correspond to data at vertical level whose number increases towards the
center of the sphere. For atmospheric data, the layers correspond to
data at vertical levels increasing away from the
center.
|
0
|
Accepts boolean values (0 or 1).
|-
|-
| '''File Names'''<br>''(FileNames)''
|'''DimensionList''' (DimensionList)
|
|
The list of files to be read by the reader. Each file is expected to be
in the meta format. The standard extension is .mhd. 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.


|
|
|
|
|}


|-
|'''Vertical Dimension''' (VerticalDimension)
|


==NetCDF MPAS reader==
|
 
nVertLevels
 
|
Read unstructured grid MPAS data from a file.
The value(s) can be one of the following:
 
This reader reads unstructured grid MPAS data from a file. It creates a dual grid and assumes the grid is in the global domain. By default, it creates a spherical view of vertical layer 0. It assumes it is ocean data. It gives several options to change the view to multilayer (all vertical layers will have a thickness determined by the value in the slider), lat/lon projection or atmospheric (vertical layers go out away from the center of the sphere, instead of down towards the center as they do for ocean data). It doesn't handle data in the rectangular domain. This is not a parallel reader. It expects one .nc file of data. It can display cell or vertex-centered data, but not edge data. When converted to the dual grid, cell-centered data becomes vertex-centered and vice-versa.<br><br>
NOTES:<br>
When using this reader, it is important that you remember to do the following:<br>
1. When changing a selected variable, remember to select it also in the drop-down box to color by. It doesn't color by that variable automatically.<br>
2. When selecting multilayer sphere view, start with layer thickness around 100,000.<br>
3. When selecting multilayer lat/lon view, start with layer thickness around 10.<br>
4. Always click the -Z orientation after making a switch from lat/lon to sphere, from single to multilayer or changing thickness.<br>
5. Be conservative on the number of changes you make before hitting Apply, since there may be bugs in this reader. Just make one change and then hit Apply.<br><br>
For problems, contact Christine Ahrens (cahrens@lanl.gov)<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
|-
| '''Cell Array Status'''<br>''(CellArrayStatus)''
|'''ProjectLatLon''' (ProjectLatLon)
|
|
This property lists which NetCDF dual-grid cell variables to load.
This property indicates whether to view the data in the
 
lat/lon projection.
|
|
0
|
|
The list of array names is provided by the reader.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Center Longitude'''<br>''(CenterLon)''
|'''IsAtmosphere''' (IsAtmosphere)
|
|
This property specifies where the center will be viewed for a lat/lon projection.
This property indicates whether data is atmospheric.
 
Checking this ensures the vertical levels will go up away from the
| 180
sphere instead of down towards the center.
|
|-
| '''File Name'''<br>''(FileName)''
|
This property specifies the file name to read. It should be an MPAS format NetCDF file ending in .nc.
 
|
|
0
|
|
Accepts boolean values (0 or 1).
|-
|-
| '''Is Atmosphere'''<br>''(IsAtmosphere)''
|'''LayerThicknessRangeInfo''' (LayerThicknessRangeInfo)
|
|
This property indicates whether data is atmospheric. Checking this ensures the vertical levels will go up away from the sphere instead of down towards the center.


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


|-
| '''Layer Thickness'''<br>''(LayerThickness)''
|
|
This property specifies how thick the layer should be if viewing the data in multilayer view. Each layer corresponds to a vertical level. A good starting point is 100,000 for the spherical view and 10 for the lat/lon projection. Click on -Z after applying this change, since the scale may change drastically.


| 10
|
|-
|-
| '''Point Array Status'''<br>''(PointArrayStatus)''
|'''Layer Thickness''' (LayerThickness)
|
|
This property lists which NetCDF dual-grid point variables to load.
This property specifies how thick the layer should be if
 
viewing the data in multilayer view. Each layer corresponds to a
vertical level. A good starting point is 100,000 for the spherical view
and 10 for the lat/lon projection. Click on -Z after applying this
change, since the scale may change drastically.
|
|
10
|
|
The list of array names is provided by the reader.


|-
|-
| '''Project Lat Lon'''<br>''(ProjectLatLon)''
|'''CenterLonRangeInfo''' (CenterLonRangeInfo)
|
|
This property indicates whether to view the data in the lat/lon projection.


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


|


|-
|-
| '''Show Multilayer View'''<br>''(ShowMultilayerView)''
|'''Center Longitude''' (CenterLon)
|
|
This property indicates whether to show multiple layers in one view, with each vertical level having the same thickness, specified by the layer thickness slider. For ocean data, the layers correspond to data at vertical level whose number increases towards the center of the sphere. For atmospheric data, the layers correspond to data at vertical levels increasing away from the center.
This property specifies where the center will be viewed
 
for a lat/lon projection.
| 0
|
180
|
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Vertical Level'''<br>''(VerticalLevel)''
|'''TimestepValues''' (TimestepValues)
|
|
This property specifies which vertical level is viewed if not in multilayer view. Only the data for that vertical level will be viewed. The grid is essentially the same for each vertical level, however at some ocean levels, especially the lower ones, due to the topography, the grid becomes more sparse where there is land.


| 0
|
|
|}


|


==NetCDF POP reader==


|}


Read raw, regular, rectilinear grid data from a file. The dimensions and type of the data must be specified.
==NetCDF POP reader==


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>
Reads rectilinear grid data from a NetCDF POP file.
The reader reads regular rectilinear grid (image/volume) data from a
NetCDF file.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,430: Line 1,565:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileNameInfo''' (FileNameInfo)
|
|
This property specifies the file name to read.


|
|
|
|
|-
|-
| '''Stride'''<br>''(Stride)''
|'''FileName''' (FileName)
|
The list of files to be read by the
reader.
|
|
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).
The value(s) must be a filename (or filenames).
 
 
|-
|-
| '''Variables'''<br>''(VariableArrayStatus)''
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
This property lists which netCDF variables to load.


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


|}
|}


==NetCDF Reader==
==NetCDF Reader==


 
Reads regular arrays from netCDF files. Will also read any topological information specified by the COARDS and CF conventions.Reads
Read regular arrays from netCDF files. Will also read any topological information specified by the COARDS and CF conventions.
arrays from netCDF files into structured VTK data sets. In
 
the absence of any other information, the files will be
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.<br>
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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,473: Line 1,615:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
|
The name of the files to load.
The name of the files to load.
|


|
|
The value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
|
|-
This magic property sends time information to the
| '''Dimensions'''<br>''(Dimensions)''
animation panel. ParaView will then automatically set up the animation
to visit the time steps defined in the file.
|
|
Load the grid with the given dimensions. Any arrays that conform to these dimensions will be loaded.


|
|
|
.




|-
|}
| '''Output Type'''<br>''(OutputType)''
|
Specifies the type of data that the reader creates. If Automatic, the reader will use the most appropriate grid type for
the data read. Note that not all grid types support all data. A warning is issued if a mismatch occurs.


| -1
==Nrrd Reader==
|
The value must be one of the following: Automatic (-1), Image (6), Rectilinear (3), Structured (2), Unstructured (4).


Reads 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.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Replace Fill Value With Nan'''<br>''(ReplaceFillValueWithNan)''
| '''Property'''
|
| '''Description'''
If on, any float or double variable read that has a _FillValue attribute will have that fill value replaced with a not-a-number
| '''Default Value(s)'''
(NaN) value. The advantage of setting these to NaN values is that, if implemented properly by the system and careful math
| '''Restrictions'''
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
|-
|'''FileName''' (FileName)
|
|
Only the values 0 and 1 are accepted.
The name of the file to read (or the meta data file that
 
will point to the actual file).
 
|-
| '''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
|
|
Only the values 0 and 1 are accepted.
The value(s) must be a filename (or filenames).
 
 
|-
|-
| '''Vertical Bias'''<br>''(VerticalBias)''
|'''Data VOI''' (DataVOI)
|
|
The bias of the vertical component of spherical coordinates. It is common to write the vertical component with respect to
The data volume of interest (VOI). The VOI is a
something other than the center of the sphere (for example, the surface). In this case, it might be necessary to scale and/or
sub-extent of the data that you want loaded. Setting a VOI is useful
bias the vertical height. The height will become height*scale + bias. Keep in mind that if the positive attribute of the
when reading from a large data set and you are only interested in a
vertical dimension is down, then the height is negated. The scaling will be adjusted if it results in invalid (negative)
small portion of the data. If left containing all 0's, then the reader
vertical values.
will load in the entire data set.
 
| 0
|
|
|-
0 0 0 0 0 0
| '''Vertical Scale'''<br>''(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
 
|
|}
|}


==OpenFOAMReader==


==Nrrd Reader==
Reads OpenFOAM data files, producing multi-block dataset.The OpenFOAM reader
 
reads OpenFOAM data files and outputs multi-block
 
datasets. Mesh information and time dependent data are
Read raw image files with Nrrd meta data.
supported. The OpenFOAM format is described fully at
 
http://www.openfoam.com/docs/user/basic-file-format.php
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.<br>
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.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,564: Line 1,695:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Data VOI'''<br>''(DataVOI)''
|'''FileName''' (FileName)
|
This property specifies the file name for the
reader.
|
|
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
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''File Name'''<br>''(FileName)''
|'''CaseType''' (CaseType)
|
|
The name of the file to read (or the meta data file that will
The property indicates whether decomposed mesh or
point to the actual file).
reconstructed mesh should be read
 
|
|
1
|
|
|}
The value(s) is an enumeration of the following:
 
* Decomposed Case (0)
 
* Reconstructed Case (1)
==OpenFOAMReader==
|-
 
|'''Create cell-to-point filtered data''' (CreateCellToPoint)
 
|
Read OpenFOAM data files, producing multi-block dataset.
Create point data from cell data. Beware: the filter
 
does not do inverse distance weighting.
The OpenFOAM reader reads OpenFOAM data files and outputs multi-block datasets. Mesh information and time dependent data are supported.<br>
|
The OpenFOAM format is described fully at: http://www.openfoam.com/docs/user/basic-file-format.php<br>
1
 
|
{| class="PropertiesTable" border="1" cellpadding="5"
Accepts boolean values (0 or 1).
|-
|-
| '''Property'''
|'''Add dimensional units to array names''' (AddDimensionsToArrayNames)
| '''Description'''
|
| '''Default Value(s)'''
Read dimensional units from field data and add them to
| '''Restrictions'''
array names as human-readable string.
|
0
|
Accepts boolean values (0 or 1).
|-
|-
| '''Add dimensional units to array names'''<br>''(AddDimensionsToArrayNames)''
|'''TimestepValues''' (TimestepValues)
|
|
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'''<br>''(CacheMesh)''
|'''PatchArrayInfo''' (PatchArrayInfo)
|
|
Cache the OpenFOAM mesh between GUI selection changes.


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


|


|-
|-
| '''Case Type'''<br>''(CaseType)''
|'''MeshRegions''' (MeshRegions)
|
|
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'''<br>''(CellArrays)''
|
|
|
|
The list of array names is provided by the reader.
The list of array names is provided by the reader.
|-
|-
| '''Create cell-to-point filtered data'''<br>''(CreateCellToPoint)''
|'''CellArrayInfo''' (CellArrayInfo)
|
|
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'''<br>''(DecomposePolyhedra)''
|'''CellArrays''' (CellArrays)
|
|
Decompose polyhedra into tetrahedra and pyramids.


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


|
The list of array names is provided by the reader.
|-
|-
| '''File Name'''<br>''(FileName)''
|'''PointArrayInfo''' (PointArrayInfo)
|
|
This property specifies the file name for the reader.


|
|
|
|
|-
|-
| '''Lagrangian Arrays'''<br>''(LagrangianArrays)''
|'''PointArrays''' (PointArrays)
|
|
|
|
|
|
The list of array names is provided by the reader.
The list of array names is provided by the reader.
|-
|-
| '''List timesteps according to controlDict'''<br>''(ListTimeStepsByControlDict)''
|'''LagrangianArrayInfo''' (LagrangianArrayInfo)
|
|
List time directories listed according to the settings in controlDict.


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


|


|-
|-
| '''Mesh Regions'''<br>''(MeshRegions)''
|'''LagrangianArrays''' (LagrangianArrays)
|
|
|
|
|
|
The list of array names is provided by the reader.
The list of array names is provided by the reader.
|-
|-
| '''Point Arrays'''<br>''(PointArrays)''
|'''Cache mesh''' (CacheMesh)
|
|
Cache the OpenFOAM mesh between GUI selection
changes.
|
|
1
|
|
The list of array names is provided by the reader.
Accepts boolean values (0 or 1).
 
|-
 
|'''Decompose polyhedra''' (DecomposePolyhedra)
|
Decompose polyhedra into tetrahedra and
pyramids.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''List timesteps according to controlDict''' (ListTimeStepsByControlDict)
|
List time directories listed according to the settings
in controlDict.
|
0
|
Accepts boolean values (0 or 1).
|-
|-
| '''Lagrangian positions are in OF 1.3 binary format'''<br>''(PositionsIsIn13Format)''
|'''Lagrangian positions are in OF 1.3 binary format''' (PositionsIsIn13Format)
|
Set if Lagrangian positions files are in OpenFOAM 1.3
binary format.
|
|
Set if Lagrangian positions files are in OpenFOAM 1.3 binary format.
0
 
| 0
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Read zones'''<br>''(ReadZones)''
|'''Read zones''' (ReadZones)
|
|
Read point/face/cell-Zones?
Read point/face/cell-Zones?
| 0
|
|
Only the values 0 and 1 are accepted.
0
 
|
Accepts boolean values (0 or 1).


|}
|}


==PDB Reader==
==PDB Reader==


 
Reads PDB molecule files.The PDB reader reads files in
Read PDB molecule files.
the format used by the Protein Data Bank (an archive of
 
experimentally determined three-dimensional structures of
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>
biological macromolecules). The expected file extension is
.pdb. The output datasets are polygonal.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,733: Line 1,867:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
This property specifies the file name for the PDB
reader.
|
|
This property specifies the file name for the PDB reader.


|
|
|
The value(s) must be a filename (or filenames).
 
|}
|}


==PLOT3D Meta-File Reader==


==PLOT3D Reader==
The main goal of this reader is to make it easy to read PLOT3D files or time series of PLOT3D files.
 
The main goal of this reader is to make it easy to read PLOT3D files,
 
specifically time series of PLOT3D files. PLOT3D files can take many
Read ASCII or binary PLOT3D files.
different forms based on their content. Unfortunately, it is not a
self-describing format therefore the user needs to pass information
about the contents of the file to the reader. Normally, this is done
by setting a number of member variables. The goal of this reader is to
provide a simple format that enable the writer of the PLOT3D file to
describe its settings as well as group a number of files as a time
series.


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"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,756: Line 1,900:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Q File Name'''<br>''(QFileName)''
|'''FileName''' (FileName)
|
This property specifies the meta file
name
|
|
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 value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
|
|-
Available timestep values.
| '''Binary File'''<br>''(BinaryFile)''
|
|
This property indicates whether the data files are binary.


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




|-
|}
| '''Byte Order'''<br>''(ByteOrder)''
|
This property specifies the byte order of any binary file(s).


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


Reads 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.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''File Name'''<br>''(FileName)''
| '''Property'''
|
| '''Description'''
This property specifies the .xyz (geometry) file name for the PLOT3D reader.
| '''Default Value(s)'''
| '''Restrictions'''


|-
|'''QFileName''' (QFileName)
|
|
The list of .q (solution) files for the PLOT3D reader.
There can be more than one. If more that one file is specified, the
reader will switch to file-series mode in which it will pretend that it
can support time and provide one file per time step.
|
|
|-
| '''Force Read'''<br>''(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'''<br>''(Functions)''
|
|
This property lists which functions (point-centered arrays) to compute.
The value(s) must be a filename (or filenames).
 
|
|
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'''<br>''(HasByteCount)''
|'''FileNameInfo''' (FileNameInfo)
|
This property indicates whether this file uses Fortran leading-trailing byte counts.
 
| 0
|
|
Only the values 0 and 1 are accepted.


|-
| '''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)''
|'''TimestepValues''' (TimestepValues)
|
|
This property indicates whether these files have multiple-block information.
Available timestep values.
 
| 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.




|}
|}


==PLY Reader==
==PLY Reader==


 
Reads files stored in Stanford University's PLY polygonal file format.The PLY reader
Read files stored in Stanford University's PLY polygonal file format.
reads files stored in the PLY polygonal file format
 
developed at Stanford University. The PLY files that
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>
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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,869: Line 1,985:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
This property specifies the file name for the PLY
reader.
|
|
This property specifies the file name for the PLY reader.


|
|
|
The value(s) must be a filename (or filenames).
 
|}
|}


==PNG Series Reader==
==PNG Series Reader==


 
Reads a PNG file into an image data.The PNG reader reads PNG
Read a PNG file into an image data.
(Portable Network Graphics) files, and the output is a
 
uniform rectilinear (image/volume) dataset. The default
The PNG reader reads PNG (Portable Network Graphics) files, and the output is a uniform rectilinear (image/volume) dataset. The default file extension is .png.<br>
file extension is .png.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,892: Line 2,011:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Names'''<br>''(FileNames)''
|'''FileNames''' (FileNames)
|
The list of files to be read by the reader. If more than
one file is specified, the reader will switch to file series mode in
which it will pretend that it can support time and provide one 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.


|
|
The value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
|
|}


|-
|'''ReadAsImageStack''' (ReadAsImageStack)
|


==POP Reader==
When set, the reader will read the set of files as an image stack, rather than
a temporal file series.


|
1
|
Accepts boolean values (0 or 1).


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.<br>
==PTS Reader==
 
Reads a PTS ASCII Point Cloud file.The PTS reader
reads ASCII PTS Point Cloud files containing
points as well as optional intensity and color information. The default
file extension is .pts. This reader produces a
polydata set of a single vertex cell containing all of
the points.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,917: Line 2,060:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Clip Extent'''<br>''(ClipExtent)''
|'''FileName''' (FileName)
|
This property specifies the file name for the PTS
(ASCII Point Cloud) reader.
|
|
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
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''File Name'''<br>''(FileName)''
|'''LimitNumberOfPointsRead''' (LimitNumberOfPointsRead)
|
|
This property specifies the file name for the POP Ocean file reader.
 
Limits the number of points read in from file


|
|
0
|
|
Accepts boolean values (0 or 1).
|-
|-
| '''Number Of Ghost Levels'''<br>''(NumberOfGhostLevels)''
|'''MaxNumberOfPoints''' (MaxNumberOfPoints)
|
|
This property indicates the number of ghost levels to generate.


| 1
Specify the max number of point to be read.
 
|
|
100000
|
|-
|-
| '''Radius'''<br>''(Radius)''
|'''LimitPointCloudToBounds''' (LimitPointCloudToBounds)
|
|
This property specifies the radius of the dataset.


| 60000
Restrict the point to cloud to a specified volume.
 
|
0
|
Accepts boolean values (0 or 1).
|-
|'''ReadBounds''' (ReadBounds)
|
Define the spatial volume that wil restrict the
extent of the point cloud [xmin, xmax, ymin, ymax, zmin, zmax]
|
|
0 100 0 100 0 100
|
|}
|}


==PVD Reader==
==PVD Reader==


 
Load a dataset stored in ParaView's PVD file format.The PVD reader reads data
Load a dataset stored in ParaView's PVD file format.
stored in ParaView's PVD file format. The .pvd file is
 
essentially a header file that collects together other
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>
data files stored in VTK's XML-based file
format.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,961: Line 2,126:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
This property specifies the file name for the PVD
reader.
|
|
This property specifies the file name for the PVD reader.


|
|
The value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
|}


|


==Particles Reader==


|}


Reads particle data.
==Parallel NetCDF POP reader==


vtkParticleReader reads either a binary or a text file of particles. Each particle can have associated with it an optional scalar value. 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.<br>
Reads rectilinear grid data from a NetCDF POP file in parallel.
The reader reads regular rectilinear grid (image/volume) data from a
NetCDF file. Only a subset of the processes actually read the file and
these processes communicate the data to other processes.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 1,984: Line 2,160:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileNameInfo''' (FileNameInfo)
|
|
The list of files to be read by the reader.


|
|
|
|-
| '''Byte Order'''<br>''(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'''<br>''(DataType)''
|'''FileName''' (FileName)
|
The list of files to be read by the
reader.
|
|
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).
The value(s) must be a filename (or filenames).
 
 
|-
|-
| '''File Type'''<br>''(FileType)''
|'''TimestepValues''' (TimestepValues)
|
|
Set the file type. The options are:
Available timestep values.
- 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'''<br>''(HasScalar)''
|
|
Default: 1. If 1 then each particle has a value associated with it.


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




|}
|}


==Particles Reader==


==Partitioned Legacy VTK Reader==
Reads 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.


 
{| class="PropertiesTable" border="1" cellpadding="5"
Reads 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.<br>
 
{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Property'''
| '''Property'''
Line 2,053: Line 2,208:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
The list of files to be read by the
reader.
|
 
|
The value(s) must be a filename (or filenames).
|-
|'''FileNameInfo''' (FileNameInfo)
|
 
|
 
|
|
This property specifies the file name for the Partitioned Legacy VTK reader.


|-
|'''TimestepValues''' (TimestepValues)
|
|
Available timestep values.
|
|
|}


|


==Phasta Reader==


|}


Reads the parallel Phasta meta-file and the underlying Phasta files.
==Partitioned Legacy VTK Reader==


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>
Reads 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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,076: Line 2,253:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
This property specifies the file name for the
Partitioned Legacy VTK reader.
|
|
This property specifies the file name for the Phasta reader.


|
|
|
The value(s) must be a filename (or filenames).
 
|}
|}


==Phasta Reader==


==Restarted Sim Exodus Reader==
Reads 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
Reads collections of Exodus output files from simulations that were restarted.
output of this reader is a multipiece data
 
set.
When a simulation that outputs exodus files is restarted, you typically 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,099: Line 2,280:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
This property specifies the file name for the Phasta
reader.
|
|
This points to a special metadata file that lists the output files for each restart.


|
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''Use Meta File'''<br>''(UseMetaFile)''
|'''TimestepValues''' (TimestepValues)
|
|
This hidden property must always be set to 1 for this proxy to work.
Available timestep values.
 
| 1
|
|
Only the values 0 and 1 are accepted.


|-
| '''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
|
Only the values 0 and 1 are accepted.


|}


|-
==RTXMLPolyDataReader==
| '''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
|
Only the values 0 and 1 are accepted.




{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Displacement Magnitude'''<br>''(DisplacementMagnitude)''
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
 
|-
|'''FileName''' (FileName)
|
Set the file name for the real-time VTK polygonal
dataset reader.
|
|
When displacements are being applied, they are scaled by this amount. Set to 1 for no scaling.


| 1
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''Edge Blocks'''<br>''(EdgeBlocks)''
|'''Location''' (Location)
|
Set the data directory containing real time data
files.
|
|
Use this property to select which blocks of edges should be loaded.
All edges in the same block will have the same interpolant (linear, quadratic, etc.)
and have the same variables defined over them.


|
|
The value(s) must be a filename (or filenames).
|-
|'''NextFileName''' (NextFileName)
|
|
The list of array names is provided by the reader.


|-
| '''Edge Map Array Status'''<br>''(EdgeMapArrayStatus)''
|
|
Specify which maps defined over edges in the mesh should be loaded.
An edge map is a renumbering of all the edges (across all the edge blocks of a file) from their offset in the file
to some arbitrary integers, usually specifying a unique global ID across a set of files.


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


|-
|-
| '''Edge Set Array Status'''<br>''(EdgeSetArrayStatus)''
|'''NewDataAvailable''' (NewDataAvailable)
|
|
An Exodus II file may define subsets of all the edges (across all edge blocks) in a file as sets in their own right.
This property specifies which of those sets should be loaded.
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per edge.
The accompanying EdgeSetResultArrayStatus property specifies which variables defined over those sets should be loaded.


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




|-
|}
| '''Edge Set Result Array Status'''<br>''(EdgeSetResultArrayStatus)''
 
|
==Restarted Sim Exodus Reader==
An Exodus II file may define subsets of all the edges (across all edge blocks) in a file as sets in their own right.
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per edge.
This property specifies which of those variables should be loaded.
The corresponding set must also be loaded using the EdgeSetArrayStatus property in order for the variable to appear.


|
Reads collections of Exodus output files from simulations that were restarted.
|
When a simulation that outputs exodus files is restarted,
The list of array names is provided by the reader.
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.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Edge Variables'''<br>''(EdgeVariables)''
|'''FileNameInfo''' (FileNameInfo)
|
|
Use this property to select which variables defined over edges should be loaded.
Edges are oriented boundaries of one or more higher-dimensional cells also present in the mesh.
Edge variables specify a single value per entry in some edge block.


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


|-
|-
| '''Element Blocks'''<br>''(ElementBlocks)''
|'''FileName''' (FileName)
|
This points to a special metadata file that lists the
output files for each restart.
|
|
Use this property to select which blocks of elements (cells) should be loaded.
All elements (cells) in the same block will have the same interpolant (tetrahedral, triangular, trilinear hexahedral, etc.)
and have the same variables defined over them.


|
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''Element Map Array Status'''<br>''(ElementMapArrayStatus)''
|'''UseMetaFile''' (UseMetaFile)
|
|
Specify which maps defined over elements (cells) in the mesh should be loaded.
This hidden property must always be set to 1 for this
An element map is a renumbering of all the elements (across all the element blocks of a file) from their offset in the file
proxy to work.
to some arbitrary integers, usually specifying a unique global ID across a set of files.
These are sometimes called new-style maps because they are specified differently
than in older Exodus files, which only allowed a single element map.
 
|
|
1
|
|
The list of array names is provided by the reader.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Element Set Array Status'''<br>''(ElementSetArrayStatus)''
|'''TimestepValues''' (TimestepValues)
|
|
An Exodus II file may define subsets of all the elements (across all element blocks) in a file as sets in their own right.
This property specifies which of those sets should be loaded.
Variables, such as feature classifiers, may then be defined over these sets by specifying a single number per element.
The accompanying ElementSetResultArrayStatus property specifies which variables defined over those sets should be loaded.


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




|-
|}
| '''Element Set Result Array Status'''<br>''(ElementSetResultArrayStatus)''
|
An Exodus II file may define subsets of all the elements (across all element blocks) in a file as sets in their own right.
Variables, such as feature classifiers, may then be defined over these sets by specifying a single number per element.
This property specifies which of those variables should be loaded.
The corresponding set must also be loaded using the ElementSetArrayStatus property in order for the variable to appear.


|
==Restarted Sim Spy Plot Reader==
|
The list of array names is provided by the reader.


Reads 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.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Element Variables'''<br>''(ElementVariables)''
| '''Property'''
|
| '''Description'''
Use this property to select which variables defined over elements (cells) should be loaded.
| '''Default Value(s)'''
Element variables specify a single value per entry in some element block.
| '''Restrictions'''


|-
|'''FileName''' (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.


|
The value(s) must be a filename (or filenames).
|-
|-
| '''Exodus Model Metadata'''<br>''(ExodusModelMetadata)''
|'''UseMetaFile''' (UseMetaFile)
|
|
Should metadata for the mesh be stored in the field data of the reader's output?
This hidden property must always be set to 1 for this
 
proxy to work.
| 0
|
1
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Face Blocks'''<br>''(FaceBlocks)''
|'''TimestepValues''' (TimestepValues)
|
|
Use this property to select which blocks of faces should be loaded.
All faces in the same block will have the same interpolant (triangular, bilinear quadrilateral, etc.)
and have the same variables defined over them.


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




|-
|}
| '''Face Map Array Status'''<br>''(FaceMapArrayStatus)''
|
Specify which maps defined over faces in the mesh should be loaded.
A face map is a renumbering of all the faces (across all the face blocks of a file) from their offset in the file
to some arbitrary integers, usually specifying a unique global ID across a set of files.


|
==SLAC Data Reader==
|
The list of array names is provided by the reader.


A reader for a data format used by Omega3p, Tau3p, and several other tools used at the Standford Linear Accelerator Center (SLAC)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.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Face Set Array Status'''<br>''(FaceSetArrayStatus)''
| '''Property'''
|
| '''Description'''
An Exodus II file may define subsets of all the faces (across all face blocks) in a file as sets in their own right.
| '''Default Value(s)'''
This property specifies which of those sets should be loaded.
| '''Restrictions'''
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per face.
The accompanying FaceSetResultArrayStatus property specifies which variables defined over those sets should be loaded.


|-
|'''MeshFileName''' (MeshFileName)
|
|
The name of the mesh file to load.
|
|
The list of array names is provided by the reader.


|
The value(s) must be a filename (or filenames).
|-
|-
| '''Face Set Result Array Status'''<br>''(FaceSetResultArrayStatus)''
|'''ModeFileName''' (ModeFileName)
|
The name of the mode files to load. The points in the
mode file should be the same as the mesh file.
|
|
An Exodus II file may define subsets of all the faces (across all face blocks) in a file as sets in their own right.
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per face.
This property specifies which of those variables should be loaded.
The corresponding set must also be loaded using the FaceSetArrayStatus property in order for the variable to appear.


|
|
The value(s) must be a filename (or filenames).
|-
|'''ReadInternalVolume''' (ReadInternalVolume)
|
|
The list of array names is provided by the reader.
If on, read the internal volume of the data
 
set.
 
|
0
|
Accepts boolean values (0 or 1).
|-
|-
| '''Face Variables'''<br>''(FaceVariables)''
|'''ReadExternalSurface''' (ReadExternalSurface)
|
|
Use this property to select which variables defined over faces should be loaded.
If on, read the external surfaces of the data
Faces are oriented boundaries of one or more higher-dimensional cells also present in the mesh.
set.
Face variables specify a single value per entry in some face block.
 
|
|
1
|
|
The list of array names is provided by the reader.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Generate Global Element Id Array'''<br>''(GenerateGlobalElementIdArray)''
|'''ReadMidpoints''' (ReadMidpoints)
|
|
Should the reader retrieve the first new-style element map, or if that is not present,
If on, reads midpoint information for external surfaces
the solitary old-style element map (which always exists but may be procedurally generated
and builds quadratic surface triangles.
if it is not stored with the file)?
|
 
0
| 1
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Generate Global Node Id Array'''<br>''(GenerateGlobalNodeIdArray)''
|'''TimestepValues''' (TimestepValues)
|
This magic property sends time information to the
animation panel. ParaView will then automatically set up the animation
to visit the time steps defined in the file.
|
|
Should the reader retrieve the first new-style node map, or if that is not present,
the solitary old-style node map (which always exists but may be procedurally generated
if it is not stored with the file)?


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


|-
|-
| '''Generate Object Id Cell Array'''<br>''(GenerateObjectIdCellArray)''
|'''TimeRange''' (TimeRange)
|
This magic property sends time range information to the
animation panel. ParaView uses this information to set the range of
time for the animation. This property is important for when there are
no timesteps but you still want to give ParaView a range of values to
use.
|
|
Specifies whether a variable named "ObjectId" should be created for each entry of each block and set being loaded
and assigned the identifying number of the block or set, so that given a cell one can readily identify the block
or set it came from.
This is useful for coloring a mesh by block ID or set ID.


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


|-
|-
| '''Global Variables'''<br>''(GlobalVariables)''
|'''FrequencyScale''' (FrequencyScale)
|
|
Use this property to select which global (i.e., per-mesh) variables should be loaded.
 
Global variables are stored as arrays in the field data of the reader's output.
Sets the scale factor for each mode. By default, each scale factor is
set to 1.


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


|-
|-
| '''Has Mode Shapes'''<br>''(HasModeShapes)''
|'''FrequencyScaleInfo''' (FrequencyScaleInfo)
|
|
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'''<br>''(ModeShape)''
|'''PhaseShift''' (PhaseShift)
|
|
Specify which mode shape to animate when HasModeShapes is on.


| 1
Sets the phase offset for each mode. By default, shift is set to 0.
 
|
|
|-
| '''Node Map Array Status'''<br>''(NodeMapArrayStatus)''
|
Specify which maps defined over nodes (points) in the mesh should be loaded.
A node map is a renumbering of all the points in a file from their offset in the file
to some arbitrary integers, usually specifying a unique global ID across a set of files.
These are sometimes called new-style maps because they are specified differently
than in older Exodus files, which only allowed a single node map.


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


|-
|-
| '''Node Set Array Status'''<br>''(NodeSetArrayStatus)''
|'''PhaseShiftInfo''' (PhaseShiftInfo)
|
|
An Exodus II file may define subsets of all the nodes (points) in a file as sets in their own right.
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per node.
This property specifies which of those sets should be loaded.
The accompanying NodeSetResultArrayStatus property specifies which variables defined over those sets should be loaded.


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




|-
|}
| '''Node Set Result Array Status'''<br>''(NodeSetResultArrayStatus)''
|
An Exodus II file may define subsets of all the nodes (points) in a file as sets in their own right.
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per node.
This property specifies which of those variables should be loaded.
The corresponding set must also be loaded using the NodeSetArrayStatus property in order for the variable to appear.


|
==SLAC Particle Data Reader==
|
The list of array names is provided by the reader.


The SLAC Particle data reader.The SLAC Particle data reader.


{| class="PropertiesTable" border="1" cellpadding="5"
|-
|-
| '''Point Variables'''<br>''(PointVariables)''
| '''Property'''
|
| '''Description'''
Use this property to select which nodal (i.e., per-point) variables should be loaded.
| '''Default Value(s)'''
| '''Restrictions'''


|-
|'''FileName''' (FileName)
|
|
A list of files to be read in a time
series.
|
|
The list of array names is provided by the reader.


|
The value(s) must be a filename (or filenames).
|-
|-
| '''Side Set Array Status'''<br>''(SideSetArrayStatus)''
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
An Exodus II file may define subsets of all the of all the elements in a file as sets in their own right.
This property specifies which of those sets should be loaded.
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per side.
For example, a hexahedron has 18 sides: 6 faces and 12 edges.
Any of these sides may be individually called out in a set and assigned a result value.
The accompanying SideSetResultArrayStatus property specifies which variables defined over those sets should be loaded.


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


|}
==STL Reader==
Reads 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.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''


|-
|-
| '''Side Set Result Array Status'''<br>''(SideSetResultArrayStatus)''
|'''FileNameInfo''' (FileNameInfo)
|
|
An Exodus II file may define subsets of all the of all the elements in a file as sets in their own right.
Variables, such as boundary conditions, may then be defined over these sets by specifying a single number per side.
For example, a hexahedron has 18 sides: 6 faces and 12 edges.
Any of these sides may be individually called out in a set and assigned a result value.
This property specifies which of those variables should be loaded.
The corresponding set must also be loaded using the SideSetArrayStatus property in order for the variable to appear.


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


|-
|-
| '''XML File Name'''<br>''(XMLFileName)''
|'''FileNames''' (FileNames)
|
The list of files to be read by the reader. If more than
one file is specified, the reader will switch to file series mode in
which it will pretend that it can support time and provide one file per
time step.
|
|
This property specifies the name of an XML file containing part and material descriptions and a mapping to element blocks.


|
|
The value(s) must be a filename (or filenames).
|-
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
|}


|


==Restarted Sim Spy Plot Reader==


|}


Read collections of SPCTH files from simulations that were restarted.
==Spy Plot Reader==


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>
Reads 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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,514: Line 2,662:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''Cell Arrays''' (CellArrayStatus)
|
This property lists which cell-centered arrays to
read.
|
|
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.
|-
|'''FileName''' (FileName)
|
|
This property specifies the file name for the Spy Plot
reader.
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''Use Meta File'''<br>''(UseMetaFile)''
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
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'''<br>''(CellArrayStatus)''
|'''DownConvertVolumeFraction''' (DownConvertVolumeFraction)
|
|
This property lists which cell-centered arrays to read.
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
|
|
The list of array names is provided by the reader.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Distribute Files'''<br>''(DistributeFiles)''
|'''ComputeDerivedVariables''' (ComputeDerivedVariables)
|
|
In parallel mode, if this property is set to 1, the reader will distribute files or blocks.
If this property is set to 1, the reader will convert
 
derived variables like material density for the materials that the user
| 1
has selected. For Density the user needs to have selected Material Mass
and Material Volume Fraction.
|
|
Only the values 0 and 1 are accepted.
1
 
|
 
Accepts boolean values (0 or 1).
|-
|'''DistributeFiles''' (DistributeFiles)
|
In parallel mode, if this property is set to 1, the
reader will distribute files or blocks.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''GenerateLevelArray''' (GenerateLevelArray)
|
If this property is set to 1, a cell array will be
generated that stores the level of each block.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''GenerateActiveBlockArray''' (GenerateActiveBlockArray)
|
If this property is set to 1, a cell array will be
generated that stores the active status of a block.
|
0
|
Accepts boolean values (0 or 1).
|-
|'''GenerateTracers''' (GenerateTracers)
|
If this property is set to 1, a cell array will be
generated that stores the coordinates of any tracers.
|
1
|
Accepts boolean values (0 or 1).
|-
|-
| '''Down Convert Volume Fraction'''<br>''(DownConvertVolumeFraction)''
|'''GenerateMarkers''' (GenerateMarkers)
|
|
If this property is set to 0, the type of the volume fraction is float; is set to 1, the type is unsigned char.
If this property is set to 1, a second output will be
 
created using the markers data stored in the file.
| 1
|
1
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Generate Active Block Array'''<br>''(GenerateActiveBlockArray)''
|'''GenerateBlockIdArray''' (GenerateBlockIdArray)
|
|
If this property is set to 1, a cell array will be generated that stores the active status of a block.
If this property is set to 1, a cell array will be
 
generated that stores a unique blockId for each block.
| 0
|
0
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 
 
|-
|-
| '''Generate Block Id Array'''<br>''(GenerateBlockIdArray)''
|'''MergeXYZComponents''' (MergeXYZComponents)
|
|
If this property is set to 1, a cell array will be generated that stores a unique blockId for each block.
If this property is set to 1, cell arrays named (for
 
example) X velocity, Y velocity and Z velocity will be combined into a
| 0
single vector array named velocity.
|
1
|
Accepts boolean values (0 or 1).
|-
|'''CellArrayInfo''' (CellArrayInfo)
|
|
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.




|}
|}


==TIFF Reader==


==SESAME Reader==
Reads 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
Read SESAME data files, producing rectilinear grids.
file extension is .tiff.
 
The SESAME reader reads SESAME data files, and outputs rectilinear grids. The expected file extension is .sesame.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,607: Line 2,798:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
This property specifies the file name for the SESAME reader.
 
|
|
This property specifies the file name for the TIFF
reader.
|
|
|-
| '''Table Id'''<br>''(TableId)''
|
This proeprty indicates which table to read.


| -1
|
|
The value must be one of the following:.
The value(s) must be a filename (or filenames).
 


|}
|}


==TIFF Series Reader==


==SLAC Data Reader==
Reads a series of TIFF files into an time sequence of image datas.The TIFF series
 
reader reads TIFF files. The output is a time sequence of
 
uniform rectilinear (image/volume) dataset. The default
A reader for a data format used by Omega3p, Tau3p, and several<br>
file extension is .tif or .tiff.
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"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,641: Line 2,824:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Mesh File Name'''<br>''(MeshFileName)''
|'''FileNames''' (FileNames)
|
The list of files to be read by the reader. If more than
one file is specified, the reader will switch to file series mode in
which it will pretend that it can support time and provide one file per
time step.
|
|
The name of the mesh file to load.


|
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''Mode File Name'''<br>''(ModeFileName)''
|'''TimestepValues''' (TimestepValues)
|
The name of the mode files to load. The points in the mode file should be the same as the mesh file.
 
|
|
|
|-
Available timestep values.
| '''Read External Surface'''<br>''(ReadExternalSurface)''
|
|
If on, read the external surfaces of the data set.


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


|-
|-
| '''Read Internal Volume'''<br>''(ReadInternalVolume)''
|'''ReadAsImageStack''' (ReadAsImageStack)
|
If on, read the internal volume of the data set.
 
| 0
|
|
Only the values 0 and 1 are accepted.


When set, the reader will read the set of files as an image stack, rather than
a temporal file series.


|-
| '''Read Midpoints'''<br>''(ReadMidpoints)''
|
|
If on, reads midpoint information for external surfaces and builds
1
quadratic surface triangles.
 
| 0
|
|
Only the values 0 and 1 are accepted.
Accepts boolean values (0 or 1).
 


|}
|}


==Tecplot Reader==


==SLAC Particle Data Reader==
Reads 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
The SLAC Particle data reader.<br>
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.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,700: Line 2,877:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileNames''' (FileNames)
|
The list of files to be read by the
reader.
|
|
A list of files to be read in a time series.


|
|
The value(s) must be a filename (or filenames).
|-
|'''FileNameInfo''' (FileNameInfo)
|
|
|
|-
|'''TimestepValues''' (TimestepValues)
|
Available timestep values.
|
|
|}


|


==STL Reader==


|}


Read ASCII or binary stereo lithography (STL) files.
==Unstructured NetCDF POP reader==


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>
Reads rectilinear grid data from a NetCDF POP file and converts it into unstructured data.
The reader reads regular rectilinear grid (image/volume) data from a
NetCDF file and turns it into an unstructured spherical
grid.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,723: Line 2,919:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Names'''<br>''(FileNames)''
|'''FileNameInfo''' (FileNameInfo)
|
|
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.


|
|
|
|
|}


|-
|'''FileName''' (FileName)
|
The list of files to be read by the
reader.
|


==Spy Plot History Reader==
Read a spcth history file where each row translates into a single time step and the columns are points, materials and properties.
{| class="PropertiesTable" border="1" cellpadding="5"
|-
| '''Property'''
| '''Description'''
| '''Default Value(s)'''
| '''Restrictions'''
|-
| '''Comment Character'''<br>''(CommentCharacter)''
|
This property lists the characters that is used as the first character on comment lines
| %
|
|
The value(s) must be a filename (or filenames).
|-
|-
| '''Delimeter'''<br>''(Delimeter)''
|'''TimestepValues''' (TimestepValues)
|
Character that is used as the delimeter.
 
| ,
|
|
|-
Available timestep values.
| '''File Name'''<br>''(FileName)''
|
|
This property specifies the file name for the VRML reader.


|
|
|
|}




==Spy Plot Reader==
|}


==VPIC Reader==


Read files in the SPCTH Spy Plot file format.
Reads distributed VPIC files into an ImageData.VPIC is a 3D
 
kinetic plasma particle-in-cell simulation. The input file
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>
(.vpc) opened by the VPIC reader is an ASCII description
of the data files which are written one file per
processor, per category and per time step. These are
arranged in subdirectories per category (field data and
hydrology data) and then in time step
subdirectories.


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,782: Line 2,965:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''Cell Arrays'''<br>''(CellArrayStatus)''
|'''FileName''' (FileName)
|
ASCII .vpc file describes locations of data files, grid
sizes, time step sizes and type and order of data written to the
files.
|
|
This property lists which cell-centered arrays to read.


|
|
The value(s) must be a filename (or filenames).
|-
|'''PointArrayInfo''' (PointArrayInfo)
|
|
|
The list of array names is provided by the reader.


|


|-
|-
| '''Distribute Files'''<br>''(DistributeFiles)''
|'''Point Arrays''' (PointArrayStatus)
|
Variables written to the data files are described in the
.vpc file and are presented for selection. Only selected variables are
loaded for a time step.
|
|
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.
The list of array names is provided by the reader.
 
 
|-
|-
| '''Down Convert Volume Fraction'''<br>''(DownConvertVolumeFraction)''
|'''TimestepValues''' (TimestepValues)
|
|
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'''<br>''(FileName)''
|'''Stride''' (SetStride)
|
|
This property specifies the file name for the Spy Plot reader.
VPIC data may be very large and not all is needed for
 
effective visualization. Setting the stride selects every nth data item
within the files for display.
|
|
1 1 1
|
|
|-
|-
| '''Generate Active Block Array'''<br>''(GenerateActiveBlockArray)''
|'''DefaultXExtent''' (DefaultXExtent)
|
VPIC data is written one file per simulation processor.
This coarse map of files is used in partitioning files between
visualizing processors so that each ParaView processor has its own set
of files to display. Default extent is all files
available.
|
|
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'''<br>''(GenerateBlockIdArray)''
|'''DefaultYExtent''' (DefaultYExtent)
|
VPIC data is written one file per simulation processor.
This coarse map of files is used in partitioning files between
visualizing processors so that each ParaView processor has its own set
of files to display. Default extent is all files
available.
|
|
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'''<br>''(GenerateLevelArray)''
|'''DefaultZExtent''' (DefaultZExtent)
|
VPIC data is written one file per simulation processor.
This coarse map of files is used in partitioning files between
visualizing processors so that each ParaView processor has its own set
of files to display. Default extent is all files
available.
|
|
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'''<br>''(GenerateTracerArray)''
|'''X Extent''' (XExtent)
|
VPIC data is written one file per simulation processor.
This coarse map of files is used in partitioning files between
visualizing processors so that each ParaView processor has its own set
of files to display. Ghost cell overlap is handled within the reader.
To limit the View of VPIC information the extent in the X dimension of
"files" can be specified. Only the files selected will be displayed and
they will be partitioned between the visualizing processors, allowing a
higher resolution over a smaller area.
|
-1 -1
|
|
If this property is set to 1, a cell array will be generated that stores the coordinates of any tracers.


| 0
|-
|'''Y Extent''' (YExtent)
|
VPIC data is written one file per simulation processor.
This coarse map of files is used in partitioning files between
visualizing processors so that each ParaView processor has its own set
of files to display. Ghost cell overlap is handled within the reader.
To limit the View of VPIC information the extent in the Y dimension of
"files" can be specified. Only the files selected will be displayed and
they will be partitioned between the visualizing processors, allowing a
higher resolution over a smaller area.
|
-1 -1
|
|
Only the values 0 and 1 are accepted.


|-
|-
| '''Merge XYZComponents'''<br>''(MergeXYZComponents)''
|'''Z Extent''' (ZExtent)
|
|
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.
VPIC data is written one file per simulation processor.
 
This coarse map of files is used in partitioning files between
| 1
visualizing processors so that each ParaView processor has its own set
of files to display. Ghost cell overlap is handled within the reader.
To limit the View of VPIC information the extent in the Z dimension of
"files" can be specified. Only the files selected will be displayed and
they will be partitioned between the visualizing processors, allowing a
higher resolution over a smaller area.
|
-1 -1
|
|
Only the values 0 and 1 are accepted.




|}
|}


==VRML Reader==


==TIFF 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.
Read a TIFF file into an image data.
The output of this reader is a polygonal
 
dataset.
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 .tiff.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,885: Line 3,110:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Name'''<br>''(FileName)''
|'''FileName''' (FileName)
|
This property specifies the file name for the VRML
reader.
|
|
This property specifies the file name for the TIFF reader.


|
|
|
The value(s) must be a filename (or filenames).
 
|}
|}


==Wavefront OBJ Reader==


==TIFF Series Reader==
Reads 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
Read a series of TIFF files into an time sequence of image datas.
reading these files are polygons and
 
lines.
The TIFF series reader reads TIFF files. The output is a time sequence of uniform<br>
rectilinear (image/volume) dataset. The default file extension is .tif or .tiff.<br>


{| class="PropertiesTable" border="1" cellpadding="5"
{| class="PropertiesTable" border="1" cellpadding="5"
Line 2,909: Line 3,137:
| '''Default Value(s)'''
| '''Default Value(s)'''
| '''Restrictions'''
| '''Restrictions'''
|-
|-
| '''File Names'''<br>''(FileNames)''
|'''FileName''' (FileName)
|
This property specifies the file name for the OBJ
reader.
|
|
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.


|
|
|
The value(s) must be a filename (or filenames).
 
|}
|}


==WindBlade reader==


==Tecplot Reader==
Reads WindBlade/Firetec simulation files possibly including wind turbines and topology files.
 
WindBlade/Firetec is a simulation dealing with the effects
 
of wind on wind turbines or on the spread of fires. It
Read files in the Tecplot ASCII file format.
produces three outputs - a StructuredGrid for the wind
 
data fields, a StructuredGrid for the ground topology, and
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>
a PolyData for turning turbine blades. The input file
(.wind) opened by the WindBlade reader is an ASCII
description of the data files expected. Data is
accumulated by the simulation processor and is written one
file per time step. WindBlade can deal with topology if a
flag is turned on and expects (x,y) data for the ground.
It also can deal with turning wind turbines from other
time step data files which gives polygon positions of
segments of the blades and data for each
segment.