pw::IOMode

$io initialize ?-strict? ?-type file_type? filename

This action initializes the mode with the file type and name.

Parameters

Returns

This action returns a boolean where true if initialized, false if not.  If -strict, a Tcl error is thrown on failure.

Notes

If -type Automatic was specified (or defaulted), the file type is set based on the filename extension.  It is possible the auto-selected file type is incorrect because some file types ambiguously use the same extension.

Not all file types are supported for all modes in all situations.  The supported file types can change based on mode entities or other global settings (e.g. the current CAE solver).  Use $io getFileTypes to get the list of types currently supported by the mode.

$io getForeignEntityCounts

This action gets the counts of foreign entities processed by the mode.

Parameters

This action has no parameters.

Returns

This action returns a list of strings which are foreign entity name and count pairs.

$io getDetails

This action gets the details of the last IO operation.

Parameters

This action has no parameters.

Returns

This action returns a string of text details.

$io getWarningCount

This action gets the number of warnings that occurred during the last IO operation.

Parameters

This action has no parameters.

Returns

The integer number of errors.

$io getWarningInformation index

This action gets the information of the given warning.

Parameters

Returns

This action returns a string of information about the warning.

$io getWarnings

This action gets the information of the all the warnings.

Parameters

This action has no parameters.

Returns

This action returns a string list of information about the warnings.

$io getErrorCount

This action gets the number of errors that occurred during the last IO operation.

Parameters

This action has no parameters.

Returns

The integer number of errors.

$io getErrorCode index

This action gets the code of the given error.

Parameters

Returns

This action returns a string error code that may be one of the following: AttributeIsInvalid, HeaderIsInvalid, CannotOpenFile, CannotAccessFile, FormatIsInvalid, DuplicateNameDetected, UnsupportedEntityDetected, UnsupportedByCAEDetected, CannotConvertEntity, Unknown, Fatal, InconsistentDimensionDetected

This action gets the error code list

Parameters

This action has no parameters.

Returns

This action returns a string list of error codes.

$io getErrorInformation index

This action gets the information of the given error.

Parameters

Returns

This action returns a string of extra information about the error.

$io getErrors

This action gets the list of information of the given errors.

Parameters

This action has no parameters.

Returns

This action returns a string list of extra information about the errors.

$io getUniqueErrorCodes

This action gets the unique errors from the last IO operation.

Parameters

This action has no parameters.

Returns

A list of string error codes.  See getErrorCode for a list of possible values.

$io getFailureGroups

This action gets the groups that were created during import to group left over entities when an entity has conversion problems.

Parameters

This action has no parameters.

Returns

A list of pw::Group objects

$io getFileType ?-nomap?

This action gets the mode’s file type.

Parameters

Returns

This action returns a file type string.

$io getFileSubType

This action gets the mode’s file type.

Parameters

This action has no parameters.

Returns

This action returns a file subtype string or an empty string if a subtype is not defined.

$io getFileVersion

This action gets the mode’s file version.

Parameters

This action has no parameters.

Returns

This action returns a version string or an empty string if a version is not defined.

$io getAttributeNames ?-regex? ?pattern?

This action returns a list of the names of the currently available IO mode attributes.

Parameters

Returns

A list of strings of the names of the currently available IO mode attributes that fit the filter pattern.  If a pattern is not given, all attribute names will be in the list.

See Also

Attributes

$io getAttributeCount

This action returns the number of currently available IO mode attributes.

Parameters

This action has no parameters.

Returns

The integer number of IO mode attributes.

See Also

Attributes

$io getAttributeDefinition ?-extended? < index | name >

This action gets the definition of the given IO mode attribute.

Parameters

Returns

This action returns the attribute definition.

If -extended is not specified, the returned list contains { name type description enum_values }.

If -extended is specified, the returned list contains { group name etype access description default range }.

Where,

• group is the string group of the attribute (Mode).
• name is the string name of the attribute
• type is the string type of the attribute which is one of boolean, integer, float, <enum>, or string
• etype is the string type of the attribute which is one of <Bool>, <Int> <Uint>, <Real>, <String>, <StringList>, <Enum>, or <EnumList>
• description is a string description of the attribute
• enum_values is a pipe delimited string of valid values for an attribute of type string

