pw:: CaeExporter

Example: Code example showing a minimal usage of a CaeExport IOMode.

Code

# This sample assumes:
#
#   * A grid file is loaded and is ready for CAE export.
#   * The solver is set to CGNS.
#   * $ents is the list of blocks to export
#
# This CaeExport IOMode code is equivalent to:
#
#   pw::Application export -precision Double $ents "C:\test.cgns"
#


# Create the CaeExport mode
set status abort
set caex [pw::Application begin CaeExport $ents]
if { $caex && [$caex initialize "C:\test.cgns"] } {
    $caex setAttribute FilePrecision Double
    if { [$caex verify] && [$caex canWrite] && [$caex write] } {
        set status end
    }
}
# abort/end the mode
$caex $status

Output

Example

Code

# This sample assumes:
#    * A grid file is loaded and is ready for CAE export.


# Capture the folder in which this script is located and append the
# "export" subfolder.
set scriptDir [file normalize [file dirname [info script]]]
set exportDir [file join $scriptDir "export"]

puts "Current solver: [set curSolver [pw::Application getCAESolver]]"

set validExts [pw::Application getCAESolverAttribute FileExtensions]
puts "Valid file extensions: '$validExts'"
# Capture first file extension. Use it below to build filename.
set defExt [lindex $validExts 0]

# Select entities appropriate for dimension.
if { 3 == [pw::Application getCAESolverDimension] } {
    set ents [pw::Entity sort [pw::Grid getAll -type pw::Block]]
} else {
    set ents [pw::Entity sort [pw::Grid getAll -type pw::Domain]]
}

# Create the CaeExport mode
set caex [pw::Application begin CaeExport $ents]
puts "$caex is a '[$caex getType]'"
puts "Exporting entities: $ents"

# Build an export destination suitable for the current solver. Use
# the script folder as the root output location.
set destType [pw::Application getCAESolverAttribute FileDestination]
switch $destType {
    Filename { set dest [file join $exportDir "sample.$defExt"] }
    Basename { set dest [file join $exportDir "samplebase"] }
    Folder   -
    default  { set dest $exportDir }
}
puts "Exporting to $destType: '$dest'"

# Initialize the CaeExport mode
puts "initialize"
if { [set status [$caex initialize $dest]] } {
    # Query CaeExport mode for each attribute definition and value
    puts "getAttributeCount = '[$caex getAttributeCount]'"
    set attrNameList [$caex getAttributeNames]
    foreach attrName $attrNameList {
        set attrDefn [$caex getAttributeDefinition $attrName]
        puts "attr: [lindex $attrDefn 0]='[$caex getAttribute $attrName]' => [lrange $attrDefn 1 end]"
    }
    # If the CaeExport mode supports it, set the FileUnits attribute
    if { -1 != [lsearch $attrNameList "FileUnits"] } {
        puts "setAttribute FileUnits Inches"
        $caex setAttribute FileUnits Inches
    }
    # If the CaeExport mode supports it, set the FilePrecision
    # attribute
    if { -1 != [lsearch $attrNameList "FilePrecision"] } {
        puts "setAttribute FilePrecision Double"
        $caex setAttribute FilePrecision Double
    }

    # Verify that the CaeExport mode is ready for exporting
    puts "verify"
    if { [set status [$caex verify]] } {
        # See if CaeExport mode has anything to export
        puts "canWrite"
        if { [set status [$caex canWrite]] } {
            # Tell CaeExport mode to write export data to disk.
            puts "write"
            set status [$caex write]
        }
    }
}
if { $status } {
    # Display exported entity count information
    puts "export counts: [$caex getForeignEntityCounts]"
} else {
    puts "EXPORT FAILED!"
}
# Display any errors/warnings
if { [set errCnt [$caex getErrorCount]] > 0 } {
    set ndx 1
    while { $ndx <= $errCnt } {
        puts "[$caex getErrorCode $ndx]: '[$caex getErrorInformation $ndx]'"
        incr ndx
    }
}
# end the CaeExport mode
$caex end

Output

Current solver: CGNS
Valid file extensions: 'cgns'
::pw::CaeExporter_1 is a 'pw::CaeExporter'
Exporting entities: ::pw::BlockStructured_1 ::pw::BlockStructured_2 ::pw::BlockStructured_3
Exporting to Filename: 'C:/cae-export/sample.cgns'
initialize
getAttributeCount = '2'
attr: GridStructuredAsUnstructured='false' => boolean {Treat structured blocks as unstructured flag}
attr: FilePrecision='Single' => string {Floating-point precision} Single|Double
setAttribute FilePrecision Double
verify
canWrite
write
export counts: {Structured 3D Zones} 3