pw:: Grid

pw::Grid getExportFileTypes ?-facesOnly? entity_list

This action gets a list of file types that can export all of the given entities.

Parameters

Returns

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

pw::Grid checkForInvalidEntities -type file_type ?-facesOnly? ?-invalid invalid_var? entity_list

This action checks if a list of entities are valid for the given settings.

Parameters

Returns

This action returns a boolean, true if all entities are valid for given file type.

Information

The export function has more information about file types.

See Also

export

pw::Grid export ?-type file_type? ?-format file_format? ?-precision fp_precision? ?-surfaces surface_style? ?-facesOnly? ?-noOverwrite? ?-report report_var? entity_list filename

This action exports the list of entities to the given file.

Parameters

Returns

This action returns nothing.

Information

This command supports progress updates.

File Types

For file_format A = ASCII, B = Binary, U = Unformatted

file_type     extension   file_format fp_precision     valid entity types
============= =========== =========== ================ ==================
Gridgen       gg          B           Double           any
IGES          igs,iges    A           Double           structured 2D
STL           stl         A|B         Single           unstructured 2D
GridPro       dat         A           Single|Double    2D
VRML          wrl,vrml    A           Single           2D
VRML97        wrl,vrml    A           Single           2D
PLOT3D        x,xyz,p3d   A|B|U       Double|Single    structured 2D/3D
Segment       dat         A           Double|Single    1D
Patran        pat         A           Single*          2D/3D
Nastran       nas         A           Double|Single**  2D/3D
UCD           ucd         A           Double|Single    2D/3D
Xpatch        facet       A           Double|Single    2D
FVUNS         uns         A|B|U       Single           3D
FVUNS30       uns         A|B|U       Single           3D
CGNS          cgns        B           Double|Single    3D
CGNS-STRUCT   cgns        B           Double|Single    structured 3D
CGNS-UNSTR    cgns        B           Double|Single    3D

*  The Patran format uses a fixed width field giving 10 digits of precision
   (single = 7 digits, double = 16 digits).

** The Nastran format uses a fixed width field giving 10 digits of precision
   (single = 7 digits, double = 16 digits), however the precision field is
   used to specify the style of Nastran export, where Single will generate
   the small Nastran format and Double will generate the large field
   Nastran-L format (using 16 character fields).

pw::Grid checkForMissingReferences ?-type file_type? ?-format file_format? ?-precision fp_precision? ?-missing missingVar? filename

This action checks if importing the given file would result in missing references.

Parameters

Returns

This action returns a boolean, which is true if there are no missing references.

Information

This command supports progress updates.

File Types

See import for information on file types.

pw::Grid import ?-type file_type? ?-format file_format? ?-precision fp_precision? ?-report report_var? filename

This action imports a file into the grid.

Parameters

Returns

This action returns a list of the imported GridEntity objects.  Only entities explicitly defined are returned.  For example, when importing a 2D PLOT3D file, the necessary connectors will be created, but only the domain will be returned.  When importing a Gridgen file, all grid entities imported will be returned since they are all explicitly defined in the file.

Information

This command supports progress updates.

File Types

For file_format A = ASCII, B = Binary, U = Unformatted

file_type     extension   file_format fp_precision     valid entity types
============= =========== =========== ================ ==================
Gridgen       gg          B           Double           any
IGES          igs,iges    A           Double           structured 2D
STL           stl         A|B         Single           unstructured 2D
GridPro       grd         A           Single|Double    structured 3D
VRML          wrl,vrml    A           Single           2D
PLOT3D        x,xyz,p3d   A|B|U       Double|Single    structured 2D/3D
Network       grd,net     A|B|U       Double|Single    structured 2D/3D
Segment       dat         A           Double|Single    1D
Patran        pat         A           Single*          2D/3D
Nastran       nas         A           Double|Single**  2D/3D
UCD           ucd         A           Double|Single    2D/3D
Xpatch        facet       A           Double|Single    2D
FVUNS         uns         A|B|U       Single           3D
CGNS          cgns        B           Double|Single    3D
CGNS-STRUCT   cgns        B           Double|Single    structured 3D
CGNS-UNSTR    cgns        B           Double|Single    3D
UGRID         ugrid       A|B|U       Double|Single    unstructured 2D/3D

*  The Patran format uses a fixed width field giving 10 digits of precision
   (single = 7 digits, double = 16 digits).

** The Nastran format uses a fixed width field giving 10 digits of precision
   (single = 7 digits, double = 16 digits), however the precision field is
   used to specify the style of Nastran import, where Single will generate
   the small Nastran format and Double will generate the large field
   Nastran-L format (using 16 character fields).

pw::Grid save ?-compress level? ?-noOverwrite? filename

This action saves the entire grid in the native file format.

