Global actions of the application
pw:: | Global actions of the application |
Static Actions | |
setCaseName | Set the case name for the current overset grid assembler. |
getCaseName | Get the case name for the current overset grid assembly. |
setAdaptTargets | Set the adaptation targets for the current overset grid assembler. |
getAdaptTargets | Get the adaptation targets for the current overset grid assembly. |
checkAttributeTree | Validate the current overset grid assembler. |
export | Export files needed by the current overset grid assembler. |
run | Run the current overset grid assembly case using a local or remote grid assembly server. |
getAssemblyLog | Return the log from the last overset grid assembly run. |
getAssemblyReport | Return the report from the last overset grid assembly run. |
import | Import overset grid assembly results. |
checkAssembler | Queries a remote overset assembly server about whether it supports the current OGA assembler. |
pw::Overset setCaseName name
Set the case name for the current overset grid assembler.
name | This string parameter specifies the OGA case name. |
This action returns nothing.
Code
pw::Overset setCaseName "wing-body"
pw::Overset getCaseName
Get the case name for the current overset grid assembly.
None.
This action returns the current OGA case name as a string.
Code
pw::Overset getCaseName
pw::Overset setAdaptTargets overset_object_types
Set the adaptation targets for the current overset grid assembler.
overset_object_types | This string parameter controls the creation of pw::SourcePointCloud entities from the listed overset object types. Valid types are: fringe, hole, orphan. |
This action returns nothing.
Code
pw::Overset setAdaptTargets "fringe orphan"
pw::Overset checkAttributeTree resultsVar
Validate the current overset grid assembler.
resultsVar | This required string parameter receives any errors, warnings, or details of the validation check. |
This action returns a list of nodes that failed validation.
pw::Overset export ?-path path? ?-clean?
Export files needed by the current overset grid assembler.
-path path | This 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/”. |
-clean | This optional parameter specifies that all files and sub-directories in the case directory should be deleted prior to export. |
This action returns an empty string if successful. A non-empty string indicates a warning.
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]'" }
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.
-path path | This 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 host | This 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 port | The integer TCP port number on which the remote grid assembly server is listening. This parameter is required if -host is used. |
-clean | This 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. |
This action returns true if successful.
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!" }
pw::Overset getAssemblyLog
Return the log from the last overset grid assembly run.
None.
This action returns a string containing the log of the most recent overset grid assembly report.
Code
pw::Overset getAssemblyLog
pw::Overset getAssemblyReport
Return the report from the last overset grid assembly run.
None.
This action returns a string containing the results of the most recent overset grid assembly report.
Code
pw::Overset getAssemblyReport
pw::Overset import ?-path path? ?entities?
Import overset grid assembly results.
-path path | This 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/”. |
entities | This 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. If not specified, all entities are imported. |
This action returns an empty string if successful. A non-empty string indicates a warning.
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]'" }
pw::Overset checkAssembler -host host -port port
Queries a remote overset assembly server about whether it supports the current OGA assembler.
-host host | This 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 port | This required integer parameter specifies the TCP port number on which the remote grid assembly server is listening. |
Returns true if the server supports the specified overset assembler.
pw::Application.setOversetAssembler, pw::Application.getOversetAssembler
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." }
Set the case name for the current overset grid assembler.
pw::Overset setCaseName name
Get the case name for the current overset grid assembly.
pw::Overset getCaseName
Set the adaptation targets for the current overset grid assembler.
pw::Overset setAdaptTargets overset_object_types
Get the adaptation targets for the current overset grid assembly.
pw::Overset getAdaptTargets
Validate the current overset grid assembler.
pw::Overset checkAttributeTree resultsVar
Export files needed by the current overset grid assembler.
pw::Overset export ?-path path? ?-clean?
Run the current overset grid assembly case using a local or remote grid assembly server.
pw::Overset run ?-path path? ?-host host -port port ?-clean??
Return the log from the last overset grid assembly run.
pw::Overset getAssemblyLog
Return the report from the last overset grid assembly run.
pw::Overset getAssemblyReport
Import overset grid assembly results.
pw::Overset import ?-path path? ?entities?
Queries a remote overset assembly server about whether it supports the current OGA assembler.
pw::Overset checkAssembler -host host -port port
This action sets the current overset assembler.
pw::Application setOversetAssembler name
This action gets the name of the current overset assembler.
pw::Application getOversetAssembler