See Also

Attributes, pw::Application.addCAESolverAttribute

Example

Code

# $io is a CGNS CaeExport mode
puts [$io getAttributeDefinition ExportParentElements]
puts [$io getAttributeDefinition -extended ExportParentElements]

Output

ExportParentElements boolean {Include Parent Elements in export flag}
Mode ExportParentElements Bool RW {Include Parent Elements in export flag} false {}

$io getAttributeDefinitions

This action gets the named IO mode attribute list.

Parameters

This action has no parameters.

Returns

This action returns all the attribute definitions which will be a list of { name type description enum_values }:

• name is the string name of the attribute
• type is the string type of the attribute which is one of boolean, integer, float, and string
• description is a string description of the attribute
• enum_values is a pipe delimited string of valid values for an attribute of type string

See Also

Attributes

$io getAttribute att_name

This action gets the named IO mode attribute.

Parameters

Returns

This action returns the value of the attribute.

See Also

Attributes

$io setAttribute att_name att_value

This action sets the named IO mode attribute.

Parameters

Returns

This action returns nothing.

See Also

Attributes

$io get/setAttribute BlockFacesOnly att_value

Export block faces only.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by all grid export types.

$io get/setAttribute BoundaryConditionsOnly att_value

Only export the grid’s boundary condition data.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is available to any CaeExporter that supports it.

$io get/setAttribute CellCombineAnisotropic att_value

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute DomainSplitAngle att_value

Split domains at this angle.

Type

This attribute is of type float.

Default

The default for this attribute is 0.0

Importers

This attribute is used by all grid import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute DomainSplitMultipleEdges att_value

Split domains that have multiple edges.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by all grid import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute DomainSurfaceDegree att_value

Domain surface degree.

Type

This attribute is of type string; One of < Bilinear | Bicubic >.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the IGES export types.

$io get/setAttribute EntityIgnoreIfNameUsed att_value

Ignore entities with existing names.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by all import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute EntityExportFilter att_value

Set GridPro export filter type.  This attribute determines how an ambiguous entity selection of structured and unstructured domains should be written to a file.

Type

This attribute is of type string; One of < StructuredOnly | UnstructuredOnly | DiagonalizeAll >

Default

The default for this attribute is determined by the entity selection.  If the selection is mixed structured and unstructured, then the attribute is set to DiagonalizeAll.  Otherwise, the attribute matches the domain type of the selection.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the GridPro export type.

$io get/setAttribute EntityMeshStyle att_value

Specifies the file format’s entity mesh style.

Type

This attribute is of type string; One of < Single | Multiple >.

Notes

Single exports all 2-D entities and block faces as a single, possibly non-manifold collection of mesh elements (Triangles and Quadrilaterals).

Multiple exports each 2-D entity and block face as a separate mesh.

Domain surface patch topology will be lost in the exported mesh if blocks are exported.  In this case, it may be possible to recover these patches using a non-zero DomainSplitAngle or ShellSplitAngle.

To better preserve the domain surface patch topology in the exported mesh, domains should be exported.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the STL export type.

$io get/setAttribute EntityVisibility att_value

Handling for entity visibility data.

Type

This attribute is of type string; One of < Import | ImportAndHideSupports | ShowAll | ShowAllAndHideSupports >.

Importers

This attribute is used by all database import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute ExportDonorInformation att_value

Should donor information be written in the ZoneGridConnectivity_t node when writing a CGNS file.

Type

This attribute is of type boolean.

Default

The default for this attribute is true.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the CGNS CaeExporter.

$io get/setAttribute ExportParentElements att_value

Should parent elements be included in Element_t nodes when writing a CGNS file.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the CGNS CaeExporter.

$io get/setAttribute FileByteOrder att_value

File byte order.

Type

This attribute is of type string; One of < Native | Swap | LittleEndian | BigEndian >.

Importers

This attribute is used by all import types.

Exporters

This attribute is used by all export types.

$io get/setAttribute FileConvertFormatSettings att_value

Use Native CAD Reader format specific conversion settings.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by the Native CAD Reader import type.

Exporters

