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...

Functions
string	FindActuatorDisk (int disk_index)

string	FindUnsteadyGroup (int group_index)

string	GetUnsteadyGroupName (int group_index)

string []	GetUnsteadyGroupCompIDs (int group_index)

int []	GetUnsteadyGroupSurfIndexes (int group_index)

Detailed Description

Function Documentation

◆ FindActuatorDisk()

string FindActuatorDisk ( int disk_index )

Get the ID of a VSPAERO unsteady group at the specified index. An empty string is returned if the index is out of range.

// Add a propeller
string prop_id = AddGeom( "PROP", pod_id );
SetParmVal( prop_id, "PropMode", "Design", PROP_BLADES );
SetParmVal( prop_id, "Diameter", "Design", 6.0 );
Update();
// Setup the actuator disk VSPAERO parms
string disk_id = FindActuatorDisk( 0 );
SetParmVal( FindParm( disk_id, "RotorRPM", "Rotor" ), 1234.0 );
SetParmVal( FindParm( disk_id, "RotorCT", "Rotor" ), 0.35 );
SetParmVal( FindParm( disk_id, "RotorCP", "Rotor" ), 0.55 );
SetParmVal( FindParm( disk_id, "RotorHubDiameter", "Rotor" ), 1.0 );

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 actuator disk at the specified index. An empty string is returned if the index is out of range.

// Create an actuator disk
string prop_id = AddGeom( "PROP", pod_id );
SetParmVal( prop_id, "PropMode", "Design", PROP_DISK );
Update();
// Setup the unsteady group VSPAERO parms
string disk_id = FindUnsteadyGroup( 1 ); // fixed components are in group 0 (wing & pod)
SetParmVal( FindParm( disk_id, "RPM", "UnsteadyGroup" ), 1234.0 );

See also: PROP_MODE

Parameters

[in] group_index Unsteady group index for the current VSPAERO set

Returns: Unsteady group ID

◆ GetUnsteadyGroupCompIDs()

string [] GetUnsteadyGroupCompIDs ( int group_index )

Get an array of IDs for all components in the unsteady group at the specified index.

// Add a pod and wing
string pod_id = AddGeom( "POD", "" );
string wing_id = AddGeom( "WING", pod_id ); // Default with symmetry on -> 2 surfaces
SetParmVal( wing_id, "X_Rel_Location", "XForm", 2.5 );
Update();
array < string > comp_ids = GetUnsteadyGroupCompIDs( 0 );
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.

// Add a pod and wing
string pod_id = AddGeom( "POD", "" );
string wing_id = AddGeom( "WING", pod_id );
SetParmVal( wing_id, "X_Rel_Location", "XForm", 2.5 );
Update();
 SetUnsteadyGroupName( 0, "PodAndWingGroup" );
if ( GetUnsteadyGroupName( 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.

// Add a pod and wing
string pod_id = AddGeom( "POD", "" );
string wing_id = AddGeom( "WING", pod_id ); // Default with symmetry on -> 2 surfaces
SetParmVal( wing_id, "X_Rel_Location", "XForm", 2.5 );
Update();
array < int > surf_indexes = GetUnsteadyGroupSurfIndexes( 0 );
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