pw:: IOMode

The base IO mode type

Derives From

Summary

pw:: IOMode	The base IO mode type
Instance Actions
initialize	This action initializes the mode with the file type and name.
getForeignEntityCounts	This action gets the counts of foreign entities processed by the mode.
getDetails	This action gets the details of the last IO operation.
getWarningCount	This action gets the number of warnings that occurred during the last IO operation.
getWarningInformation	This action gets the information of the given warning.
getWarnings	This action gets the information of the all the warnings.
getErrorCount	This action gets the number of errors that occurred during the last IO operation.
getErrorCode	This action gets the code of the given error.
getErrorCodes	This action gets the error code list
getErrorInformation	This action gets the information of the given error.
getErrors	This action gets the list of information of the given errors.
getUniqueErrorCodes	This action gets the unique errors from the last IO operation.
getFailureGroups	This action gets the groups that were created during import to group left over entities when an entity has conversion problems.
getFileType	This action gets the mode’s file type.
getFileSubType	This action gets the mode’s file type.
getFileVersion	This action gets the mode’s file version.
getAttributeNames	This action returns a list of the names of the currently available IO mode attributes.
getAttributeCount	This action returns the number of currently available IO mode attributes.
getAttributeDefinition	This action gets the definition of the given IO mode attribute.
getAttributeDefinitions	This action gets the named IO mode attribute list.
getAttribute	This action gets the named IO mode attribute.
setAttribute	This action sets the named IO mode attribute.
Attributes	The valid IOMode attributes.
BlockFacesOnly	Export block faces only.
BoundaryConditionsOnly	Only export the grid’s boundary condition data.
CellCombineAnisotropic
DomainSplitAngle	Split domains at this angle.
DomainSplitMultipleEdges	Split domains that have multiple edges.
DomainSurfaceDegree	Domain surface degree.
EntityIgnoreIfNameUsed	Ignore entities with existing names.
EntityExportFilter	Set GridPro export filter type.
EntityMeshStyle	Specifies the file format’s entity mesh style.
EntityVisibility	Handling for entity visibility data.
ExportDonorInformation	Should donor information be written in the ZoneGridConnectivity_t node when writing a CGNS file.
ExportParentElements	Should parent elements be included in Element_t nodes when writing a CGNS file.
FileByteOrder	File byte order.
FileConvertFormatSettings	Use Native CAD Reader format specific conversion settings.
FileConvertHealTopology	Use Native CAD Reader topology healing functionality.
FileFormat	File format.
FileLargeWidthColumns	Use Nastran “large” format.
FileModelSizeFromFile	Use information from the file to set the model size during import.
FilePrecision	Floating-point precision.
FileUnits	File units specification.
GridBlockDimension	Specifies the block dimensionality.
GridBlockStyle	Specifies the file format’s grid block style.
GridExportMirrored	Set mirroring on export.
GridStructuredAsUnstructured	Domain surface degree.
HybridInterface	Set the interface data type to be used to establish connectivity between blocks of differing type (structured and unstructured).
IblankStyle	Iblank array type.
ModelAssembleTolerance	Assemble models with the given tolerance.
ModelFromFreeSurface	Automatically converts free surfaces into models with a single quilt and trimmed surfaces.
PointwiseCompatibilityMode	Export the file using Pointwise extensions.
PyramidStyle	Set Pyramid Style for Nastran.
QuiltAssembleAngle	Assemble quilts at the given angle.
QuiltBoundaryAssembleAngle	Assemble quilt boundaries at the given angle.
ShellCellMode	Shell cell handling mode.
ShellSplitAngle	Split shells at this angle.
SurfaceSplineBilinear	Spline the control points of imported bilinear surfaces.
SurfaceSplitDiscontinuous	Split surfaces at discontinuities.
TecplotFileFormat	Set Tecplot binary file format: Tecplot Binary (.plt) is the legacy format written by Tecplot 360 and Tecplot Focus.
UnstructuredInterface	Set the interface data type to be used to establish connectivity between unstructured blocks.
ImportLayerScheme	Set the import layer scheme that will be used to determine what layer entities are imported into.
ImportLayerNumber	Set the layer number that imported database entities will be imported into.
GridExportMeshLink	Enables the creation of MeshLink files during CAE export.
GridExportMeshLinkFileName	The name of the exported MeshLink XML file.
GridExportMeshLinkFileType	The type of the exported MeshLink XML file.
GridExportMeshLinkDatabaseFileName	The name of the exported MeshLink database file.
GridExportMeshLinkDatabaseFileType	The type of the exported MeshLink database file.
STLFormatCompliance	Controls the level to which the exported STL file complies with the STL file format specification.

initialize

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

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

Parameters

-strict	If set, all mode subcommands will be run in strict mode. In strict mode, certain subcommands will throw a Tcl error instead of returning false. See the subcommand documentation for details.
-type file_type	This optional parameter is the string file type of the file with options < Automatic \| Asset \| CGNS \| CGNS-STRUCT \| CGNS-UNSTR \| DBA \| DEM \| EGADS \| FVUNS \| FVUNS30 \| GG \| GridPro \| IGES \| Nastran \| Network \| NMB \| Patran \| PLOT3D \| Segment \| STL \| UCD \| UGRID \| VRML \| VRML97 \| Xpatch >. See Notes for more details.
filename	This parameter is the string full path and name of the file to import.

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.

getAttributeDefinition

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

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

Parameters

-extended	If set, the definition list includes additional items similar to pw::Application.getCAESolverAttributeDefinition.
index	This parameter is the integer index of the IO mode attribute to get with the range [1, number of attributes].
name	This parameter is the string parameter name.

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

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 {}

EntityMeshStyle

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

STLFormatCompliance

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

pw:: IOMode

Derives From

Instance Actions

initialize

Parameters

Returns

Notes

getForeignEntityCounts

Parameters

Returns

getDetails

Parameters

Returns

getWarningCount

Parameters

Returns

getWarningInformation

Parameters

Returns

getWarnings

Parameters

Returns

getErrorCount

Parameters

Returns

getErrorCode

Parameters

Returns

getErrorCodes

Parameters

Returns

getErrorInformation

Parameters

Returns

getErrors

Parameters

Returns

getUniqueErrorCodes

Parameters

Returns

getFailureGroups

Parameters

Returns

getFileType

Parameters

Returns

getFileSubType

Parameters

Returns

getFileVersion

Parameters

Returns

getAttributeNames

Parameters

Returns

See Also

getAttributeCount

Parameters

Returns

See Also

getAttributeDefinition

Parameters

Returns

See Also

Example

getAttributeDefinitions

Parameters

Returns

See Also

getAttribute

Parameters

Returns

See Also

setAttribute

Parameters

Returns

See Also

Attributes

BlockFacesOnly

Type