pw:: Overset

Global actions of the application

Derives From

pw::Object

Summary
Global actions of the application
Set the case name for the current overset grid assembler.
Get the case name for the current overset grid assembly.
Validate the current overset grid assembler.
Export files needed by the current overset grid assembler.
Run the current overset grid assembly case using a local or remote grid assembly server.
Return the log from the last overset grid assembly run.
Return the report from the last overset grid assembly run.
Import overset grid assembly results.
Queries a remote overset assembly server about whether it supports the current OGA assembler.

Static Actions

setCaseName

pw::Overset setCaseName name

Set the case name for the current overset grid assembler.

Parameters

nameThis string parameter specifies the OGA case name.

Returns

This action returns nothing.

Example

Code

pw::Overset setCaseName "wing-body"

getCaseName

pw::Overset getCaseName

Get the case name for the current overset grid assembly.

Parameters

None.

Returns

This action returns the current OGA case name as a string.

Example

Code

pw::Overset getCaseName

checkAttributeTree

pw::Overset checkAttributeTree resultsVar

Validate the current overset grid assembler.

Parameters

resultsVarThis required string parameter receives any errors, warnings, or details of the validation check.

Returns

This action returns a list of nodes that failed validation.

export

pw::Overset export ?-path path? ?-clean?

Export files needed by the current overset grid assembler.

Parameters

-path pathThis optional string parameter represents the case directory into which the overset grid assembly files are exported.  If not specified, a path in the current working directory (cwd) is constructed as “/path/to/cwd/ASSEMBLER_ID/CASE_NAME/”.
-cleanThis optional parameter specifies that all files and sub-directories in the case directory should be deleted prior to export.

Returns

This action returns an empty string if successful.  A non-empty string indicates a warning.

Example

Code

set path "/some/path/to/your/case"
puts "Exporting to case dir: '$path'"
set msg [pw::Overset export -path $path -clean]
if { "" != $msg } {
puts " Warning: '[string trim $msg]'"
}

run

pw::Overset run ?-path path? ?-host host -port port ?-clean??

Run the current overset grid assembly case using a local or remote grid assembly server.

Parameters

-path pathThis optional string parameter specifies the case directory that contains the overset grid assembly files.  If not specified, a path in the current working directory (cwd) is constructed as “/path/to/cwd/ASSEMBLER_ID/CASE_NAME/”.
-host hostThis optional string parameter specifies the name of the host machine that is running the remote grid assembly server.  If not specified, assembly is run on the local workstation.
-port portThe integer TCP port number on which the remote grid assembly server is listening.  This parameter is required if -host is used.
-cleanThis optional parameter specifies that all files and sub-directories in remote server’s case directory should be deleted prior to running this overset grid assembly case.  This parameter is only valid when -host is used.  For local runs, the files and sub-directories in the local case directory are always deleted.

Returns

This action returns true if successful.

Example

Code

set path "/some/path/to/your/case"
set host SomeHost
set port 8884
puts "Running case in '$path' on remote server $host:$port (clean)"
if { ![pw::Overset run -path $path -host $host -port $port -clean] } {
puts " FAILED!"
}

puts "Running case in '$path' on local server"
if { ![pw::Overset run -path $path] } {
puts " FAILED!"
}


puts "Running case in default directory on local server"
if { ![pw::Overset run] } {
puts " FAILED!"
}

getAssemblyLog

pw::Overset getAssemblyLog

Return the log from the last overset grid assembly run.

Parameters

None.

Returns

This action returns a string containing the log of the most recent overset grid assembly report.

Example

Code

pw::Overset getAssemblyLog

getAssemblyReport

pw::Overset getAssemblyReport

Return the report from the last overset grid assembly run.

Parameters

None.

Returns

This action returns a string containing the results of the most recent overset grid assembly report.

Example

Code

pw::Overset getAssemblyReport

import

pw::Overset import ?-path path? entities

Import overset grid assembly results.

Parameters

-path pathThis optional string parameter represents the case directory from which the overset grid assembly files are imported.  If not specified, a path in the current working directory (cwd) is constructed as “/path/to/cwd/ASSEMBLER_ID/CASE_NAME/”.
entitiesThis parameter is a list of pw::GridEntity objects.  The imported overset grid assembly data is applied to these entites.  A warning will be returned if imported oga data cannot be found for an entity in this list.

Returns

This action returns an empty string if successful.  A non-empty string indicates a warning.

Example

Code

set path "/some/path/to/your/case"
puts "Importing from case dir '$path' into [list $entities]"
set msg [pw::Overset import -path $path $entities]
if { "$msg" != ""} {
puts " Warning: '[string trim $msg]'"
}

checkAssembler

pw::Overset checkAssembler -host host -port port

Queries a remote overset assembly server about whether it supports the current OGA assembler.

Parameters

-host hostThis required string parameter specifies the name of the host machine that is running the remote grid assembly server.  If not specified, assembly is run on the local workstation.
-port portThis required integer parameter specifies the TCP port number on which the remote grid assembly server is listening.

Returns

Returns true if the server supports the specified overset assembler.

See Also

<pw::Application setOversetAssembler>, <pw::Application getOversetAssembler>

Example

Code

set host  SomeHost
set port 8884
foreach ogaName [pw::Application getOversetAssemblerNames] {
pw::Application setOversetAssembler $ogaName
if { [pw::Overset checkAssembler -host $host -port $port] } {
set res "supported"
} else {
set res "NOT supported"
}
puts "The $ogaName assembler is $res by server on $host:$port."
}
pw::Overset setCaseName name
Set the case name for the current overset grid assembler.
pw::Overset getCaseName
Get the case name for the current overset grid assembly.
pw::Overset checkAttributeTree resultsVar
Validate the current overset grid assembler.
pw::Overset export ?-path path? ?-clean?
Export files needed by the current overset grid assembler.
pw::Overset run ?-path path? ?-host host -port port ?-clean??
Run the current overset grid assembly case using a local or remote grid assembly server.
pw::Overset getAssemblyLog
Return the log from the last overset grid assembly run.
pw::Overset getAssemblyReport
Return the report from the last overset grid assembly run.
pw::Overset import ?-path path? entities
Import overset grid assembly results.
pw::Overset checkAssembler -host host -port port
Queries a remote overset assembly server about whether it supports the current OGA assembler.
Base type for all glyph types
A string is an array of characters.
An integer is a whole number.