This attribute is not used by any of the export types.

$io get/setAttribute FileConvertHealTopology att_value

Use Native CAD Reader topology healing functionality.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by the Native CAD Reader import type.

Exporters

This attribute is not used by any of the export types.

$io get/setAttribute FileFormat att_value

File format.

Type

This attribute is of type string; One of < ASCII | Binary | Unformatted >.

Default

The default for this attribute is varied.

Importers

This attribute is used by all import types.

Exporters

This attribute is used by all export types.

Notes

The Unformatted value is only valid for “FORTRAN” file types.

$io get/setAttribute FileLargeWidthColumns att_value

Use Nastran “large” format.

Type

This attribute is of type boolean.

Default

The default for this attribute is true.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the Nastran export type.

$io get/setAttribute FileModelSizeFromFile att_value

Use information from the file to set the model size during import.

Type

This attribute is of type boolean.

Default

The default for this attribute is true.

Importers

This attribute is used by the IGES and Native Cad Reader types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute FilePrecision att_value

Floating-point precision.

Type

This attribute is of type string; One of < Single | Double >.

Default

The default for this attribute is varied.

Importers

This attribute is used by all import types.

Exporters

This attribute is used by all export types.

$io get/setAttribute FileUnits att_value

File units specification.

Type

This attribute is of type string; One of < Microinches | Mils | Inches | Feet | Miles | Microns | Millimeters | Centimeters | Meters | Kilometers | FromFile >.

Default

The import default for this attribute is FromFile.  The export default for this attribute is Inches.

Importers

This attribute is used by the IGES and Native Cad Reader types.

Exporters

This attribute is used by the IGES export type.

$io get/setAttribute GridBlockDimension att_value

Specifies the block dimensionality.

Type

This attribute is of type integer; One of < 1, 2, 3 >.

Importers

This attribute is used by the PLOT3D import type.

Exporters

This attribute is used by the PLOT3D export type.

$io get/setAttribute GridBlockStyle att_value

Specifies the file format’s grid block style.

Type

This attribute is of type string; One of < Single | Multiple >.

Default

The import default for this attribute is Single.  The export default for this attribute is Multiple.

Notes

Single exports exactly one PLOT3D block using the single block format.

Multiple exports one or more PLOT3D blocks using the multiple block format.

Importers

This attribute is used by the PLOT3D import type.

Exporters

This attribute is used by the PLOT3D export type.

$io get/setAttribute GridExportMirrored att_value

Set mirroring on export.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by all plugin exporters and CGNS, GASP, KESTREL, and TECPLOT exporters.

$io get/setAttribute GridStructuredAsUnstructured att_value

Domain surface degree.

Type

This attribute is of type boolean.

Default

The default for this attribute depends on the entity selection.  When only structured blocks are selected, it is false.  When mixed blocks are selected, it is true.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the CGNS and Tecplot CaeExporter.

Set the interface data type to be used to establish connectivity between blocks of differing type (structured and unstructured).

Type

This attribute is of type string; One of < FaceToFace | NodeToNode | CellToCell >.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the CGNS CaeExporter.

$io get/setAttribute IblankStyle att_value

Iblank array type.

Type

This attribute is of type string; One of < None | PointBased >.

Importers

This attribute is used by the PLOT3D import type.

Exporters

This attribute is used by the PLOT3D export type.

$io get/setAttribute ModelAssembleTolerance att_value

Assemble models with the given tolerance.

Type

This attribute is of type float.

Default

The default for this attribute is 0.0.

Importers

This attribute is used by all database import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute ModelFromFreeSurface att_value

Automatically converts free surfaces into models with a single quilt and trimmed surfaces.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by all database import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute PointwiseCompatibilityMode att_value

Export the file using Pointwise extensions.

Type

This attribute is of type boolean.

Default

The default for this attribute is true.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the IGES export type.

$io get/setAttribute PyramidStyle att_value

Set Pyramid Style for Nastran.

Type

This attribute is of type string; One of < CPENTA | CPYRAM >.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the Nastran export type.

$io get/setAttribute QuiltAssembleAngle att_value

Assemble quilts at the given angle.

Type

This attribute is of type float.

