pw:: GridImporter

The GridImporter IO mode type

Derives From

pw::Object pw::Mode pw::IOMode

Notes

To create a mode of this type, use the pw::Application.begin command with the mode GridImport specified, like this:

set importer [pw::Application begin GridImport]
Summary
The GridImporter IO mode type
This action gets a list of the file types that are supported for grid entity import, with certain file types excluded based on the current CAE and dimension.
This action verifies the IO mode attributes and tries to read the file that is being imported.
This action checks if there is data that will be converted when the read action is used.
This action converts the data read in by creating pw::GridEntity objects based on the imported data.
Attributes supported by the ANSYS CFX GridImport mode.
Attributes supported by the ANSYS Fluent GridImport mode.
Attributes supported by the CFD++ GridImport mode.
Attributes supported by the CGNS GridImport mode.
Attributes supported by the CRUNCH CFD GridImport mode.
Attributes supported by the FUN3D GridImport mode.
Attributes supported by the FVUNS GridImport mode.
Attributes supported by the FVUNS30 GridImport mode.
Attributes supported by the Gmsh GridImport mode.
Attributes supported by the GridPro GridImport mode.
Attributes supported by the Nastran GridImport mode.
Attributes supported by the Network GridImport mode.
Attributes supported by the Network3D GridImport mode.
Attributes supported by the OpenFOAM GridImport mode.
Attributes supported by the PLOT3D GridImport mode.
Attributes supported by the Patran GridImport mode.
Attributes supported by the STL GridImport mode.
Attributes supported by the SU2 GridImport mode.
Attributes supported by the Segment GridImport mode.
Attributes supported by the UCD GridImport mode.
Attributes supported by the UGRID GridImport mode.
Attributes supported by the VRML GridImport mode.
Attributes supported by the Xpatch GridImport mode.
FileTypes that support the DomainSplitAngle attribute.
FileTypes that support the DomainSplitMultipleEdges attribute.
FileTypes that support the EntityIgnoreIfNameUsed attribute.
FileTypes that support the FileByteOrder attribute.
FileTypes that support the FileFormat attribute.
FileTypes that support the FilePrecision attribute.
FileTypes that support the GridBlockDimension attribute.
FileTypes that support the GridBlockStyle attribute.
FileTypes that support the GridImportConditionData attribute.
FileTypes that support the IblankStyle attribute.

Instance Actions

getFileTypes

$io getFileTypes

This action gets a list of the file types that are supported for grid entity import, with certain file types excluded based on the current CAE and dimension.

Parameters

This action has no parameters.

Returns

This action returns a list containing file type names that can be used in the <initialize> command.

read

$io read

This action verifies the IO mode attributes and tries to read the file that is being imported.

Parameters

This action has no parameters.

Returns

This action returns a boolean of true if read, false if not.  A Tcl error is thrown on failure if -strict was specified for <initialize>.

Note

This action must be called after initialize, but before convert.

Possible Errors

AttributeIsInvalid, CannotOpenFile, CannotAccessFile, FormatIsInvalid, DuplicateNameDetected, MissingReferencesDetected, UnsupportedEntityDetected, UnsupportedByCAEDetected, Unknown, InconsistentDimensionDetected

canConvert

$io canConvert

This action checks if there is data that will be converted when the read action is used.

Parameters

This action has no parameters.

Returns

This action returns a boolean of true if convert will convert data, false if not.

convert

$io convert

This action converts the data read in by creating pw::GridEntity objects based on the imported data.

Parameters

This action has no parameters.

Returns

This action returns a boolean of true if read, false if not.  A Tcl error is thrown on failure if -strict was specified for <initialize>.

Note

This action must be called after initialize and read.

Possible Errors

CannotConvertEntity, Unknown

GridImport Mode Attributes

ANSYS CFX

Attributes supported by the ANSYS CFX GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.
GridImportConditionDataImport grid condition data if available.  It is a Read/Write boolean value with default false.

ANSYS Fluent

Attributes supported by the ANSYS Fluent GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.
GridImportConditionDataImport grid condition data if available.  It is a Read/Write boolean value with default false.

CFD++

Attributes supported by the CFD++ GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

CGNS

Attributes supported by the CGNS GridImport mode.

Attributes

GridImportConditionDataImport grid condition data if available.  It is a Read/Write boolean value with default false.
EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

CRUNCH CFD

Attributes supported by the CRUNCH CFD GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

FUN3D

Attributes supported by the FUN3D GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

FVUNS

Attributes supported by the FVUNS GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

FVUNS30

Attributes supported by the FVUNS30 GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

Gmsh

Attributes supported by the Gmsh GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

GridPro

Attributes supported by the GridPro GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.

Nastran

Attributes supported by the Nastran GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

Network

Attributes supported by the Network GridImport mode.

Attributes

FileFormatFile format.  It is a Read/Write string value with range < ASCII | Binary | Unformatted >.
FileByteOrderFile byte order.  It is a Read/Write string value with range < Native | Swap | LittleEndian | BigEndian >.
FilePrecisionFloating-point precision.  It is a Read/Write string value with range < Single | Double >.
EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.

Network3D

Attributes supported by the Network3D GridImport mode.

Attributes

FileFormatFile format.  It is a Read/Write string value with range < ASCII | Binary | Unformatted >.
FileByteOrderFile byte order.  It is a Read/Write string value with range < Native | Swap | LittleEndian | BigEndian >.
FilePrecisionFloating-point precision.  It is a Read/Write string value with range < Single | Double >.
EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.

OpenFOAM

Attributes supported by the OpenFOAM GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.
GridImportConditionDataImport grid condition data if available.  It is a Read/Write boolean value with default false.

PLOT3D

