All API enumerations are defined in this group. Click here to return to the main page. More...
enum vsp::ABS_REL_FLAG |
Enum that indicates if positions are relative or absolute.
Enumerator | |
---|---|
ABS | Absolute position |
REL | Relative position |
Definition at line 20 of file APIDefines.h.
Enum used to identify the format of exported airfoil files.
Enumerator | |
---|---|
SELIG_AF_EXPORT | Selig airfoil file format |
BEZIER_AF_EXPORT | Bezier airfoil file format |
Definition at line 28 of file APIDefines.h.
enum vsp::ALIGN_TYPE |
Enum for specifying alignment.
Definition at line 36 of file APIDefines.h.
enum vsp::ANG_UNITS |
Enum for specifying angular units.
Enumerator | |
---|---|
ANG_RAD | Radians |
ANG_DEG | Degrees |
Definition at line 50 of file APIDefines.h.
enum vsp::ANGLE |
Enum for specifying image rotation angles (CW).
Enumerator | |
---|---|
ANG_0 | Zero deg |
ANG_90 | 90 deg |
ANG_180 | 180 deg |
ANG_270 | 270 deg |
NUM_ANG | Number of angle choices |
Definition at line 58 of file APIDefines.h.
enum vsp::ATMOS_TYPE |
Enum that identifies the atmospheric model used in the Parasite Drag tool.
Definition at line 69 of file APIDefines.h.
enum vsp::ATTACH_ROT_TYPE |
Enum that determines parent to child relative rotation axes.
Definition at line 94 of file APIDefines.h.
Enum that identifies the parent to child relative translation coordinate system.
Definition at line 81 of file APIDefines.h.
enum vsp::BOR_MODE |
Enum for Body of Revolution mode control.
Enumerator | |
---|---|
BOR_FLOWTHROUGH | Flowthrough mode (default) |
BOR_UPPER | Upper surface mode |
BOR_LOWER | Lower surface mode |
BOR_NUM_MODES | Number of Body of Revolution modes |
Definition at line 107 of file APIDefines.h.
Enum used to select between maximum camber or ideal lift coefficient inputs.
Enumerator | |
---|---|
MAX_CAMB | Input maximum camber, calculate ideal lift coefficient |
DESIGN_CL | Input ideal lift coefficient, calculate maximum camber |
Definition at line 117 of file APIDefines.h.
enum vsp::CAP_TYPE |
Enum that identifies the end cap types for a geometry (i.e. wing root and tip).
Definition at line 125 of file APIDefines.h.
enum vsp::CF_LAM_EQN |
Enum that identifies the Parasite Drag Tool laminar friction coefficient equation choice.
Enumerator | |
---|---|
CF_LAM_BLASIUS | Blasius laminar Cf equation |
CF_LAM_BLASIUS_W_HEAT | Blasius laminar Cf equation with heat (NOT IMPLEMENTED) |
Definition at line 209 of file APIDefines.h.
enum vsp::CF_TURB_EQN |
Enum that identifies the Parasite Drag Tool turbulent friction coefficient equation choice.
Definition at line 217 of file APIDefines.h.
Enum used to identify each CFD mesh control option (also applicable to FEA Mesh). \sa SetCFDMeshVal(), SetFEAMeshVal()
Definition at line 142 of file APIDefines.h.
Enum used to describe various CFD Mesh export file options. \sa SetComputationFileName(), ComputeCFDMesh()
Definition at line 172 of file APIDefines.h.
Enum that indicates the CFD Mesh source type. \sa AddCFDSource()
Definition at line 189 of file APIDefines.h.
enum vsp::CFD_VIS_TYPE |
Enum that identifies how CFD and FEA meshes are colored.
Enumerator | |
---|---|
TAG | Color mesh by tag value (component, subsurface, part, etc) |
REASON | Color mesh by local edge length reason |
Definition at line 201 of file APIDefines.h.
enum vsp::CHEVRON_TYPE |
Enum for Chevron curve modification types.
Enumerator | |
---|---|
CHEVRON_NONE | No chevron. |
CHEVRON_PARTIAL | One or more chevrons of limited extent. |
CHEVRON_FULL | Full period of chevrons. |
CHEVRON_NUM_TYPES | Number of chevron types. |
Definition at line 244 of file APIDefines.h.
Enum for Chevron W parameter modes.
Enumerator | |
---|---|
CHEVRON_W01_NUM_MODES | Number of chevron W parameter mode types. |
Definition at line 254 of file APIDefines.h.
Enum for Snap To collision error types.
Enumerator | |
---|---|
COLLISION_OK | No Error. |
COLLISION_INTERSECT_NO_SOLUTION | Touching, no solution |
COLLISION_CLEAR_NO_SOLUTION | Not touching, no solution |
Definition at line 263 of file APIDefines.h.
Enum used to identify various export file types.
Enumerator | |
---|---|
NO_FILE_TYPE | No export file type |
Definition at line 272 of file APIDefines.h.
Enum used to identify conformal component trim type.
Enumerator | |
---|---|
U_TRIM | Trim by U coordinate |
L_TRIM | Trim by L coordinate |
ETA_TRIM | Trim by Eta coordinate |
NUM_TRIM_TYPES | Number of conformal component trim types |
Definition at line 304 of file APIDefines.h.
enum vsp::DELIM_TYPE |
Enum used to identify delimiter type.
Enumerator | |
---|---|
DELIM_COMMA | Comma delimiter |
DELIM_USCORE | Underscore delimiter |
DELIM_SPACE | Space delimiter |
DELIM_NONE | No delimiter |
DELIM_NUM_TYPES | Number of delimiter types |
Definition at line 314 of file APIDefines.h.
enum vsp::DEPTH_TYPE |
Enum for 3D background depth location settings.
Enumerator | |
---|---|
DEPTH_FRONT | Set 3D background before model |
DEPTH_REAR | Set 3D background behind model |
DEPTH_FREE | Set 3D background at specified location |
NUM_DEPTH_TYPE | Number of depth types |
Definition at line 325 of file APIDefines.h.
enum vsp::DIMENSION_SET |
Enum for 2D or 3D DXF export options.
Enumerator | |
---|---|
SET_3D | 3D DXF export (default) |
SET_2D | 2D DXF export |
Definition at line 336 of file APIDefines.h.
enum vsp::DIR_INDEX |
Enum used to identify axis of rotation or translation.
Enumerator | |
---|---|
X_DIR | X direction |
Definition at line 344 of file APIDefines.h.
enum vsp::DISPLAY_TYPE |
Enum for selecting the GUI display type for Geoms.
Definition at line 354 of file APIDefines.h.
enum vsp::DRAW_TYPE |
Enum for selecting the GUI draw type for Geoms.
Definition at line 364 of file APIDefines.h.
Enum for identifying which kind of integrated flowpath modeling components is modeled.
Definition at line 375 of file APIDefines.h.
Enum for identifying how integrated flowpath modeling engine is represented.
Definition at line 386 of file APIDefines.h.
Enum for integrated flowpath modeling key points.
Definition at line 405 of file APIDefines.h.
enum vsp::ENGINE_LOC_MODE |
Enum for how integrated flowpath modeling key points are identified.
Enumerator | |
---|---|
ENGINE_LOC_INDEX | Integrated flowpath key point identified by XSec index. |
ENGINE_LOC_U | Integrated flowpath key point identified by U parameter. |
Definition at line 397 of file APIDefines.h.
Enum for identifying how integrated flowpath modeling components are modeled.
Definition at line 416 of file APIDefines.h.
enum vsp::ERROR_CODE |
Enum for OpenVSP API error codes.
Definition at line 429 of file APIDefines.h.
enum vsp::EXCRES_TYPE |
Enum used to indicate Parasite Drag Tool excressence type.
Definition at line 466 of file APIDefines.h.
enum vsp::EXPORT_TYPE |
Enum for OpenVSP export types.
Definition at line 477 of file APIDefines.h.
enum vsp::FEA_BC_MODE |
Enum used to indicate FEA boundary condition constraint type.
Definition at line 518 of file APIDefines.h.
enum vsp::FEA_BC_TYPE |
Enum used to indicate FEA boundary condition definition type.
Definition at line 508 of file APIDefines.h.
Enum used to indicate FEA beam element cross-section type.
Enumerator | |
---|---|
FEA_XSEC_GENERAL | General XSec type |
FEA_XSEC_CIRC | Circle XSec type |
FEA_XSEC_PIPE | Pipe XSec type |
FEA_XSEC_I | I XSec type |
FEA_XSEC_RECT | Rectangle XSec type |
FEA_XSEC_BOX | Box XSec type |
Definition at line 530 of file APIDefines.h.
enum vsp::FEA_EXPORT_TYPE |
Enum for the various FEA Mesh export types.
Definition at line 542 of file APIDefines.h.
enum vsp::FEA_FIX_PT_TYPE |
Enum for FEA fixed point types.
Definition at line 560 of file APIDefines.h.
Enum for FEA material types.
Definition at line 573 of file APIDefines.h.
Enum for FEA material orientation types.
Definition at line 584 of file APIDefines.h.
Enum for FEA Part element types.
Definition at line 604 of file APIDefines.h.
enum vsp::FEA_PART_TYPE |
Enum used to identify the available FEA Part types.
Definition at line 625 of file APIDefines.h.
enum vsp::FEA_RIB_NORMAL |
Enum that defines the type of edge to set the initial position of FEA Ribs and FEA Rib Arrays to.
Definition at line 665 of file APIDefines.h.
Enum for FEA Shell treatment types.
Enumerator | |
---|---|
FEA_KEEP | Keep shell elements |
FEA_DELETE | Delete shell elements |
FEA_NUM_SHELL_TREATMENT_TYPES | Number of FEA subsurface treatment choices |
Definition at line 616 of file APIDefines.h.
enum vsp::FEA_SLICE_TYPE |
Enum for FEA Slice orientation.
Definition at line 641 of file APIDefines.h.
enum vsp::FEA_UNIT_TYPE |
Enum used to identify the FEA Mesh unit system (length, mass).
Definition at line 654 of file APIDefines.h.
enum vsp::FF_B_EQN |
Enum for Parasite Drag Tool form factor equations for body-type components.
Definition at line 675 of file APIDefines.h.
enum vsp::FF_W_EQN |
Enum for Parasite Drag Tool form factor equations for wing-type components.
Definition at line 691 of file APIDefines.h.
Enum for setting the mode ofthe file chooser.
Enumerator | |
---|---|
OPEN | Browse files that already exist |
SAVE | Browse file system and enter file name |
NUM_FILE_CHOOSER_MODES | Number of file chooser modes |
Definition at line 719 of file APIDefines.h.
Enum for file chooser type.
Enumerator | |
---|---|
FC_OPENVSP | OpenVSP's own file chooser with directory preferences. |
FC_NATIVE | Operating system's native file chooser |
NUM_FILE_CHOOSER_TYPES | Number of file chooser types |
Definition at line 728 of file APIDefines.h.
Enum for Parasite Drag Tool freestream unit system.
Enumerator | |
---|---|
PD_UNITS_IMPERIAL | Imperial unit system |
PD_UNITS_METRIC | Metric unit system |
Definition at line 711 of file APIDefines.h.
enum vsp::GDEV |
Enum used for custom GUI development.
Definition at line 737 of file APIDefines.h.
enum vsp::GENDER |
Enum for OpenVSP Human component gender types.
Enumerator | |
---|---|
MALE | Male Human component |
FEMALE | Female Human component |
Definition at line 775 of file APIDefines.h.
enum vsp::GUI_GEOM_SCREEN |
Enum for geom screen types.
Definition at line 783 of file APIDefines.h.
enum vsp::GUI_VSP_SCREEN |
Enum for OpenVSP screen types.
Definition at line 807 of file APIDefines.h.
enum vsp::IMPORT_TYPE |
Enum for OpenVSP import types.
Definition at line 883 of file APIDefines.h.
Initial shape enums for XS_EDIT_CURVE type XSecs.
Enumerator | |
---|---|
EDIT_XSEC_CIRCLE | Circle initialized as cubic Bezier type |
EDIT_XSEC_ELLIPSE | Ellipse initialized as PCHIP type |
EDIT_XSEC_RECTANGLE | Rectangle initialized as linear type |
Definition at line 874 of file APIDefines.h.
Enum for Surface Intersection export file types.
Definition at line 898 of file APIDefines.h.
enum vsp::LEN_UNITS |
Enum that describes units for length.
Enumerator | |
---|---|
LEN_MM | Millimeter |
LEN_CM | Centimeter |
LEN_M | Meter |
LEN_IN | Inch |
LEN_FT | Feet |
LEN_YD | Yard |
LEN_UNITLESS | Unitless |
NUM_LEN_UNIT | Number of length unit types |
Definition at line 910 of file APIDefines.h.
enum vsp::MASS_UNIT |
Enum that describes units for mass.
Enumerator | |
---|---|
MASS_UNIT_G | Gram |
MASS_UNIT_KG | Kilogram |
MASS_UNIT_TONNE | Tonne |
MASS_UNIT_LBM | Pound-mass |
MASS_UNIT_SLUG | Slug |
MASS_LBFSEC2IN | lbf*sec^2/in |
NUM_MASS_UNIT | Number of mass unit types |
Definition at line 924 of file APIDefines.h.
enum vsp::MESH_REASON |
Enum that describes the criteria that set the local minimum edge length.
Definition at line 937 of file APIDefines.h.
enum vsp::PARM_TYPE |
Enum for OpenVSP's various Parm class types.
Definition at line 964 of file APIDefines.h.
enum vsp::PATCH_TYPE |
Enum used to identify patch types for WireGeoms.
Enumerator | |
---|---|
PATCH_NONE | No patch |
PATCH_POINT | Point patch type |
PATCH_LINE | Line patch type |
PATCH_COPY | Copy patch type |
PATCH_HALFWAY | Halfway patch type |
PATCH_NUM_TYPES | Number of patch types |
Definition at line 977 of file APIDefines.h.
enum vsp::PCURV_TYPE |
Enum for parametric curve types.
Definition at line 989 of file APIDefines.h.
enum vsp::PRES_UNITS |
Enum that describes units for pressure.
Definition at line 1000 of file APIDefines.h.
enum vsp::PROJ_BNDY_TYPE |
Enum for Projected Area boundary option type.
Enumerator | |
---|---|
NO_BOUNDARY | No boundary |
SET_BOUNDARY | Set boundary |
GEOM_BOUNDARY | Geom boundary |
NUM_PROJ_BNDY_OPTIONS | Number of projected area boundary options |
Definition at line 1018 of file APIDefines.h.
enum vsp::PROJ_DIR_TYPE |
Enum for Projected Area direction type.
Definition at line 1028 of file APIDefines.h.
enum vsp::PROJ_TGT_TYPE |
Enum for Projected Area target type.
Enumerator | |
---|---|
SET_TARGET | Set target type |
GEOM_TARGET | Geom target type |
NUM_PROJ_TGT_OPTIONS | Number of Projected Area target types |
Definition at line 1040 of file APIDefines.h.
enum vsp::PROP_MODE |
Enum used to specify the mode of a propeller Geom.
Definition at line 1049 of file APIDefines.h.
enum vsp::PROP_PCURVE |
Enum for the various propeller blade curve parameterization options.
Definition at line 1058 of file APIDefines.h.
enum vsp::REF_WING_TYPE |
Enum used to indicate manual or component reference type.
Enumerator | |
---|---|
MANUAL_REF | Manually specify the reference areas and lengths |
COMPONENT_REF | Use a particular wing to calculate the reference area and lengths |
NUM_REF_TYPES | Number of wing reference types |
Definition at line 1085 of file APIDefines.h.
enum vsp::REORDER_TYPE |
Enum used to identify array reordering instructions.
Definition at line 1074 of file APIDefines.h.
enum vsp::RES_DATA_TYPE |
Enum representing the possible data types returned from the ResultsMgr.
Definition at line 1094 of file APIDefines.h.
enum vsp::RES_GEOM_TYPE |
Enum representing the possible Geom types returned from the ResultsMgr.
Definition at line 1106 of file APIDefines.h.
enum vsp::RHO_UNITS |
Enum that describes units for density.
Definition at line 1116 of file APIDefines.h.
enum vsp::SCALE_TYPE |
Enum representing the possible ways to scale a 3D background image.
Definition at line 1130 of file APIDefines.h.
enum vsp::SET_TYPE |
Enum for specifying named set types.
Definition at line 1141 of file APIDefines.h.
Enum that identifies the trimmed STEP export representation type.
Enumerator | |
---|---|
STEP_SHELL | Manifold shell surface STEP file representation |
STEP_BREP | Manifold solid BREP STEP file representation |
Definition at line 1154 of file APIDefines.h.
enum vsp::SUBSURF_INCLUDE |
Enum used to identify Parasite Drag Tool sub-surface treatment.
Definition at line 1162 of file APIDefines.h.
enum vsp::SUBSURF_INOUT |
Enum for indicating which part of the parent surface a sub-surfacce is dedfine.
Enumerator | |
---|---|
INSIDE | The interior of the sub-surface is its surface |
OUTSIDE | The exterior of the sub-surface is its surface |
NONE | No part of the parent surface belongs to the sub-surface |
Definition at line 1171 of file APIDefines.h.
Enum that identifies which surface coordinate is constant for a line sub-surface.
Enumerator | |
---|---|
CONST_U | Constant U sub-surface |
CONST_W | Constant W sub-surface |
Definition at line 1180 of file APIDefines.h.
enum vsp::SUBSURF_TYPE |
Enum for the various sub-surface types.
Definition at line 1188 of file APIDefines.h.
enum vsp::SYM_FLAG |
Enum that represents various symmetry types.
Definition at line 1201 of file APIDefines.h.
enum vsp::SYM_XSEC_TYP |
Enum that represents various cross section symmetry types.
Enumerator | |
---|---|
SYM_NONE | No cross section symmetry. |
SYM_RL | Right/left cross section symmetry. |
SYM_TB | Top/bottom cross section symmetry. |
SYM_ALL | All cross section symmetry. |
Definition at line 1215 of file APIDefines.h.
enum vsp::TEMP_UNITS |
Enum that describes units for temperature.
Enumerator | |
---|---|
TEMP_UNIT_K | Kelvin |
TEMP_UNIT_C | Celsius |
TEMP_UNIT_F | Fahrenheit |
TEMP_UNIT_R | Rankine |
NUM_TEMP_UNIT | Number of temperature unit choices |
Definition at line 1225 of file APIDefines.h.
enum vsp::VEL_UNITS |
Enum that describes units for velocity.
Definition at line 1236 of file APIDefines.h.
enum vsp::VIEW_NUM |
Enum for 2D drawing types (DXF & SVG).
Enumerator | |
---|---|
VIEW_1 | One 2D view |
VIEW_2HOR | Two horizontal 2D views |
VIEW_2VER | Two vertical 2D views |
VIEW_4 | Four 2D views |
Definition at line 1249 of file APIDefines.h.
enum vsp::VIEW_ROT |
Enum for describing 2D view rotations (DXF & SVG).
Enumerator | |
---|---|
ROT_0 | No rotation |
ROT_90 | 90 degree rotation |
ROT_180 | 180 degree rotation |
ROT_270 | 270 degree rotation |
Definition at line 1259 of file APIDefines.h.
enum vsp::VIEW_TYPE |
Enum for describing 2D view types (DXF & SVG).
Definition at line 1269 of file APIDefines.h.
Enum that is used to describe surfaces in CFD Mesh.
Definition at line 1339 of file APIDefines.h.
enum vsp::VSP_SURF_TYPE |
Enum for the different surface types in OpenVSP.
Enumerator | |
---|---|
NORMAL_SURF | Normal VSP surface |
WING_SURF | Wing VSP surface |
DISK_SURF | Disk VSP surface |
NUM_SURF_TYPES | Number of VSP surface types |
Definition at line 1352 of file APIDefines.h.
Enum that definies the VSPAERO analysis method.
Enumerator | |
---|---|
VORTEX_LATTICE | VSPAERO vortex lattice method |
PANEL | VSPAERO panel method |
Definition at line 1283 of file APIDefines.h.
Enum for the VSPAERO stall modeling options (Cl Max VSPAERO input).
Enumerator | |
---|---|
CLMAX_OFF | Stall modeling off (Cl Max = 0) |
CLMAX_2D | 2D Cl Max stall modeling with user defined value |
CLMAX_CARLSON | Carlson's Pressure Correlation |
Definition at line 1330 of file APIDefines.h.
Enums for VSPAERO unsteady noise calculation types.
Definition at line 1291 of file APIDefines.h.
Enums for VSPAERO unsteady noise units.
Definition at line 1300 of file APIDefines.h.
Enum for the types of preconditioner used in VSPAERO.
Enumerator | |
---|---|
PRECON_MATRIX | Matrix preconditioner |
PRECON_JACOBI | Jacobi preconditioner |
PRECON_SSOR | Symmetric successive over-relaxation preconditioner |
Definition at line 1308 of file APIDefines.h.
Enum for the types of VSPAERO stability analyses.
Definition at line 1317 of file APIDefines.h.
enum vsp::W_HINT |
Enum for chevron W parameter start/end hints.
Definition at line 1362 of file APIDefines.h.
enum vsp::WING_BLEND |
Enum used to identify the type of wing blending between XSecs.
Definition at line 1374 of file APIDefines.h.
enum vsp::WING_DRIVERS |
Enum for controlling wing section planform parameter control and linking.
Definition at line 1389 of file APIDefines.h.
Enum that identifies the working XDDM type.
Enumerator | |
---|---|
XDDM_VAR | Variable XDDM type |
XDDM_CONST | Constant XDDM type |
Definition at line 1407 of file APIDefines.h.
enum vsp::XSEC_CLOSE_TYPE |
Enum for modifying XSec through closure types.
Definition at line 1415 of file APIDefines.h.
enum vsp::XSEC_CRV_TYPE |
Enum that identifies the various OpenVSP XSecCurve types.
Definition at line 1427 of file APIDefines.h.
enum vsp::XSEC_DRIVERS |
Enum for XSec drivers.
Enumerator | |
---|---|
HEIGHT_XSEC_DRIVER | Height driver |
HWRATIO_XSEC_DRIVER | Height/width ratio driver |
NUM_XSEC_DRIVER | Number of XSec drivers |
Definition at line 1454 of file APIDefines.h.
enum vsp::XSEC_SIDES_TYPE |
Enum for XSec side types.
Enumerator | |
---|---|
XSEC_BOTH_SIDES | Both sides |
XSEC_LEFT_SIDE | Left side |
XSEC_RIGHT_SIDE | Right side |
Definition at line 1466 of file APIDefines.h.
enum vsp::XSEC_TRIM_TYPE |
Enum used to identify XSec trim type.
Enumerator | |
---|---|
TRIM_NONE | No trimming |
TRIM_X | Trim XSec by X |
TRIM_THICK | Trim XSec by thickness |
TRIM_NUM_TYPES | Number of trimming types |
Definition at line 1475 of file APIDefines.h.
enum vsp::XSEC_TYPE |
Enum for the various XSec types in OpenVSP.
Enumerator | |
---|---|
XSEC_FUSE | Fuselage XSec Geom |
XSEC_STACK | Stack XSec Geom |
XSEC_WING | Wing XSec Geom |
XSEC_CUSTOM | Custom XSec Geom |
XSEC_PROP | Propeller XSec Geom |
XSEC_NUM_TYPES | Number of XSec types |
Definition at line 1485 of file APIDefines.h.
Enum for XSec width shift.
Enumerator | |
---|---|
XS_SHIFT_LE | Shift leading edge |
Definition at line 1497 of file APIDefines.h.