OpenVSP API Documentation  3.37.0
Functions
Propeller Blade Curve Functions

The following group of API functions may be used to control parametric propeller blade curves (PCurves). Click here to return to the main page. More...

Functions

void vsp::SetPCurve (const std::string &geom_id, const int &pcurveid, const std::vector< double > &tvec, const std::vector< double > &valvec, const int &newtype)
 
void vsp::PCurveConvertTo (const std::string &geom_id, const int &pcurveid, const int &newtype)
 
int vsp::PCurveGetType (const std::string &geom_id, const int &pcurveid)
 
std::vector< double > vsp::PCurveGetTVec (const std::string &geom_id, const int &pcurveid)
 
std::vector< double > vsp::PCurveGetValVec (const std::string &geom_id, const int &pcurveid)
 
void vsp::PCurveDeletePt (const std::string &geom_id, const int &pcurveid, const int &indx)
 
int vsp::PCurveSplit (const std::string &geom_id, const int &pcurveid, const double &tsplit)
 
void vsp::ApproximateAllPropellerPCurves (const std::string &geom_id)
 
void vsp::ResetPropellerThicknessCurve (const std::string &geom_id)
 

Detailed Description

Function Documentation

◆ ApproximateAllPropellerPCurves()

void vsp::ApproximateAllPropellerPCurves ( const std::string &  geom_id)

Approximate all propeller blade curves with cubic Bezier curves.

// Add Propeller
string prop = AddGeom( "PROP", "" );
std::string AddGeom(const std::string &type, const std::string &parent=std::string())
void ApproximateAllPropellerPCurves(const std::string &geom_id)
Parameters
[in]geom_idstring Geom ID

◆ PCurveConvertTo()

void vsp::PCurveConvertTo ( const std::string &  geom_id,
const int &  pcurveid,
const int &  newtype 
)

Change the type of a propeller blade curve (P Curve)

See also
PCURV_TYPE
Parameters
[in]geom_idstring Parent Geom ID
[in]pcurveidP Curve index
[in]newtypeCurve type enum (i.e. CEDIT)

◆ PCurveDeletePt()

void vsp::PCurveDeletePt ( const std::string &  geom_id,
const int &  pcurveid,
const int &  indx 
)

Delete a propeller blade curve (P Curve) point

Parameters
[in]geom_idstring Parent Geom ID
[in]pcurveidP Curve index
[in]indxPoint index

◆ PCurveGetTVec()

std::vector< double > vsp::PCurveGetTVec ( const std::string &  geom_id,
const int &  pcurveid 
)

Get the parameters of a propeller blade curve (P Curve). Each parameter is a fraction of propeller radius.

Parameters
[in]geom_idstring Parent Geom ID
[in]pcurveidP Curve index
Returns
Array of parameters

◆ PCurveGetType()

int vsp::PCurveGetType ( const std::string &  geom_id,
const int &  pcurveid 
)

Get the type of a propeller blade curve (P Curve)

See also
PCURV_TYPE
Parameters
[in]geom_idstring Parent Geom ID
[in]pcurveidP Curve index
Returns
Curve type enum (i.e. CEDIT)

◆ PCurveGetValVec()

std::vector< double > vsp::PCurveGetValVec ( const std::string &  geom_id,
const int &  pcurveid 
)

Get the values of a propeller blade curve (P Curve). What the values represent id dependent on the curve type (i.e. twist, chord, etc.).

Parameters
[in]geom_idstring Parent Geom ID
[in]pcurveidP Curve index
Returns
Array of values

◆ PCurveSplit()

int vsp::PCurveSplit ( const std::string &  geom_id,
const int &  pcurveid,
const double &  tsplit 
)

Split a propeller blade curve (P Curve) at the specified 1D parameter

Parameters
[in]geom_idstring Parent Geom ID
[in]pcurveidP Curve index
[in]tsplit1D parameter split location
Returns
Index of new control point

◆ ResetPropellerThicknessCurve()

void vsp::ResetPropellerThicknessCurve ( const std::string &  geom_id)

Reset propeller T/C curve to match basic thickness of file-type airfoils. Typically only used for a propeller that has been constructed with file-type airfoils across the blade. The new thickness curve will be a PCHIP curve with t/c matching the propeller's XSecs – unless it is a file XSec, then the Base thickness is used.

// Add Propeller
string prop = AddGeom( "PROP", "" );
void ResetPropellerThicknessCurve(const std::string &geom_id)
Parameters
[in]geom_idstring Geom ID

◆ SetPCurve()

void vsp::SetPCurve ( const std::string &  geom_id,
const int &  pcurveid,
const std::vector< double > &  tvec,
const std::vector< double > &  valvec,
const int &  newtype 
)

Set the parameters, values, and curve type of a propeller blade curve (P Curve)

See also
PCURV_TYPE
Parameters
[in]geom_idstring Parent Geom ID
[in]pcurveidP Curve index
[in]tvecArray of parameter values
[in]valvecArray of values
[in]newtypeCurve type enum (i.e. CEDIT)