Parameters

Returns

This action returns nothing.

Information

This command supports progress updates.

For “-compress level”, 0 = no compression, 1 = minimum, and 9 = maximum.  Higher levels of compression take longer to save.

pw::Grid mergeConnectors ?-exclude topology? ?-visibleOnly? -tolerance tol

This action merges connectors within a tolerance.

Parameters

Returns

This action returns nothing.

pw::Grid mergeConnectorPair con1 con2

This action automatically merges two connectors.

Parameters

Returns

This action returns nothing.

pw::Grid getXYZ coord

This action gets the 3D position of the given grid coordinate.

Parameters

Returns

This action returns an xyz vector.

pw::Grid getPoint coord

This action gets the position of the given grid coordinates.

Parameters

Returns

This action returns a point giving the position of the grid coordinate It may be in the form “u v dbentity”.

pw::Grid getEntity coord

This action gets the grid entity at the given grid coordinates

Parameters

Returns

This action returns a pw::GridEntity object.

Information

If the given coord is not valid, an error will occur.

pw::Grid mapHigher coord

This action maps the given grid coordinate to all coords that are immediately higher than the specified coord.  That is, a node based grid coord will be mapped to all connector based coords at that point (and similarly; connectors to domains, and domains to blocks).

Parameters

Returns

This action returns a list of grid coords based on higher level grid entities that represent the same point.  An empty list is returned if coord does not map to any higher level entities.

Example

This example starts with $nod (an existing node entity) and maps it up to all unique higher level entities.

Code

puts "***********************************************"
puts "Dumping higher coords for \{1 $nod\}"
puts "***********************************************"
puts ""

# prime coords array with {nodeName nodeCoord}
array set coords [list [$nod getName] [list 1 $nod]]
set indent ""

# keep processing as long as coords array is not empty
while { [array size coords] > 0 } {
    array unset higherCoords ;# clear this out

    # process each name coord pair in the coords array
    foreach { name coord } [array get coords] {
        set xyz [pw::Grid getXYZ $coord]
        puts [format "%-20.20s | %-30.30s | %-s" \
                        "$indent$name" "\{$coord\}" "($xyz)"]

        foreach higherCoord [pw::Grid mapHigher $coord] {
            set higherEnt [lindex $higherCoord end]  ;# get coord's entity
            set higherEntName [$higherEnt getName] ;# get entity name

            # if higherEntName is NOT in higherCoords array
            if { {} == [array get higherCoords $higherEntName] } {
                # Use higherEntName as key to store higherCoord in the
                # higherCoords array
                set higherCoords($higherEntName) $higherCoord
            }
        }
    }
    array unset coords ;# All done with coords

    # reload coords with any lower coordinates found above.
    array set coords [array get higherCoords]

    append indent ".." ;# increase indent level string for next pass
}

Output

***********************************************
Dumping higher coords for {1 ::pw::Node_1}
***********************************************

Node_1            | {1 ::pw::Node_1}               | (-11.0 0.0 9.0)
..conBlkLeft-12   | {3 ::pw::Connector_27}         | (-11.0 0.0 9.0)
..conBlkLeft-13   | {3 ::pw::Connector_31}         | (-11.0 0.0 9.0)
..conBlkLeft-15   | {1 ::pw::Connector_25}         | (-11.0 0.0 9.0)
....domBlkLeft-7  | {3 3 ::pw::DomainStructured_2} | (-11.0 0.0 9.0)
....domBlkLeft-8  | {1 3 ::pw::DomainStructured_1} | (-11.0 0.0 9.0)
....domBlkLeft-10 | {1 1 ::pw::DomainStructured_3} | (-11.0 0.0 9.0)
......blk-1       | {13 ::pw::BlockUnstructured_1} | (-11.0 0.0 9.0)

pw::Grid mapLower ?-includeNodes? coord

This action maps the given grid coordinate to all coords that are immediately lower than the specified coord.  That is, a block based grid coord will be mapped to all domain based coords at that point (and similarly; domains to connectors and connectors to nodes).

Parameters

Returns

This action returns a list of grid coords based on lower level grid entities that represent the same point.  An empty list is returned if coord does not map to any lower level entities.

Example

This example starts with $blk (an existing block entity) and maps a corner coord down to all unique lower level entities.

Code

puts "***********************************************"
puts "Dumping lower coords for \{1 1 1 $blk\}"
puts "***********************************************"
puts ""

# prime coords array with {blockName blockCornerCoord}
array set coords [list [$blk getName] [list 1 1 1 $blk]]
set indent ""

