The GridImporter IO mode type
pw::Object pw::Mode pw::IOMode
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]
pw:: | The GridImporter IO mode type |
Instance Actions | |
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. |
read | This action verifies the IO mode attributes and tries to read the file that is being imported. |
canConvert | This action checks if there is data that will be converted when the read action is used. |
convert | This action converts the data read in by creating pw::GridEntity objects based on the imported data. |
GridImport Mode Attributes | |
ANSYS CFX | Attributes supported by the ANSYS CFX GridImport mode. |
ANSYS Fluent | Attributes supported by the ANSYS Fluent GridImport mode. |
Asset | Attributes supported by the Asset GridImport mode. |
CFD++ | Attributes supported by the CFD++ GridImport mode. |
CGNS | Attributes supported by the CGNS GridImport mode. |
CRAFT Tech/ | Attributes supported by the CRAFT Tech/CRUNCH CFD GridImport mode. |
FVUNS | Attributes supported by the FVUNS GridImport mode. |
FVUNS30 | Attributes supported by the FVUNS30 GridImport mode. |
Gmsh | Attributes supported by the Gmsh GridImport mode. |
GridPro | Attributes supported by the GridPro GridImport mode. |
MFEM | Attributes supported by the MFEM GridImport mode. |
NASA/ | Attributes supported by the NASA/FUN3D GridImport mode. |
Nastran | Attributes supported by the Nastran GridImport mode. |
Network | Attributes supported by the Network GridImport mode. |
Network3D | Attributes supported by the Network3D GridImport mode. |
OpenFOAM | Attributes supported by the OpenFOAM GridImport mode. |
PLOT3D | Attributes supported by the PLOT3D GridImport mode. |
Patran | Attributes supported by the Patran GridImport mode. |
STL | Attributes supported by the STL GridImport mode. |
SU2 | Attributes supported by the SU2 GridImport mode. |
Segment | Attributes supported by the Segment GridImport mode. |
UCD | Attributes supported by the UCD GridImport mode. |
UGRID | Attributes supported by the UGRID GridImport mode. |
USM3D | Attributes supported by the USM3D GridImport mode. |
VRML | Attributes supported by the VRML GridImport mode. |
Xpatch | Attributes supported by the Xpatch GridImport mode. |
Attribute FileTypes | |
DomainSplitAngle | FileTypes that support the DomainSplitAngle attribute. |
DomainSplitMultipleEdges | FileTypes that support the DomainSplitMultipleEdges attribute. |
EntityIgnoreIfNameUsed | FileTypes that support the EntityIgnoreIfNameUsed attribute. |
FileByteOrder | FileTypes that support the FileByteOrder attribute. |
FileFormat | FileTypes that support the FileFormat attribute. |
FilePrecision | FileTypes that support the FilePrecision attribute. |
GridBlockDimension | FileTypes that support the GridBlockDimension attribute. |
GridBlockStyle | FileTypes that support the GridBlockStyle attribute. |
GridImportConditionData | FileTypes that support the GridImportConditionData attribute. |
IblankStyle | FileTypes that support the IblankStyle attribute. |
$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.
This action has no parameters.
This action returns a list containing file type names that can be used in the <initialize> command.
$io read
This action verifies the IO mode attributes and tries to read the file that is being imported.
This action has no parameters.
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>.
This action must be called after initialize, but before convert.
AttributeIsInvalid, CannotOpenFile, CannotAccessFile, FormatIsInvalid, DuplicateNameDetected, MissingReferencesDetected, UnsupportedEntityDetected, UnsupportedByCAEDetected, Unknown, InconsistentDimensionDetected
$io convert
This action converts the data read in by creating pw::GridEntity objects based on the imported data.
This action has no parameters.
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>.
This action must be called after initialize and read.
CannotConvertEntity, Unknown
Attributes supported by the ANSYS CFX GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the ANSYS Fluent GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the Asset GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
Attributes supported by the CFD++ GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the CGNS GridImport mode.
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
Attributes supported by the CRAFT Tech/CRUNCH CFD GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the FVUNS GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
Attributes supported by the FVUNS30 GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
Attributes supported by the Gmsh GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the GridPro GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
Attributes supported by the MFEM GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the NASA/FUN3D GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the Nastran GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
Attributes supported by the Network GridImport mode.
FileFormat | File format. It is a Read/Write string value with range < ASCII | Binary | Unformatted >. |
FileByteOrder | File byte order. It is a Read/Write string value with range < Native | Swap | LittleEndian | BigEndian >. |
FilePrecision | Floating-point precision. It is a Read/Write string value with range < Single | Double >. |
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
Attributes supported by the Network3D GridImport mode.
FileFormat | File format. It is a Read/Write string value with range < ASCII | Binary | Unformatted >. |
FileByteOrder | File byte order. It is a Read/Write string value with range < Native | Swap | LittleEndian | BigEndian >. |
FilePrecision | Floating-point precision. It is a Read/Write string value with range < Single | Double >. |
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
Attributes supported by the OpenFOAM GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the PLOT3D GridImport mode.
FileFormat | File format. It is a Read/Write string value with range < ASCII | Binary | Unformatted >. |
FileByteOrder | File byte order. It is a Read/Write string value with range < Native | Swap | LittleEndian | BigEndian >. |
FilePrecision | Floating-point precision. It is a Read/Write string value with range < Single | Double >. |
IblankStyle | Iblank array type. It is a Read/Write string value with range < None | PointBased >. |
GridBlockStyle | The grid IO block style. It is a Read/Write string value with range < Single | Multiple >. |
GridBlockDimension | The grid IO dimensionality. It is a Read/Write string value with range < 1 | 2 | 3 >. |
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
Attributes supported by the Patran GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
Attributes supported by the STL GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
Attributes supported by the SU2 GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the Segment GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
Attributes supported by the UCD GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
Attributes supported by the UGRID GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the USM3D GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
GridImportConditionData | Import grid condition data if available. It is a Read/Write boolean value with default false. |
Attributes supported by the VRML GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
Attributes supported by the Xpatch GridImport mode.
EntityIgnoreIfNameUsed | Ignore entities with existing names. It is a Read/Write boolean value with default false. |
DomainSplitAngle | Split domains at this angle. It is a Read/Write float value with default 0. |
DomainSplitMultipleEdges | Split domains that have multiple edges. It is a Read/Write boolean value with default false. |
FileTypes that support the GridImportConditionData attribute.
ANSYS CFX, ANSYS Fluent, CFD++, CGNS, CRAFT Tech/CRUNCH CFD, Gmsh, MFEM, NASA/FUN3D, OpenFOAM, SU2, UGRID, USM3D
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 getFileTypes
This action verifies the IO mode attributes and tries to read the file that is being imported.
$io read
This action checks if there is data that will be converted when the read action is used.
$io canConvert
This action converts the data read in by creating pw::GridEntity objects based on the imported data.
$io convert
This action begins a mode in the application.
pw::Application begin ?-mode_specific_flags? mode ?entities?