The following group of functions provide API capability for setting up actuator disks (Disk tab of VSPAERO GUI) and propellers (Propeller tab of VSPAERO GUI) for VSPAERO analysis. If a propeller geometry is used to model the actuator disk, the "PropMode" must be set to PROP_DISK or PROP_BOTH. Alternatively, the "PropMode" but be set to PROP_BLADE or PROP_BOTH for unsteady analysis. must be set to PROP_DISK or PROP_BOTH.
Click here to return to the main page.
More...
◆ FindActuatorDisk()
string FindActuatorDisk |
( |
int |
disk_index | ) |
|
Get the ID of a VSPAERO actuator disk at the specified index. An empty string is returned if the index is out of range.
string prop_id =
AddGeom(
"PROP", pod_id );
- See also
- PROP_MODE
- Parameters
-
[in] | disk_index | Actuator disk index for the current VSPAERO set |
- Returns
- Actuator disk ID
◆ FindUnsteadyGroup()
string FindUnsteadyGroup |
( |
int |
group_index | ) |
|
Get the ID of the VSPAERO unsteady group at the specified index. An empty string is returned if the index is out of range.
string prop_id =
AddGeom(
"PROP", pod_id );
- See also
- PROP_MODE
- Parameters
-
[in] | group_index | Unsteady group index for the current VSPAERO set |
- Returns
- Unsteady group ID
◆ GetNumActuatorDisks()
int GetNumActuatorDisks |
( |
| ) |
|
Get the number of actuator disks in the current VSPAERO set. This is equivalent to the number of disk surfaces in the VSPAERO set.
string prop_id =
AddGeom(
"PROP", pod_id );
- See also
- PROP_MODE
- Returns
- Number of actuator disks in the current VSPAERO set
◆ GetNumUnsteadyGroups()
int GetNumUnsteadyGroups |
( |
| ) |
|
Get the number of unsteady groups in the current VSPAERO set. Each propeller is placed in its own unsteady group. All symmetric copies of propellers are also placed in an unsteady group. All other component types are placed in a single fixed component unsteady group.
string prop_id =
AddGeom(
"PROP", pod_id );
- See also
- PROP_MODE
- Returns
- Number of actuator disks in the current VSPAERO set
◆ GetUnsteadyGroupCompIDs()
string [] GetUnsteadyGroupCompIDs |
( |
int |
group_index | ) |
|
Get an array of IDs for all components in the unsteady group at the specified index.
string pod_id =
AddGeom(
"POD",
"" );
string wing_id =
AddGeom(
"WING", pod_id );
SetParmVal( wing_id,
"X_Rel_Location",
"XForm", 2.5 );
if ( comp_ids.size() != 3 )
{
Print(
"ERROR: GetUnsteadyGroupCompIDs" );
}
- See also
- GetUnsteadyGroupSurfIndexes
- Parameters
-
[in] | group_index | Unsteady group index for the current VSPAERO set |
- Returns
- Array of component IDs
◆ GetUnsteadyGroupName()
string GetUnsteadyGroupName |
( |
int |
group_index | ) |
|
Get the name of the unsteady group at the specified index.
string pod_id =
AddGeom(
"POD",
"" );
string wing_id =
AddGeom(
"WING", pod_id );
SetParmVal( wing_id,
"X_Rel_Location",
"XForm", 2.5 );
SetUnsteadyGroupName( 0, "PodAndWingGroup" );
{
Print(
"ERROR: Unsteady Group Name Functions" );
}
- See also
- SetUnsteadyGroupName
- Parameters
-
[in] | group_index | Unsteady group index for the current VSPAERO set |
[in] | name | Name to set the for the unsteady group |
◆ GetUnsteadyGroupSurfIndexes()
int [] GetUnsteadyGroupSurfIndexes |
( |
int |
group_index | ) |
|
Get an array of surface indexes for all components in the unsteady group at the specified index.
string pod_id =
AddGeom(
"POD",
"" );
string wing_id =
AddGeom(
"WING", pod_id );
SetParmVal( wing_id,
"X_Rel_Location",
"XForm", 2.5 );
if ( comp_ids.size() != 3 )
{
Print(
"ERROR: GetUnsteadyGroupSurfIndexes" );
}
- See also
- GetUnsteadyGroupCompIDs
- Parameters
-
[in] | group_index | Unsteady group index for the current VSPAERO set |
- Returns
- Array of surface indexes