# keep processing as long as coords array is not empty
while { [array size coords] > 0 } {
    array unset lwrCoords ;# clear this out

    # process each name coord pair in the coords array
    foreach { name coord } [array get coords] {
        set xyz [pw::Grid getXYZ $coord]
        puts [format "%-20.20s | %-30.30s | %-s" \
                  "$indent$name" "\{$coord\}" "($xyz)"]

        foreach lwrCoord [pw::Grid mapLower -includeNodes $coord] {
            set lowerEnt [lindex $lwrCoord end]  ;# get coord's entity
            set lowerEntName [$lowerEnt getName] ;# get entity name

            # if lowerEntName is NOT in lwrCoords array
            if { {} == [array get lwrCoords $lowerEntName] } {
                # Use lowerEntName as key to store lwrCoord in the
                # lwrCoords array
                set lwrCoords($lowerEntName) $lwrCoord
            }
        }
    }
    array unset coords ;# All done with coords

    # reload coords with any lower coordinates found above.
    array set coords [array get lwrCoords]

    append indent ".." ;# increase indent level string for next pass
}

Output

***********************************************
Dumping lower coords for {1 1 1 ::pw::BlockExtruded_1}
***********************************************

blk-3         | {1 1 1 ::pw::BlockExtruded_1}  | (0.0 0.0 -6.0)
..dom-13      | {1 1 ::pw::DomainStructured_5} | (0.0 0.0 -6.0)
..dom-9       | {1 ::pw::DomainUnstructured_1} | (0.0 0.0 -6.0)
..dom-11      | {3 1 ::pw::DomainStructured_4} | (0.0 0.0 -6.0)
....con-13    | {1 ::pw::Connector_6}          | (0.0 0.0 -6.0)
....con-15    | {4 ::pw::Connector_4}          | (0.0 0.0 -6.0)
....con-19    | {1 ::pw::Connector_5}          | (0.0 0.0 -6.0)
......Node_1  | {1 ::pw::Node_1}               | (0.0 0.0 -6.0)

pw::Grid offsetIJK coord < i | ij | ijk >

This action offsets the ijk coordinates of the given grid coordinate.

Parameters

Returns

This action returns a grid coord.

pw::Grid offsetNormal coord distance

This action calculates the offset from the given grid coordinate in the direction of the normal at the coordinate.

Parameters

Returns

This action returns an xyz vector.

Information

If the normal is not defined for the given grid coordinate, an error will occur.

pw::Grid getAll ?-type type_string? ?-gridgenCompatible? ?-framework framework?

This action gets a list of all grid entities.

Parameters

Returns

This action returns a list of pw::GridEntity objects.

pw::Grid getCount ?-type type_string? ?-gridgenCompatible?

This action gets the number of grid entities.

Parameters

-type type_string If specified, this option filters the result to include only entities of the specified type.  Only types derived from pw::GridEntity are valid.  -gridgenCompatible If specified, this option filters the result to include only entities that can be exported to the Gridgen format.

Returns

This action returns an integer value.

pw::Grid getByName ?-path path? name

This action gets a grid entity using the name.

Parameters

Returns

This action returns a pw::GridEntity object.

pw::Grid getExtents ?-enabledOnly? ?-visibleOnly?

This action gets the extents of the grid entities.

Parameters

Returns

This action returns a list of two vectors representing the min and max xyz points of the extents.

pw::Grid getElementCount type ?-skip3DCells? ?-frameworks? ?entity_list?

This command returns the number of elements for the given type.  If no entities are provided, then the cell count applies to the entire grid.  If entities are provided, then only elements unique to the provided entities will be counted.

Parameters

Returns

This action returns an integer value.

Example

Code

set domains [pw::Grid getAll -type pw::Domain]
set blocks [pw::Grid getAll -type pw::Block]
# Counts all quad elements of all grid entities
puts [pw::Grid getElementCount Quad]
# Counts only the Quad elements unique to the provided blocks.
# This will count only interior elements, not the shared boundary
# elements.
puts [pw::Grid getElementCount Quad $blocks]
# Counts only the Quad elements unique to the provided domains
puts [pw::Grid getElementCount Quad $domains]

Output

36
12
24

pw::Grid getPointCount ?<Node | Connector | Domain | Block>?

This action gets the number of points in the entire grid.

Parameters

Returns

This action returns an integer value.

Note

When specifying a type, the return value will be the sum of all points for each entity of the given type, which means shared points will be counted twice.  If a unique point count is desired, do not specify the type parameter or use pw::GridEntity.getUniquePointCount.

pw::Grid isMirrored

Determines if a grid mirror plane is defined.

Parameters

none

Returns

This action returns a boolean, true if a mirror plane is defined.

See Also

MirrorPlane, clearMirrorPlane, getMirrorPlaneEntities

pw::Grid clearMirrorPlane

Undefines the grid mirror plane.

Parameters

none

Returns

This action returns nothing.

See Also