Default

The default for this attribute is 0.0.

Importers

This attribute is used by all database import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute QuiltBoundaryAssembleAngle att_value

Assemble quilt boundaries at the given angle.

Type

This attribute is of type float.

Default

The default for this attribute is 0.0.

Importers

This attribute is used by all database import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute ShellCellMode att_value

Shell cell handling mode.

Type

This attribute is of type string; One of < AsTriangles | AsTrianglesAndQuadrilaterals | AsIs | MergeCoplanar ).

Importers

This attribute is used by all faceted database import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute ShellSplitAngle att_value

Split shells at this angle.

Type

This attribute is of type float.

Default

The default for this attribute is 0.0.

Importers

This attribute is used by all faceted database import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute SurfaceSplineBilinear att_value

Spline the control points of imported bilinear surfaces.

Type

This attribute is of type boolean.

Default

For backwards compatibility, the default for this attribute is false.  The Pointwise app always sets this to true.  It is highly recommended that this is set to true in scripts that import bilinear surfaces.

Importers

This attribute is used by the PLOT3D and Network import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute SurfaceSplitDiscontinuous att_value

Split surfaces at discontinuities.

Type

This attribute is of type boolean.

Default

The default for this attribute is false.

Importers

This attribute is used by the IGES import type.

Exporters

This attribute is not used by any export types.

$io get/setAttribute TecplotFileFormat att_value

Set Tecplot binary file format: Tecplot Binary (.plt) is the legacy format written by Tecplot 360 and Tecplot Focus.  Tecplot Subzone Loadable (.szplt) was introduced with Tecplot 360 EX.

Type

This attribute is of type string; One of < PLT | SZPLT >

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the Tecplot CaeExporter.

$io get/setAttribute UnstructuredInterface att_value

Set the interface data type to be used to establish connectivity between unstructured blocks.

Type

This attribute is of type string; One of < FaceToFace | NodeToNode | CellToCell >.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the CGNS CaeExporter.

$io get/setAttribute ImportLayerScheme att_value

Set the import layer scheme that will be used to determine what layer entities are imported into.  DefaultLayers will not influence layers.  SingleLayer will import all entities into the layer specified with the ImportLayerNumber attribute.  SequentiallyFromLayer will retain separate layers if they exist in the file, but they will be mapped sequentially beginning at the the layer specified with the ImportLayerNumber attribute.

Type

This attribute is of type string; One of < DefaultLayers | SingleLayer | SequentiallyFromLayer>.

Importers

This attribute is used by all database import types.

Exporters

This attribute is not used by any export types.

$io get/setAttribute ImportLayerNumber att_value

Set the layer number that imported database entities will be imported into.  This number is only used if the ImportLayerScheme is set to an option other than DefaultLayers.

Type

This attribute is of type integer.

Default

The default for this attribute is 0.

Importers

This attribute is used by all database import types.

Exporters

This attribute is used by the export Importer.

$io get/setAttribute GridExportMeshLink att_value

Enables the creation of MeshLink files during CAE export.

Type

This attribute is of type boolean.

Default

The default for this attribute is 0.

Importers

This attribute is not used by any import types.

Exporters

This attribute is available to any CaeExporter that supports it.

See Also

pw::Application pw::Application.getCAESolverAttribute pw::Application.MeshLinkSupported

$io get/setAttribute GridExportMeshLinkFileName att_value

The name of the exported MeshLink XML file.

Type

This attribute is of type string.

Default

The default for this attribute is “<grid filename>.xml”.

Importers

This attribute is not used by any import types.

Exporters

This attribute is available to any CaeExporter that supports it.

See Also

pw::Application pw::Application.getCAESolverAttribute pw::Application.MeshLinkSupported

$io get/setAttribute GridExportMeshLinkFileType att_value

The type of the exported MeshLink XML file.

Type

This attribute is of type string; One of < Uncompressed >.

Importers

This attribute is not used by any import types.

Exporters

This attribute is available to any CaeExporter that supports it.

See Also

pw::Application pw::Application.getCAESolverAttribute pw::Application.MeshLinkSupported

$io get/setAttribute GridExportMeshLinkDatabaseFileName att_value

