VSP_Geom_API.h

//
// This file is released under the terms of the NASA Open Source Agreement (NOSA)
 
// version 1.3 as detailed in the LICENSE file which accompanies this software.
//
 
// API.h: interface for the Vehicle Class and Vehicle Mgr Singleton.
// J.R Gloudemans
//

 
#if !defined(VSPAPI__INCLUDED_)
#define VSPAPI__INCLUDED_
 
#ifdef SWIG
%feature("autodoc", 1);
%feature("doxygen:ignore:forcpponly", range="end");
%feature("doxygen:ignore:beginPythonOnly", range="end:endPythonOnly", contents="parse");
 
#endif
 
#include "Defines.h"
 
#include "APIErrorMgr.h"
#include "APIUpdateCountMgr.h"
#include "Vec3d.h"
#include "Matrix4d.h"
 
#include <string>
#include <stack>
#include <vector>
 
 
using std::string;
using std::stack;
using std::vector;
 
namespace vsp
{
 
//======================== API Functions ================================//
 
extern void VSPCheckSetup();

 
extern void VSPRenew();
 

 
extern void Update( bool update_managers = true );

 
extern void VSPExit( int error_code );

 
extern void VSPCrash( int crash_type );

 
extern int GetAndResetUpdateCount();
 

 
extern std::string GetVSPVersion();

 
extern int GetVSPVersionMajor();

 
extern int GetVSPVersionMinor();

 
extern int GetVSPVersionChange();

 
extern std::string GetVSPExePath();
 

 
extern bool SetVSPAEROPath( const std::string & path );

 
extern std::string GetVSPAEROPath();

 
extern bool CheckForVSPAERO( const std::string & path );

 
extern bool SetVSPHelpPath( const std::string & path );

 
extern std::string GetVSPHelpPath();

 
extern bool CheckForVSPHelp( const std::string & path );
 
extern void RegisterCFDMeshAnalyses();
 
 
//======================== File I/O ================================//
 
extern void ReadVSPFile( const std::string & file_name );

 
extern void WriteVSPFile( const std::string & file_name, int set = SET_ALL );

 
extern void SetVSP3FileName( const std::string & file_name );

 
extern std::string GetVSPFileName();

 
extern void ClearVSPModel();

 
extern void InsertVSPFile( const std::string & file_name, const std::string & parent_geom_id );
 

 
extern std::string ExportFile( const std::string & file_name, int thick_set, int file_type, int subsFlag = 1, int thin_set = vsp::SET_NONE, bool useMode = false, const string &modeID = "" );

 
extern std::string ImportFile( const std::string & file_name, int file_type, const std::string & parent );
 

 
extern void SetBEMPropID( const string & prop_id );
 
 
//======================== Design Files ================================//

 
extern void ReadApplyDESFile( const std::string & file_name );

 
extern void WriteDESFile( const std::string & file_name );

 
extern void ReadApplyXDDMFile( const std::string & file_name );

 
extern void WriteXDDMFile( const std::string & file_name );

 
extern int GetNumDesignVars();

 
extern void AddDesignVar( const std::string & parm_id, int type );

 
extern void DeleteAllDesignVars();

 
extern std::string GetDesignVar( int index );

 
extern int GetDesignVarType( int index );
 
 
//======================== Computations ================================//
 
extern void SetComputationFileName( int file_type, const std::string & file_name );

 
extern std::string ComputeMassProps( int set, int num_slices, int idir );

 
extern std::string ComputeCompGeom( int set, bool half_mesh, int file_export_types );

 
extern std::string ComputePlaneSlice( int set, int num_slices, const vec3d & norm, bool auto_bnd,
 
                                 double start_bnd = 0, double end_bnd = 0, bool measureduct = false );
 
extern void ComputeDegenGeom( int set, int file_export_types );

 
extern void ComputeCFDMesh( int set, int degenset, int file_export_types );

 
extern void SetCFDMeshVal( int type, double val );

 
extern void SetCFDWakeFlag( const std::string & geom_id, bool flag );

 
extern void DeleteAllCFDSources();

 
extern void AddDefaultSources();

 
extern void AddCFDSource( int type, const std::string & geom_id, int surf_index,
 
                          double l1, double r1, double u1, double w1,
                          double l2 = 0, double r2 = 0, double u2 = 0, double w2 = 0 );

 
extern string GetVSPAERORefWingID();

 
extern string SetVSPAERORefWingID( const std::string & geom_id );
 
 
//======================== Analysis ================================//

 
extern int GetNumAnalysis();

 
extern std::vector<std::string> ListAnalysis();

 
extern std::vector<std::string> GetAnalysisInputNames( const std::string & analysis );

 
extern std::string GetAnalysisDoc( const std::string & analysis );

 
extern std::string GetAnalysisInputDoc( const std::string & analysis, const std::string & name );

 
extern std::string ExecAnalysis( const std::string & analysis );
 

 
extern int GetNumAnalysisInputData( const std::string & analysis, const std::string & name );

 
extern int GetAnalysisInputType( const std::string & analysis, const std::string & name );

 
extern const std::vector< int > & GetIntAnalysisInput( const std::string & analysis, const std::string & name, int index = 0 );

 
extern const std::vector< double > & GetDoubleAnalysisInput( const std::string & analysis, const std::string & name, int index = 0 );

 
extern const std::vector<std::string> & GetStringAnalysisInput( const std::string & analysis, const std::string & name, int index = 0 );

 
extern const std::vector< vec3d > & GetVec3dAnalysisInput( const std::string & analysis, const std::string & name, int index = 0 );
 

 
extern void SetAnalysisInputDefaults( const std::string & analysis );

 
extern void SetIntAnalysisInput( const std::string & analysis, const std::string & name, const std::vector< int > & indata, int index = 0 );

 
extern void SetDoubleAnalysisInput( const std::string & analysis, const std::string & name, const std::vector< double > & indata, int index = 0 );

 
extern void SetStringAnalysisInput( const std::string & analysis, const std::string & name, const std::vector<std::string> & indata, int index = 0 );

 
extern void SetVec3dAnalysisInput( const std::string & analysis, const std::string & name, const std::vector< vec3d > & indata, int index = 0 );
 

 
extern void PrintAnalysisInputs( const std::string & analysis_name );

 
extern void PrintAnalysisDocs( const std::string & analysis_name );
 
//======================== Attributes ================================//

 
extern string SummarizeAttributes();

 
extern string SummarizeAttributesAsTree();

 
extern vector < string > FindAllAttributes();
 
 

 
extern vector < string > FindAttributesByName( const string & search_str );

 
extern string FindAttributeByName( const string & search_str, int index );

 
extern string FindAttributeInCollection( const string & obj_id, const string & search_str, int index );

 
extern vector< string > FindAttributeNamesInCollection(const string & collID );

 
extern vector< string > FindAttributesInCollection(const string & collID );

 
extern vector< string > FindAttributedObjects();

 
extern int GetObjectType(const string & attachID);

 
extern string GetObjectTypeName(const string & attachID);

 
extern string GetObjectName(const string & attachID);
 

 
extern string GetObjectParent( const string & id );

 
extern string GetChildCollection(const string & attachID );

 
extern string GetGeomSetCollection( const int & index );

 
extern string GetAttributeName( const string & attrID );

 
extern string GetAttributeID(const string & collID, const string & attributeName, int index);

 
extern string GetAttributeDoc(const string & attrID);

 
extern int GetAttributeType( const string & attrID );

 
extern string GetAttributeTypeName(const string & attrID);

 
extern vector< int > GetAttributeBoolVal(const string & attrID);

 
extern vector< int > GetAttributeIntVal(const string & attrID);

 
extern vector< double > GetAttributeDoubleVal(const string & attrID);

 
extern vector< string > GetAttributeStringVal(const string & attrID);

 
extern vector< string > GetAttributeParmID(const string & attrID);

 
extern vector < double > GetAttributeParmVal( const string &attrID );

 
extern vector < string > GetAttributeParmName( const string &attrID );

 
extern vector< vec3d > GetAttributeVec3dVal(const string & attrID);

 
extern vector< vector < int > > GetAttributeIntMatrixVal(const string & attrID);

 
extern vector< vector < double > > GetAttributeDoubleMatrixVal(const string & attrID);

 
extern void SetAttributeName( const string & attrID, const string & name );

 
 
extern void SetAttributeDoc( const string & attrID, const string & doc );

 
extern void SetAttributeBool( const string & attrID, bool value );

 
extern void SetAttributeInt( const string & attrID, int value );

 
extern void SetAttributeDouble( const string & attrID, double value );

 
extern void SetAttributeString( const string & attrID, const string & value );

 
extern void SetAttributeParmID( const string & attrID, const string & value );

 
extern void SetAttributeVec3d( const string & attrID, const vector < vec3d > & value );

 
extern void SetAttributeIntMatrix( const string & attrID, const vector < vector < int > > & value );

 
extern void SetAttributeDoubleMatrix( const string & attrID, const vector< vector< double > > & value );

 
extern void DeleteAttribute( const string & attrID );

 
extern string AddAttributeBool( const string & collID, const string & attributeName, bool value );

 
extern string AddAttributeInt( const string & collID, const string & attributeName, int value );

 
extern string AddAttributeDouble( const string & collID, const string & attributeName, double value );

 
extern string AddAttributeString( const string & collID, const string & attributeName, const string & value );

 
extern string AddAttributeParm( const string &collID, const string &attributeName, const string &parmID );

 
extern string AddAttributeVec3d( const string & collID, const string & attributeName, const vector < vec3d > & value );

 
extern string AddAttributeIntMatrix( const string & collID, const string & attributeName, const vector < vector < int > > & value );

 
extern string AddAttributeDoubleMatrix( const string & collID, const string & attributeName, const vector < vector < double > > & value );

 
extern string AddAttributeGroup( const string & collID, const string & attributeName );

 
extern int CopyAttribute( const string & attrID );

 
extern void CutAttribute( const string & attrID );

 
extern vector < string > PasteAttribute( const string & coll_id );
 
//======================== Results ================================//
 
extern std::vector<std::string> GetAllResultsNames();

 
extern std::vector<std::string> GetAllDataNames( const std::string & results_id );

 
extern int GetNumResults( const std::string & name );

 
extern std::string GetResultsName(const std::string & results_id );

 
extern std::string GetResultsSetDoc( const std::string & results_id );
 
extern std::string GetResultsEntryDoc( const std::string & results_id, const std::string & data_name );

 
extern std::string FindResultsID( const std::string & name, int index = 0 );

 
extern std::string FindLatestResultsID( const std::string & name );

 
extern int GetNumData( const std::string & results_id, const std::string & data_name );

 
extern int GetResultsType( const std::string & results_id, const std::string & data_name );

 
extern const std::vector< int > & GetIntResults( const std::string & id, const std::string & name, int index = 0 );

 
extern const std::vector< double > & GetDoubleResults( const std::string & id, const std::string & name, int index = 0 );

 
extern const std::vector< std::vector< double > > & GetDoubleMatResults( const std::string & id, const std:: string & name, int index = 0 );

 
extern const std::vector<std::string> & GetStringResults( const std::string & id, const std::string & name, int index = 0 );

 
extern const std::vector< vec3d > & GetVec3dResults( const std::string & id, const std::string & name, int index = 0 );

 
extern std::string CreateGeomResults( const std::string & geom_id, const std::string & name );

 
extern void DeleteAllResults();

 
extern void DeleteResult( const std::string & id );

 
extern void WriteResultsCSVFile( const std::string & id, const std::string & file_name );

 
extern void PrintResults( const std::string &results_id );

 
extern void PrintResultsDocs( const std::string &results_id );

 
extern void WriteTestResults();
 
//======================== GUI Functions ================================//

 
extern void InitGUI();

 
extern void StartGUI();

 
extern void EnableStopGUIMenuItem();

 
extern void DisableStopGUIMenuItem();

 
extern void StopGUI();

 
extern void PopupMsg( const std::string &msg );

 
extern void UpdateGUI();

 
extern bool IsGUIBuild();

 
extern void Lock( );

 
extern void Unlock( );
 

 
extern bool IsEventLoopRunning( );

 
extern void ScreenGrab( const string & fname, int w, int h, bool transparentBG, bool autocrop = false );

 
extern void SetViewAxis( bool vaxis );

 
extern void SetShowBorders( bool brdr );

 
extern void SetGeomDrawType(const string &geom_id, int type);

 
extern void SetGeomWireColor( const string &geom_id, int r, int g, int b );

 
extern void SetGeomDisplayType(const string &geom_id, int type);

 
extern void SetGeomMaterialName( const string &geom_id, const string &name );

 
extern void AddMaterial( const string &name, const vec3d & ambient, const vec3d & diffuse, const vec3d & specular, const vec3d & emissive, const double & alpha, const double & shininess );

 
extern vector < string > GetMaterialNames();

 
extern void SetBackground( double r, double g, double b );

 
extern void SetAllViews( int view );

 
extern void SetView( int viewport, int view );

 
extern void FitAllViews();

 
extern void ResetViews();

 
extern void SetWindowLayout( int r, int c );

 
extern void SetGUIElementDisable( int e, bool state );

 
extern void SetGUIScreenDisable( int s, bool state );

extern void SetGeomScreenDisable( int s, bool state );
 
 
//======================== Geom Functions ================================//
 
extern std::vector<std::string> GetGeomTypes();

 
extern std::string AddGeom( const std::string & type, const std::string & parent = std::string() );

 
extern void UpdateGeom( const std::string & geom_id );

 
extern void DeleteGeom( const std::string & geom_id );

 
extern void DeleteGeomVec( const std::vector< std::string > & del_vec );

 
extern void CutGeomToClipboard( const std::string & geom_id );

 
extern void CopyGeomToClipboard( const std::string & geom_id );

 
extern std::vector<std::string> PasteGeomClipboard( const std::string & parent = std::string() );

 
extern std::vector<std::string> FindGeoms();

 
extern std::vector<std::string> FindGeomsWithName( const std::string & name );

 
extern std::string FindGeom( const std::string & name, int index );

 
extern void SetGeomName( const std::string & geom_id, const std::string & name );

 
extern std::string GetGeomName( const std::string & geom_id );

 
extern std::vector<std::string> GetGeomParmIDs( const std::string & geom_id );

 
extern std::string GetGeomTypeName( const std::string & geom_id );

 
extern std::string GetParm( const std::string & geom_id, const std::string & name, const std::string & group );

 
extern void SetGeomParent( const std::string& geom_id, const std::string& parent_id );

 
extern std::string GetGeomParent( const std::string& geom_id );

 
extern std::vector< std::string > GetGeomChildren( const std::string& geom_id );

 
extern int GetNumXSecSurfs( const std::string & geom_id );

 
extern int GetNumMainSurfs( const std::string & geom_id );

 
extern int GetTotalNumSurfs( const std::string& geom_id );

 
extern int GetGeomVSPSurfType( const std::string& geom_id, int main_surf_ind = 0 );

 
extern int GetGeomVSPSurfCfdType( const std::string& geom_id, int main_surf_ind = 0 );

 
extern vec3d GetGeomBBoxMax( const std::string& geom_id, int main_surf_ind = 0, bool ref_frame_is_absolute = true );

 
extern vec3d GetGeomBBoxMin( const std::string& geom_id, int main_surf_ind = 0, bool ref_frame_is_absolute = true );
 
 
//======================== SubSurface Functions ================================//
 
extern std::string AddSubSurf( const std::string & geom_id, int type, int surfindex = 0 );

 
extern std::string GetSubSurf( const std::string & geom_id, int index );

 
extern std::vector<std::string> GetSubSurf( const std::string & geom_id, const std::string & name );

 
extern void DeleteSubSurf( const std::string & geom_id, const std::string & sub_id );

 
extern void DeleteSubSurf( const std::string & sub_id );

 
extern void SetSubSurfName(const std::string & geom_id, const std::string & sub_id, const std::string & name);

 
extern void SetSubSurfName( const std::string & sub_id, const std::string & name );

 
extern std::string GetSubSurfName( const std::string & geom_id, const std::string & sub_id );

 
extern std::string GetSubSurfName( const std::string & sub_id );

 
extern int GetSubSurfIndex( const std::string & sub_id );

 
extern std::vector<std::string> GetSubSurfIDVec( const std::string & geom_id );

 
extern std::vector<std::string> GetAllSubSurfIDs();

 
extern int GetNumSubSurf( const std::string & geom_id );

 
extern int GetSubSurfType( const std::string & sub_id );

 
extern std::vector<std::string> GetSubSurfParmIDs( const std::string & sub_id );
 

 
extern int AddFeaStruct( const std::string & geom_id, bool init_skin = true, int surfindex = 0 );

 
extern void SetFeaMeshStructIndex( int struct_index );

 
extern void DeleteFeaStruct( const std::string & geom_id, int fea_struct_ind );

 
extern std::string GetFeaStructID( const std::string & geom_id, int fea_struct_ind );

 
extern int GetFeaStructIndex( const std::string & struct_id );

 
extern std::string GetFeaStructParentGeomID( const std::string & struct_id );

 
extern std::string GetFeaStructName( const std::string & geom_id, int fea_struct_ind );

 
extern void SetFeaStructName( const std::string & geom_id, int fea_struct_ind, const std::string & name );

 
extern std::vector< std::string > GetFeaStructIDVec();

 
extern void SetFeaPartName( const std::string & part_id, const std::string & name );

 
extern std::string AddFeaPart( const std::string & geom_id, int fea_struct_ind, int type );

 
extern void DeleteFeaPart( const std::string & geom_id, int fea_struct_ind, const std::string & part_id );

 
extern std::string GetFeaPartID( const std::string & fea_struct_id, int fea_part_index );

 
extern std::string GetFeaPartName( const std::string & part_id );

 
extern int GetFeaPartType( const std::string & part_id );

 
extern std::vector< std::string > GetFeaPartIDVec( const std::string & fea_struct_id );

 
extern std::vector< std::string > GetFeaSubSurfIDVec( const std::string & fea_struct_id );

 
extern void SetFeaPartPerpendicularSparID( const std::string& part_id, const std::string& perpendicular_spar_id );

 
extern std::string GetFeaPartPerpendicularSparID( const std::string& part_id );

 
extern void SetFeaSubSurfName( const std::string & subsurf_id, const std::string & name );

 
extern std::string GetFeaSubSurfName( const std::string & subsurf_id );

 
extern std::string AddFeaSubSurf( const std::string & geom_id, int fea_struct_ind, int type );

 
extern void DeleteFeaSubSurf( const std::string & geom_id, int fea_struct_ind, const std::string & ss_id );

 
extern int GetFeaSubSurfIndex( const string & ss_id );

 
extern int NumFeaStructures();

 
extern int NumFeaParts( const std::string & fea_struct_id );

 
extern int NumFeaSubSurfs( const std::string & fea_struct_id );

 
extern std::string AddFeaBC( const string & fea_struct_id, int type = -1 );

 
extern void DelFeaBC( const string & fea_struct_id, const std::string &bc_id );

 
extern std::vector< std::string > GetFeaBCIDVec( const string & fea_struct_id );

 
extern int NumFeaBCs( const string & fea_struct_id );

 
extern std::string AddFeaMaterial();

 
extern std::string AddFeaProperty( int property_type = 0 );

 
extern void SetFeaMeshVal( const std::string & geom_id, int fea_struct_ind, int type, double val );

 
extern void SetFeaMeshFileName( const std::string & geom_id, int fea_struct_ind, int file_type, const string & file_name );

 
extern void ComputeFeaMesh( const std::string & geom_id, int fea_struct_ind, int file_type );

 
extern void ComputeFeaMesh( const std::string & struct_id, int file_type );

 
extern void SetXSecAlias( const string & id, const string & alias );

 
extern string GetXSecAlias( const string & id );

 
extern void SetXSecCurveAlias( const string & id, const string & alias );

 
extern string GetXSecCurveAlias( const string & id );

 
extern void CutXSec( const std::string & geom_id, int index );

 
extern void CopyXSec( const std::string & geom_id, int index );

 
extern void PasteXSec( const std::string & geom_id, int index );

 
extern void InsertXSec( const std::string & geom_id, int index, int type );
 
 
//======================== Wing Section Functions ===================//

 
extern void SplitWingXSec( const string & wing_id, int section_index );

 
extern void SetDriverGroup( const std::string & geom_id, int section_index, int driver_0, int driver_1 = -1, int driver_2 = -1 );
 
 
//======================== XSecSurf ================================//
 
extern std::string GetXSecSurf( const std::string & geom_id, int index );

 
extern int GetNumXSec( const std::string & xsec_surf_id );

 
extern std::string GetXSec( const std::string & xsec_surf_id, int xsec_index );

 
extern void ChangeXSecShape( const std::string & xsec_surf_id, int xsec_index, int type );

 
extern void SetXSecSurfGlobalXForm( const std::string & xsec_surf_id, const Matrix4d & mat );

 
extern Matrix4d GetXSecSurfGlobalXForm( const std::string & xsec_surf_id );
 
 
//======================== XSec ================================//
 
extern int GetXSecShape( const std::string& xsec_id );

 
extern double GetXSecWidth( const std::string& xsec_id );

 
extern double GetXSecHeight( const std::string& xsec_id );

 
extern void SetXSecWidthHeight( const std::string& xsec_id, double w, double h );

 
extern void SetXSecWidth( const std::string& xsec_id, double w );

 
extern void SetXSecHeight( const std::string& xsec_id, double h );

 
extern std::vector<std::string> GetXSecParmIDs( const std::string& xsec_id );

 
extern std::string GetXSecParm( const std::string& xsec_id, const std::string& name );

 
extern std::vector<vec3d> ReadFileXSec( const std::string& xsec_id, const std::string& file_name );

 
extern void SetXSecPnts( const std::string& xsec_id, std::vector< vec3d > & pnt_vec );

 
extern vec3d ComputeXSecPnt( const std::string& xsec_id, double fract );

 
extern vec3d ComputeXSecTan( const std::string& xsec_id, double fract );

 
extern void ResetXSecSkinParms( const std::string& xsec_id );

 
extern void SetXSecContinuity( const std::string& xsec_id, int cx );

 
extern void SetXSecTanAngles( const std::string& xsec_id, int side, double top, double right, double bottom, double left );

 
extern void SetXSecTanSlews( const std::string& xsec_id, int side, double top, double right, double bottom, double left );

 
extern void SetXSecTanStrengths( const std::string& xsec_id, int side, double top, double right, double bottom, double left );

 
extern void SetXSecCurvatures( const std::string& xsec_id, int side, double top, double right, double bottom, double left );

 
extern void ReadFileAirfoil( const std::string& xsec_id, const std::string& file_name );

 
extern void SetAirfoilUpperPnts( const std::string& xsec_id, const std::vector< vec3d > & up_pnt_vec );

 
extern void SetAirfoilLowerPnts( const std::string& xsec_id, const std::vector< vec3d > & low_pnt_vec );

 
extern void SetAirfoilPnts( const std::string& xsec_id, const std::vector< vec3d > & up_pnt_vec, const std::vector< vec3d > & low_pnt_vec );

 
extern std::vector<vec3d> GetHersheyBarLiftDist( const int &npts, const double &alpha, const double &Vinf, const double &span, bool full_span_flag = false );

 
extern std::vector<vec3d> GetHersheyBarDragDist( const int &npts, const double &alpha, const double &Vinf, const double &span, bool full_span_flag = false );

 
extern std::vector<vec3d> GetVKTAirfoilPnts( const int &npts, const double &alpha, const double &epsilon, const double &kappa, const double &tau );

 
extern std::vector<double> GetVKTAirfoilCpDist( const double &alpha, const double &epsilon, const double &kappa, const double &tau, const std::vector<vec3d> &xyz_data );

 
extern std::vector<vec3d> GetEllipsoidSurfPnts( const vec3d &center, const vec3d &abc_rad, int u_npts = 20, int w_npts = 20 );

 
extern std::vector<vec3d> GetFeatureLinePnts( const string& geom_id );

 
extern std::vector<double> GetEllipsoidCpDist( const std::vector<vec3d> &surf_pnt_vec, const vec3d &abc_rad, const vec3d &V_inf );
 
extern double IntegrateEllipsoidFlow( const vec3d &abc_rad, const int &abc_index );

 
extern std::vector<vec3d> GetAirfoilUpperPnts( const std::string& xsec_id );

 
extern std::vector<vec3d> GetAirfoilLowerPnts( const std::string& xsec_id );

 
extern std::vector<double> GetUpperCSTCoefs( const std::string& xsec_id );

 
extern std::vector<double> GetLowerCSTCoefs( const std::string& xsec_id );

 
extern int GetUpperCSTDegree( const std::string& xsec_id );

 
extern int GetLowerCSTDegree( const std::string& xsec_id );

 
extern void SetUpperCST( const std::string& xsec_id, int deg, const std::vector<double> &coefs );

 
extern void SetLowerCST( const std::string& xsec_id, int deg, const std::vector<double> &coefs );

 
extern void PromoteCSTUpper( const std::string& xsec_id );

 
extern void PromoteCSTLower( const std::string& xsec_id );

 
extern void DemoteCSTUpper( const std::string& xsec_id );

 
extern void DemoteCSTLower( const std::string& xsec_id );

 
extern void FitAfCST( const std::string & xsec_surf_id, int xsec_index, int deg );
 
//======================== Background3D Functions ======================//

 
extern string AddBackground3D();

 
extern int GetNumBackground3Ds();

 
extern vector < string > GetAllBackground3Ds();

 
extern void ShowAllBackground3Ds();

 
extern void HideAllBackground3Ds();

 
extern void DelAllBackground3Ds();

 
extern void DelBackground3D( const string &id );

 
extern vector < string > GetAllBackground3DRelativePaths();

 
extern vector < string > GetAllBackground3DAbsolutePaths();

 
extern string GetBackground3DRelativePath( const string &id );

 
extern string GetBackground3DAbsolutePath( const string &id );

 
extern void SetBackground3DRelativePath( const string &id, const string &fname );

 
extern void SetBackground3DAbsolutePath( const string &id, const string &fname );
 
 
//======================== RoutingGeom Functions ======================//
 
extern int GetNumRoutingPts( const string &routing_id );

 
extern string AddRoutingPt( const string &routing_id, const string &geom_id, int surf_index );

 
extern string InsertRoutingPt( const string &routing_id, int index, const string &geom_id, int surf_index );

 
extern void DelRoutingPt( const string &routing_id, int index );

 
extern void DelAllRoutingPt( const string &routing_id );

 
extern int MoveRoutingPt( const string &routing_id, int index, int reorder_type );

 
extern string GetRoutingPtID( const string &routing_id, int index );

 
extern vector < string > GetAllRoutingPtIds( const string &routing_id );

 
extern string GetRoutingPtParentID( const string & pt_id );

 
extern void SetRoutingPtParentID( const string & pt_id, const string &parent_id );

 
extern vec3d GetMainRoutingPtCoord( const string &pt_id );

 
extern vec3d GetRoutingPtCoord( const string &routing_id, int index, int symm_index );

 
extern vector < vec3d > GetAllRoutingPtCoords( const string &routing_id, int symm_index );
 
//======================== BOR Functions ======================//
 
extern void ChangeBORXSecShape( const string & bor_id, int type );

 
extern int GetBORXSecShape( const string & bor_id );

 
extern std::vector<vec3d> ReadBORFileXSec( const std::string& bor_id, const std::string& file_name );

 
extern void SetBORXSecPnts( const std::string& bor_id, std::vector< vec3d > & pnt_vec );

 
extern vec3d ComputeBORXSecPnt( const std::string& bor_id, double fract );

 
extern vec3d ComputeBORXSecTan( const std::string& bor_id, double fract );

 
extern void ReadBORFileAirfoil( const std::string& bor_id, const std::string& file_name );

 
extern void SetBORAirfoilUpperPnts( const std::string& bor_id, const std::vector< vec3d > & up_pnt_vec );

 
extern void SetBORAirfoilLowerPnts( const std::string& bor_id, const std::vector< vec3d > & low_pnt_vec );

 
extern void SetBORAirfoilPnts( const std::string& bor_id, const std::vector< vec3d > & up_pnt_vec, const std::vector< vec3d > & low_pnt_vec );

 
extern std::vector<vec3d> GetBORAirfoilUpperPnts( const std::string& bor_id );

 
extern std::vector<vec3d> GetBORAirfoilLowerPnts( const std::string& bor_id );

 
extern std::vector<double> GetBORUpperCSTCoefs( const std::string& bor_id );

 
extern std::vector<double> GetBORLowerCSTCoefs( const std::string& bor_id );

 
extern int GetBORUpperCSTDegree( const std::string& bor_id );

 
extern int GetBORLowerCSTDegree( const std::string& bor_id );

 
extern void SetBORUpperCST( const std::string& bor_id, int deg, const std::vector<double> &coefs );

 
extern void SetBORLowerCST( const std::string& bor_id, int deg, const std::vector<double> &coefs );

 
extern void PromoteBORCSTUpper( const std::string& bor_id );

 
extern void PromoteBORCSTLower( const std::string& bor_id );

 
extern void DemoteBORCSTUpper( const std::string& bor_id );

 
extern void DemoteBORCSTLower( const std::string& bor_id );

 
extern void FitBORAfCST( const std::string & bor_id, int deg );
 
 
//======================== FoilSurf Functions ======================//
 
extern void WriteBezierAirfoil( const std::string & file_name, const std::string & geom_id, const double &foilsurf_u );

 
extern void WriteSeligAirfoil( const std::string & file_name, const std::string & geom_id, const double &foilsurf_u );

 
extern std::vector < vec3d > GetAirfoilCoordinates( const std::string & geom_id, const double &foilsurf_u );
 
 
//======================== Edit Curve XSec Functions ======================//
 
extern void EditXSecInitShape( const std::string & xsec_id );

 
extern void EditXSecConvertTo( const std::string & xsec_id, const int & newtype );

 
extern std::vector < double > GetEditXSecUVec( const std::string& xsec_id );

 
extern std::vector < vec3d > GetEditXSecCtrlVec( const std::string & xsec_id, bool non_dimensional = true );

 
extern void SetEditXSecPnts( const std::string & xsec_id, const std::vector < double > &u_vec, const std::vector < vec3d > &control_pts, const std::vector < double > &r_vec );

 
extern void EditXSecDelPnt( const std::string & xsec_id, const int & indx );

 
extern int EditXSecSplit01( const std::string & xsec_id, const double & u );

 
extern void MoveEditXSecPnt( const std::string & xsec_id, const int & indx, const vec3d & new_pnt );

 
extern void ConvertXSecToEdit( const std::string & geom_id, const int & indx = 0 );

 
extern std::vector < bool > GetEditXSecFixedUVec( const std::string& xsec_id );

 
extern void SetEditXSecFixedUVec( const std::string& xsec_id, std::vector < bool > fixed_u_vec );

 
extern void ReparameterizeEditXSec( const std::string & xsec_id );
 
 
//======================== Sets ================================//
 
extern int GetNumSets();

 
extern void SetSetName( int index, const std::string& name );

 
extern std::string GetSetName( int index );

 
extern std::vector<std::string> GetGeomSetAtIndex( int index );

 
extern std::vector<std::string> GetGeomSet( const std::string & name );

 
extern int GetSetIndex( const std::string & name );

 
extern bool GetSetFlag( const std::string & geom_id, int set_index );

 
extern void SetSetFlag( const std::string & geom_id, int set_index, bool flag );

 
extern void CopyPasteSet( int copyIndex, int pasteIndex );
 
 
//======================== Group Modifications ================================//
 
extern void ScaleSet( int set_index, double scale );

 
extern void RotateSet( int set_index, double x_rot_deg, double y_rot_deg, double z_rot_deg );

 
extern void TranslateSet( int set_index, const vec3d &translation_vec );

 
extern void TransformSet( int set_index, const vec3d &translation_vec, double x_rot_deg, double y_rot_deg, double z_rot_deg, double scale, bool scale_translations_flag );
 
 
//======================== Parm Functions ================================//
 
extern bool ValidParm( const std::string & id );

 
extern double SetParmVal( const std::string & parm_id, double val );

 
extern double SetParmVal( const std::string & geom_id, const std::string & name, const std::string & group, double val );

 
extern double SetParmValLimits( const std::string & parm_id, double val, double lower_limit, double upper_limit );

 
extern double SetParmValUpdate( const std::string & parm_id, double val );

 
extern double SetParmValUpdate( const std::string & geom_id, const std::string & parm_name, const std::string & parm_group_name, double val );

 
extern double GetParmVal( const std::string & parm_id );

 
extern double GetParmVal( const std::string & geom_id, const std::string & name, const std::string & group );

 
extern int GetIntParmVal( const std::string & parm_id );

 
extern bool GetBoolParmVal( const std::string & parm_id );

 
extern void SetParmUpperLimit( const std::string & parm_id, double val );

 
extern double GetParmUpperLimit( const std::string & parm_id );

 
extern void SetParmLowerLimit( const std::string & parm_id, double val );

 
extern double GetParmLowerLimit( const std::string & parm_id );

 
extern int GetParmType( const std::string & parm_id );

 
extern std::string GetParmName( const std::string & parm_id );

 
extern std::string GetParmGroupName( const std::string & parm_id );

 
extern std::string GetParmDisplayGroupName( const std::string & parm_id );

 
extern std::string GetParmContainer( const std::string & parm_id );

 
extern void SetParmDescript( const std::string & parm_id, const std::string & desc );

 
extern std::string GetParmDescript( const std::string & parm_id );

 
extern std::string FindParm( const std::string & parm_container_id, const std::string& parm_name, const std::string& group_name );
 
 
//======================== Parm Container Functions ======================//

 
extern std::vector<std::string> FindContainers();

 
extern std::vector<std::string> FindContainersWithName( const std::string & name );

 
extern std::string FindContainer( const std::string & name, int index );

 
extern std::string GetContainerName( const std::string & parm_container_id );

 
extern std::vector<std::string> FindContainerGroupNames( const std::string & parm_container_id );

 
extern std::vector<std::string> FindContainerParmIDs( const std::string & parm_container_id );

 
extern std::string GetVehicleID();
 
 
//======================== User Parm Functions ======================//
 
extern int GetNumUserParms();

 
extern int GetNumPredefinedUserParms();

 
extern std::vector < std::string > GetAllUserParms();

 
extern std::string GetUserParmContainer();

 
extern string AddUserParm(int type, const string & name, const string & group );

 
extern void DeleteUserParm( const std::string & id );

 
extern void DeleteAllUserParm();
 
 
//======================== Snap To Functions ======================//
 
extern double ComputeMinClearanceDistance( const std::string & geom_id, int set  = SET_ALL, bool useMode = false, const string &modeID = string() );
 // TODO: Validate inc_flag description
 
extern double SnapParm( const std::string & parm_id, double target_min_dist, bool inc_flag, int set = SET_ALL, bool useMode = false, const string &modeID = string() );
 
 
//======================== Variable Preset Functions ======================//

 
extern string AddVarPresetGroup( const std::string &group_name );

 
extern string AddVarPresetSetting( const std::string &group_id, const std::string &setting_name );

 
extern void AddVarPresetParm( const std::string &group_id, const std::string &parm_id );

 
extern void DeleteVarPresetGroup( const std::string &group_id );

 
extern void DeleteVarPresetSetting( const std::string &group_id, const std::string &setting_id );

 
extern void DeleteVarPresetParm( const std::string &group_id, const std::string &parm_id );

 
extern void SetVarPresetParmVal( const std::string &group_id, const std::string &setting_id, const std::string &parm_id, double parm_val );

 
extern double GetVarPresetParmVal( const std::string &group_id, const std::string &setting_id, const std::string &parm_id );

 
extern std::string GetGroupName( const std::string &group_id );

 
extern std::string GetSettingName( const std::string &setting_id );

 
extern void SetGroupName( const std::string &group_id, const std::string &group_name );

 
extern void SetSettingName( const std::string &setting_id, const std::string &setting_name );

 
extern std::vector< std::string > GetVarPresetGroups();

 
extern std::vector< std::string > GetVarPresetSettings( const std::string &group_id );

 
extern std::vector< std::string > GetVarPresetParmIDs( const std::string &group_id );

 
extern std::vector< double > GetVarPresetParmVals( const std::string &setting_id );

 
extern void SetVarPresetParmVals( const std::string &setting_id, const std::vector< double > &parm_vals );

 
extern void SaveVarPresetParmVals( const std::string &group_id, const std::string &setting_id );

 
extern void ApplyVarPresetSetting( const std::string &group_id, const std::string &setting_id );
 
//======================== Mode Functions ======================//

 
extern string CreateAndAddMode( const string & name, int normal_set, int degen_set );

 
extern int GetNumModes();

 
extern vector < string > GetAllModes();

 
extern void DelMode( const string &mid );

 
extern void DelAllModes();

 
extern void ApplyModeSettings( const string &mid );

 
extern void ShowOnlyMode( const string &mid );

 
extern void ModeAddGroupSetting( const string &mid, const string &gid, const string &sid );

 
extern string ModeGetGroup( const string &mid, int indx );

 
extern string ModeGetSetting( const string &mid, int indx );

 
extern vector < string >  ModeGetAllGroups( const string &mid );

 
extern vector < string >  ModeGetAllSettings( const string &mid );

 
extern void RemoveGroupSetting( const string &mid, int indx );

 
extern void RemoveAllGroupSettings( const string &mid );
 
//======================== Parametric Curve Functions ======================//
 
extern void SetPCurve( const std::string & geom_id, const int & pcurveid, const std::vector < double > & tvec,
 
    const std::vector < double > & valvec, const int & newtype );
 
extern void PCurveConvertTo( const std::string & geom_id, const int & pcurveid, const int & newtype );

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

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

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

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

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

 
extern void ApproximateAllPropellerPCurves( const std::string & geom_id );

 
extern void ResetPropellerThicknessCurve( const std::string & geom_id );
 
 
//======================== VSPAERO Functions ======================//
 
extern void AutoGroupVSPAEROControlSurfaces();

 
extern int CreateVSPAEROControlSurfaceGroup();

 
extern void AddAllToVSPAEROControlSurfaceGroup( int CSGroupIndex );

 
extern void RemoveAllFromVSPAEROControlSurfaceGroup( int CSGroupIndex );

 
extern std::vector < std::string > GetActiveCSNameVec( int CSGroupIndex );

 
extern std::vector < std::string > GetCompleteCSNameVec();

 
extern std::vector < std::string > GetAvailableCSNameVec( int CSGroupIndex );

 
extern void SetVSPAEROControlGroupName(const string & name, int CSGroupIndex);

 
extern std::string GetVSPAEROControlGroupName( int CSGroupIndex );

 
extern void AddSelectedToCSGroup( const vector <int> &selected, int CSGroupIndex);

 
extern void RemoveSelectedFromCSGroup( const vector <int> &selected, int CSGroupIndex);

 
extern int GetNumControlSurfaceGroups();
 
 
//================ VSPAERO Actuator Disk and Unsteady Functions ==============//
 
extern std::string FindActuatorDisk( int disk_index );

 
extern int GetNumActuatorDisks();

 
extern std::string FindUnsteadyGroup( int group_index );

 
extern std::string GetUnsteadyGroupName( int group_index );

 
extern std::vector < std::string > GetUnsteadyGroupCompIDs( int group_index );

 
extern std::vector < int > GetUnsteadyGroupSurfIndexes( int group_index );

 
extern int GetNumUnsteadyGroups();

 
extern int GetNumUnsteadyRotorGroups();
 
 
//======================== Parasite Drag Tool Functions ======================//
 
extern void AddExcrescence(const std::string & excresName, const int & excresType, const double & excresVal);

 
extern void DeleteExcrescence(const int & index);

 
extern void UpdateParasiteDrag();

 
extern void WriteAtmosphereCSVFile( const std::string & file_name, const int &atmos_type );

 
extern void CalcAtmosphere( const double & alt, const double & delta_temp, const int & atmos_type,
 
    double & temp, double & pres, double & pres_ratio, double & rho_ratio );
 
extern void WriteBodyFFCSVFile( const std::string & file_name );

 
extern void WriteWingFFCSVFile( const std::string & file_name );
 // TODO: Improve description
 
extern void WriteCfEqnCSVFile( const std::string & file_name );
 // TODO: Improve description
 
extern void WritePartialCfMethodCSVFile( const std::string & file_name );
 
 
//======================== Surface Query Functions ======================//
 
extern vec3d CompPnt01(const std::string &geom_id, const int &surf_indx, const double &u, const double &w);

 
extern vec3d CompNorm01(const std::string &geom_id, const int &surf_indx, const double &u, const double &w);

 
extern vec3d CompTanU01(const std::string &geom_id, const int &surf_indx, const double &u, const double &w);

 
extern vec3d CompTanW01(const std::string &geom_id, const int &surf_indx, const double &u, const double &w);

 
extern void CompCurvature01(const std::string &geom_id, const int &surf_indx, const double &u, const double &w,
                            double &k1_out, double &k2_out, double &ka_out, double &kg_out);

 
extern double ProjPnt01(const std::string &geom_id, const int &surf_indx, const vec3d &pt, double &u_out, double &w_out);

 
extern double ProjPnt01I(const std::string &geom_id, const vec3d &pt, int &surf_indx_out, double &u_out, double &w_out);

 
extern double ProjPnt01Guess(const std::string &geom_id, const int &surf_indx, const vec3d &pt, const double &u0, const double &w0, double &u_out, double &w_out);
 

 
extern double AxisProjPnt01(const std::string &geom_id, const int &surf_indx, const int &iaxis, const vec3d &pt, double &u_out, double &w_out);

 
extern double AxisProjPnt01I(const std::string &geom_id, const int &iaxis, const vec3d &pt, int &surf_indx_out, double &u_out, double &w_out);

 
extern double AxisProjPnt01Guess(const std::string &geom_id, const int &surf_indx, const int &iaxis, const vec3d &pt, const double &u0, const double &w0, double &u_out, double &w_out);

 
extern bool InsideSurf( const std::string &geom_id, const int &surf_indx, const vec3d &pt );
 

 
extern vec3d CompPntRST( const std::string &geom_id, const int &surf_indx, const double &r, const double &s, const double &t );

 
extern double FindRST( const std::string &geom_id, const int &surf_indx, const vec3d &pt, double &r_out, double &s_out, double &t_out );

 
extern double FindRSTGuess( const std::string &geom_id, const int &surf_indx, const vec3d &pt, const double &r0, const double &s0, const double &t0, double &r_out, double &s_out, double &t_out );
 

 
extern void ConvertRSTtoLMN( const std::string &geom_id, const int &surf_indx, const double &r, const double &s, const double &t, double &l_out, double &m_out, double &n_out );

 
extern void ConvertRtoL( const std::string &geom_id, const int &surf_indx, const double &r, double &l_out );

 
extern void ConvertLMNtoRST( const std::string &geom_id, const int &surf_indx, const double &l, const double &m, const double &n, double &r_out, double &s_out, double &t_out );
extern void ConvertLtoR( const std::string &geom_id, const int &surf_indx, const double &l, double &r_out );

 
extern void ConvertUtoEta( const std::string &geom_id, const double &u, double &eta_out );

 
extern void ConvertEtatoU( const std::string &geom_id, const double &eta, double &u_out );
 

 
extern std::vector < vec3d > CompVecPnt01(const std::string &geom_id, const int &surf_indx, const std::vector < double > &u_in_vec, const std::vector < double > &w_in_vec);

 
extern std::vector < vec3d > CompVecNorm01(const std::string &geom_id, const int &surf_indx, const std::vector < double > &us, const std::vector < double > &ws);

 
extern void CompVecCurvature01(const std::string &geom_id, const int &surf_indx, const std::vector < double > &us, const std::vector < double > &ws, std::vector < double > &k1_out_vec, std::vector < double > &k2_out_vec, std::vector < double > &ka_out_vec, std::vector < double > &kg_out_vec);

 
extern void ProjVecPnt01(const std::string &geom_id, const int &surf_indx, const std::vector < vec3d > &pts, std::vector < double > &u_out_vec, std::vector < double > &w_out_vec, std::vector < double > &d_out_vec );

 
extern void ProjVecPnt01Guess(const std::string &geom_id, const int &surf_indx, const std::vector < vec3d > &pts, const std::vector < double > &u0s, const std::vector < double > &w0s, std::vector < double > &u_out_vec, std::vector < double > &w_out_vec, std::vector < double > &d_out_vec );
 

 
extern void AxisProjVecPnt01(const std::string &geom_id, const int &surf_indx, const int &iaxis, const std::vector < vec3d > &pts, std::vector < double > &u_out_vec, std::vector < double > &w_out_vec, std::vector < double > &d_out_vec );

 
extern void AxisProjVecPnt01Guess(const std::string &geom_id, const int &surf_indx, const int &iaxis, const std::vector < vec3d > &pts, const std::vector < double > &u0s, const std::vector < double > &w0s, std::vector < double > &u_out_vec, std::vector < double > &w_out_vec, std::vector < double > &d_out_vec );

 
extern std::vector < bool > VecInsideSurf( const std::string &geom_id, const int &surf_indx, const std::vector < vec3d > &pts );
 

 
extern std::vector < vec3d > CompVecPntRST( const std::string &geom_id, const int &surf_indx, const std::vector < double > &r_in_vec, const std::vector < double > &s_in_vec, const std::vector < double > &t_in_vec );

 
extern void FindRSTVec( const std::string &geom_id, const int &surf_indx, const std::vector < vec3d > &pts, std::vector < double > &r_out_vec, std::vector < double > &s_out_vec, std::vector < double > &t_out_vec, std::vector < double > &d_out_vec );

 
extern void FindRSTVecGuess( const std::string &geom_id, const int &surf_indx, const std::vector < vec3d > &pts, const std::vector < double > &r0s, const std::vector < double > &s0s, const std::vector < double > &t0s, std::vector < double > &r_out_vec, std::vector < double > &s_out_vec, std::vector < double > &t_out_vec, std::vector < double > &d_out_vec );
 

 
extern void ConvertRSTtoLMNVec( const std::string &geom_id, const int &surf_indx, const std::vector < double > &r_vec, const std::vector < double > &s_vec, const std::vector < double > &t_vec,
                                std::vector < double > &l_out_vec, std::vector < double > &m_out_vec, std::vector < double > &n_out_vec );

 
extern void ConvertLMNtoRSTVec( const std::string &geom_id, const int &surf_indx, const std::vector < double > &l_vec, const std::vector < double > &m_vec, const std::vector < double > &n_vec,
                                std::vector < double > &r_out_vec, std::vector < double > &s_out_vec, std::vector < double > &t_out_vec );

 
extern void GetUWTess01(const std::string &geom_id, const int &surf_indx, std::vector < double > &u_out_vec, std::vector < double > &w_out_vec);
 
 
//======================= Measure Functions ============================//
 
extern string AddRuler( const string & startgeomid, int startsurfindx, double startu, double startw,
                        const string & endgeomid, int endsurfindx, double endu, double endw, const string & name );
 
extern std::vector < string > GetAllRulers();

 
extern void DelRuler( const string &id );

 
extern void DeleteAllRulers();
 

 
extern string AddProbe( const string & geomid, int surfindx, double u, double w, const string & name );

 
extern std::vector < string > GetAllProbes();

 
extern void DelProbe( const string &id );

 
extern void DeleteAllProbes();
 
 
//======================= Advanced Link Functions ============================//

 
extern std::vector< std::string > GetAdvLinkNames();

 
extern int GetLinkIndex( const string & name );

 
extern void DelAdvLink( int index );

 
extern void DelAllAdvLinks();

 
extern void AddAdvLink( const string & name );

 
extern void AddAdvLinkInput( int index, const string & parm_id, const string & var_name );

 
extern void AddAdvLinkOutput( int index, const string & parm_id, const string & var_name );

 
extern void DelAdvLinkInput( int index, const string & var_name );

 
extern void DelAdvLinkOutput( int index, const string & var_name );

 
extern std::vector< std::string > GetAdvLinkInputNames( int index );

 
extern std::vector< std::string > GetAdvLinkInputParms( int index );

 
extern std::vector< std::string > GetAdvLinkOutputNames( int index );

 
extern std::vector< std::string > GetAdvLinkOutputParms( int index );

 
extern bool ValidateAdvLinkParms( int index );

 
extern void SetAdvLinkCode( int index, const string & code );

 
extern std::string GetAdvLinkCode( int index );

 
extern void SearchReplaceAdvLinkCode( int index, const string & from, const string & to );

 
extern bool BuildAdvLinkScript( int index );
 
 
}           // End vsp namespace
 
#endif // !defined(VSPAPI__INCLUDED_)