Attributes supported by the PLOT3D GridImport mode.

Attributes

FileFormatFile format.  It is a Read/Write string value with range < ASCII | Binary | Unformatted >.
FileByteOrderFile byte order.  It is a Read/Write string value with range < Native | Swap | LittleEndian | BigEndian >.
FilePrecisionFloating-point precision.  It is a Read/Write string value with range < Single | Double >.
IblankStyleIblank array type.  It is a Read/Write string value with range < None | PointBased >.
GridBlockStyleThe grid IO block style.  It is a Read/Write string value with range < Single | Multiple >.
GridBlockDimensionThe grid IO dimensionality.  It is a Read/Write string value with range < 1 | 2 | 3 >.
EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.

Patran

Attributes supported by the Patran GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

STL

Attributes supported by the STL GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

SU2

Attributes supported by the SU2 GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

Segment

Attributes supported by the Segment GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.

UCD

Attributes supported by the UCD GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

UGRID

Attributes supported by the UGRID GridImport mode.

Attributes

FileFormatFile format.  It is a Read/Write string value with range < ASCII | Binary | Unformatted >.
FileByteOrderFile byte order.  It is a Read/Write string value with range < Native | Swap | LittleEndian | BigEndian >.
FilePrecisionFloating-point precision.  It is a Read/Write string value with range < Single | Double >.
EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

VRML

Attributes supported by the VRML GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

Xpatch

Attributes supported by the Xpatch GridImport mode.

Attributes

EntityIgnoreIfNameUsedIgnore entities with existing names.  It is a Read/Write boolean value with default false.
DomainSplitAngleSplit domains at this angle.  It is a Read/Write float value with default 0.
DomainSplitMultipleEdgesSplit domains that have multiple edges.  It is a Read/Write boolean value with default false.

Attribute FileTypes

DomainSplitAngle

FileTypes that support the DomainSplitAngle attribute.

FileTypes

ANSYS CFX, ANSYS Fluent, CFD++, CGNS, CRUNCH CFD, FUN3D, FVUNS, FVUNS30, Gmsh, Nastran, OpenFOAM, Patran, STL, SU2, UCD, UGRID, VRML, Xpatch

DomainSplitMultipleEdges

FileTypes that support the DomainSplitMultipleEdges attribute.

FileTypes

ANSYS CFX, ANSYS Fluent, CFD++, CGNS, CRUNCH CFD, FUN3D, FVUNS, FVUNS30, Gmsh, Nastran, OpenFOAM, Patran, STL, SU2, UCD, UGRID, VRML, Xpatch

EntityIgnoreIfNameUsed

FileTypes that support the EntityIgnoreIfNameUsed attribute.

FileTypes

ANSYS CFX, ANSYS Fluent, CFD++, CGNS, CRUNCH CFD, FUN3D, FVUNS, FVUNS30, Gmsh, GridPro, Nastran, Network, Network3D, OpenFOAM, PLOT3D, Patran, STL, SU2, Segment, UCD, UGRID, VRML, Xpatch

FileByteOrder

FileTypes that support the FileByteOrder attribute.

FileTypes

Network, Network3D, PLOT3D, UGRID

FileFormat

FileTypes that support the FileFormat attribute.

FileTypes

Network, Network3D, PLOT3D, UGRID

FilePrecision

FileTypes that support the FilePrecision attribute.

FileTypes

Network, Network3D, PLOT3D, UGRID

GridBlockDimension

FileTypes that support the GridBlockDimension attribute.

FileTypes

PLOT3D

GridBlockStyle

FileTypes that support the GridBlockStyle attribute.

FileTypes

PLOT3D

GridImportConditionData

FileTypes that support the GridImportConditionData attribute.

FileTypes

ANSYS CFX, ANSYS Fluent, CGNS, OpenFOAM

IblankStyle

FileTypes that support the IblankStyle attribute.

FileTypes

PLOT3D

$io getFileTypes
This action gets a list of the file types that are supported for grid entity import, with certain file types excluded based on the current CAE and dimension.
$io read
This action verifies the IO mode attributes and tries to read the file that is being imported.
$io canConvert
This action checks if there is data that will be converted when the read action is used.
$io convert
This action converts the data read in by creating pw::GridEntity objects based on the imported data.
Base type for all grid entities
Base type for all glyph types
The mode base type
The base IO mode type
pw::Application begin ?-mode_specific_flags? mode ?entities?
This action begins a mode in the application.
A boolean is represented as a 0 or 1, with 0 being false and 1 being true.
A float is a fractional number.
A string is an array of characters.
Attributes supported by the ANSYS CFX GridImport mode.
Attributes supported by the ANSYS Fluent GridImport mode.
Attributes supported by the CFD++ GridImport mode.
Attributes supported by the CGNS GridImport mode.
Attributes supported by the CRUNCH CFD GridImport mode.
Attributes supported by the FUN3D GridImport mode.
Attributes supported by the FVUNS GridImport mode.
Attributes supported by the FVUNS30 GridImport mode.
Attributes supported by the Gmsh GridImport mode.
Attributes supported by the Nastran GridImport mode.
Attributes supported by the OpenFOAM GridImport mode.
Attributes supported by the Patran GridImport mode.
Attributes supported by the STL GridImport mode.
Attributes supported by the SU2 GridImport mode.
Attributes supported by the UCD GridImport mode.
Attributes supported by the UGRID GridImport mode.
Attributes supported by the VRML GridImport mode.
Attributes supported by the Xpatch GridImport mode.
Attributes supported by the GridPro GridImport mode.
Attributes supported by the Network GridImport mode.
Attributes supported by the Network3D GridImport mode.
Attributes supported by the PLOT3D GridImport mode.
Attributes supported by the Segment GridImport mode.