MirrorPlane, isMirrored, getMirrorPlaneEntities

pw::Grid getMirrorPlaneEntities ?-partial partial_var? ?-other other_var? ?-plane plane? mirrored_var unmirrored_var ?entity_list?

Processes entity_list for the given plane.

Parameters

Returns

This action returns a list of lower-level entities.  The owned points of these entities all lie on the plane.

Information

In 3D, the returned list contains only domains, connectors and nodes.

In 2D, the returned list contains only connectors and nodes.

The returned list will be empty if no entities lie on the plane or if the mirror plane is undefined.

See Also

MirrorPlane, isMirrored, clearMirrorPlane

pw::Grid calculateLaminarGrowth reynoldsNumber characteristicLength initialSpacingFactor

This action computes anisotropic growth parameters for a laminar boundary layer.  The calculations are based on Blasius’s equation for a smooth flat plate, as referenced in Boundary Layer Theory, Seventh Edition, Schlichting, H., McGraw-Hill: 1979, p 142.

Parameters

Returns

This action returns a list of values whose elements are, in order:

• integer number of initial layers in which a growth rate of 1.0 and a growth acceleration of 1.0 will be applied
• integer number of layers for which the growth accleration rate will be applied after the initial layers
• float growth acceleration rate
• float initial wall spacing satisfying the initialSpacingFactor input value.  Note that this spacing value will still need to be assigned to the appropriate T-Rex domains as BCs

See Also

calculateTurbulentGrowth, calculateGrowthRateAtLayer, calculateGrowthRateSchedule

pw::Grid calculateTurbulentGrowth reynoldsNumber characteristicLength yPlus

This action computes anisotropic growth parameters for a turbulent boundary layer.  The calculations are based on turbulent boundary layers (Law of the Wall) for a smooth flat plate, as referenced in Boundary Layer Theory, Seventh Edition, Schlichting, H., McGraw-Hill: 1979, p 643.

Parameters

Returns

This action returns a list of values whose elements are, in order:

• integer number of initial layers in which a growth rate of 1.0 and a growth acceleration of 1.0 will be applied
• integer number of layers for which the growth accleration rate will be applied after the initial layers
• float growth acceleration rate
• float initial wall spacing satisfying the yPlus input value.  Note that this spacing value will still need to be assigned to the appropriate T-Rex domains as BCs

See Also

calculateLaminarGrowth, calculateGrowthRateAtLayer, calculateGrowthRateSchedule

pw::Grid calculateGrowthRateAtLayer layer numLinearLayers numAccelerationLayers growthAcceleration defaultGrowthRate

This action computes the growth rate for a given layer in a boundary layer.

Parameters

Returns

This action returns a float representing the growth rate to apply at the given layer.

See Also

pw::BlockUnstructured.TRexGrowthProfile

pw::Grid calculateGrowthRateSchedule numLinearLayers numAccelerationLayers growthAcceleration

This action computes the growth rate schedule from a set of growth parameters, such as those returned by the calculateLaminarGrowth or calculateTurbulentGrowth actions.

Parameters

Returns

This action returns a list of float representing the growth rate to apply at each layer.  The length of the result list is the sum of numLinearLayers and numAccelerationLayers.

See Also

pw::BlockUnstructured.TRexGrowthProfile

pw::Grid get/setGridPointTolerance tolerance

This attribute is the grid point tolerance of grid entities and operations.

Type

float (0, infinity)

Default

0.0000001

pw::Grid get/setNodeTolerance tolerance

This attribute is the node tolerance of grid entities and operations.

Type

float (0, infinity)

Default

0.0001

pw::Grid get/setConnectorTolerance tolerance

This attribute is the connector tolerance of grid entities and operations.

Type

float (0, infinity)

Default

0.0001

pw::Grid get/setImportSplitAngle angle

This attribute is the bending angle at which unstructured domains are split on import.

Type

float [0, 180)

Default

0

pw::Grid get/setImportSplitMultipleEdges split

This attribute is the flag for whether unstructured domains with more than one edge are split on import so that they will only made up of a single edge.

Type

boolean

Default

false

pw::Grid get/setMirrorPlane plane

This attribute is the mirroring plane applied to the grid at export.

Type

plane

Default

none

Information

Setting to an invalid plane value generates a glyph error.

Getting the plane generates a glyph error if the plane is not defined.

Use Use pw::Grid isMirrored to determine if calling getMirrorPlane is allowed.

Example

Code

# plnDef is in the plane in coefficent form {A B C D}
set plnDef [pwu::Plane set {1 0 0} {0 0 0}]

# A glyph error is generated if plnDef is invalid
pw::Grid setMirrorPlane $plnDef

See Also

isMirrored, clearMirrorPlane, getMirrorPlaneEntities