The name of the exported MeshLink database file.

Type

This attribute is of type string.

Default

The default for this attribute is “<grid filename>.<ext>”.  Where ext is appropriate for the specified database file type.

Importers

This attribute is not used by any import types.

Exporters

This attribute is available to any CaeExporter that supports it.

See Also

pw::Application pw::Application.getCAESolverAttribute pw::Application.MeshLinkSupported

$io get/setAttribute GridExportMeshLinkDatabaseFileType att_value

The type of the exported MeshLink database file.

Type

This attribute is of type string; One of < NMB-Binary | NMB-ASCII >.

Importers

This attribute is not used by any import types.

Exporters

This attribute is available to any CaeExporter that supports it.

See Also

pw::Application pw::Application.getCAESolverAttribute pw::Application.MeshLinkSupported

$io get/setAttribute GridExportPolyVoxel att_value

Enables, for export, the conversion of voxel block, transition region, canonical elements into cuboid polyhedrons.  The exported polyhedrons are point-matched with their neighboring cells.

Type

This attribute is of type boolean.

Default

The default for this attribute is 0.

Importers

This attribute is not used by any import types.

Exporters

This attribute is available to any CaeExporter that supports it.

See Also

pw::Application pw::Application.getCAESolverAttribute <pw::Application.PolyVoxelImproveOrthogonality>

$io get/setAttribute PolyVoxelImproveOrthogonality att_value

Enables the improvement of face orthogonality metrics in the voxel block transition regions by offsetting the combined polyhedron center nodes.

Type

This attribute is of type boolean.

Default

The default for this attribute is 0.  This value is ignored if <pw::Application.GridExportPolyVoxel> is false.

Importers

This attribute is not used by any import types.

Exporters

This attribute is available to any CaeExporter that supports it.

See Also

pw::Application pw::Application.getCAESolverAttribute <pw::Application.GridExportPolyVoxel>

$io get/setAttribute STLFormatCompliance att_value

Controls the level to which the exported STL file complies with the STL file format specification.

Type

This attribute is of type string; One of < Strict | AllowQuadrilaterals | AllowPolygons >.  Most STL readers only support Strict.

Importers

This attribute is not used by any import types.

Exporters

This attribute is used by the STL export type.

ASCII Format

Reference:
https://en.wikipedia.org/wiki/STL_(file_format)#ASCII_STL

Strict
---------------------------------------------
  solid SolidName
  facet normal  nX nY nZ
    outer loop
      vertex   X Y Z
      vertex   X Y Z
      vertex   X Y Z
    endloop
  endfacet
  ...
  facet normal  nX nY nZ
    ...
  endfacet
  endsolid SolidName

AllowQuadrilaterals or AllowPolygons
---------------------------------------------
  solid SolidName
  facet normal  nX nY nZ
    outer loop
      vertex   X Y Z
        ...          - vertex repeated as needed
      vertex   X Y Z
    endloop
  endfacet
  ...
  facet normal  nX nY nZ
    ...
  endfacet
  endsolid SolidName

Binary Format

Reference:
https://en.wikipedia.org/wiki/STL_(file_format)#Binary_STL

Strict
---------------------------------------------
   UINT8[80]         - Header
   UINT32            - Number of triangles
   foreach triangle
      REAL32[3]      - Normal vector
      REAL32[3]      - Vertex 1
      REAL32[3]      - Vertex 2
      REAL32[3]      - Vertex 3
      UINT16         - Attribute byte count = 0
   end

AllowQuadrilaterals or AllowPolygons (version nnnn == 1)
---------------------------------------------
   UINT8[80]         - Header text
   UINT32            - Number of triangles = 0*
   UINT32            - Magic Number = 0xABCDnnnn (nnnn = version)
   UINT32            - Number of polyfacets (tris + quads + polys)
   foreach poly
      REAL32[3]      - Normal vector
      UINT16         - number of vertices (N)
      REAL32[3]      - Vertex 1
       ...
      REAL32[3]      - Vertex N
      UINT16         - Attribute byte count = 0
   end

* A standard reader should stop on a zero tri count. An extended
  reader will proceed if it finds a valid magic number/version.