OpenVSPAPI  3.20.0
Functions
Analysis Manager Functions

This group is for functions included in the Analysis Manager. The Analysis Manager allows for OpenVSP analyses to be setup and run through the API without having to modify Parms directly. Examples are available for every available analysis type. The results of running an analysis can be accessed through the functions defined in the Results group.

Click here to return to the main page. More...

Functions

int GetNumAnalysis ()
 
string[] ListAnalysis ()
 
string[] GetAnalysisInputNames (const string &in analysis)
 
string ExecAnalysis (const string &in analysis)
 
int GetNumAnalysisInputData (const string &in analysis, const string &in name)
 
int GetAnalysisInputType (const string &in analysis, const string &in name)
 
int[] GetIntAnalysisInput (const string &in analysis, const string &in name, int index=0)
 
double[] GetDoubleAnalysisInput (const string &in analysis, const string &in name, int index=0)
 
string[] GetStringAnalysisInput (const string &in analysis, const string &in name, int index=0)
 
vec3d[] GetVec3dAnalysisInput (const string &in analysis, const string &in name, int index=0)
 
void PrintAnalysisInputs (const string &in analysis)
 
void SetAnalysisInputDefaults (const string &in analysis)
 
void SetIntAnalysisInput (const string &in analysis, const string &in name, int[]@ indata_arr, int index=0)
 
void SetDoubleAnalysisInput (const string &in analysis, const string &in name, double[]@ indata_arr, int index=0)
 
void SetStringAnalysisInput (const string &in analysis, const string &in name, string[]@ indata_arr, int index=0)
 
void SetVec3dAnalysisInput (const string &in analysis, const string &in name, vec3d[]@ indata_arr, int index=0)
 

Detailed Description

Function Documentation

◆ ExecAnalysis()

string ExecAnalysis ( const string &in  analysis)

Execute an analysis through the Analysis Manager

string analysis_name = "VSPAEROComputeGeometry";
string res_id = ExecAnalysis( analysis_name );
Parameters
[in]analysisSnalysis name
Returns
Result ID

◆ GetAnalysisInputNames()

string [] GetAnalysisInputNames ( const string &in  analysis)

Get the name of every available input for a particular analysis

string analysis_name = "VSPAEROComputeGeometry";
array<string>@ in_names = GetAnalysisInputNames( analysis_name );
Print("Analysis Inputs: ")
for ( int i = 0; i < in_names.size(); i++)
{
Print( ( "\t" + in_names[i] + "\n" ) );
}
Parameters
[in]analysisSnalysis name
Returns
Array of input names

◆ GetAnalysisInputType()

int GetAnalysisInputType ( const string &in  analysis,
const string &in  name 
)

Get the data type for a particulat analysis type and input

analysis = "VSPAEROComputeGeometry"
array < string > @ inp_array = GetAnalysisInputNames( analysis );
for ( int j = 0; j < int( inp_array.size() ); j++ )
{
int typ = GetAnalysisInputType( analysis, inp_array[j] );
}
See also
RES_DATA_TYPE
Parameters
[in]analysisAnalysis name
[in]nameInput name
Returns
int Data type enum (i.e. DOUBLE_DATA)

◆ GetDoubleAnalysisInput()

double [] GetDoubleAnalysisInput ( const string &in  analysis,
const string &in  name,
int  index = 0 
)

Get the current double values for the particular analysis, input, and data index

array<double> vinfFCinput = GetDoubleAnalysisInput( "ParasiteDrag", "Vinf" );
vinfFCinput[0] = 629;
SetDoubleAnalysisInput( "ParasiteDrag", "Vinf", vinfFCinput );
See also
RES_DATA_TYPE, SetDoubleAnalysisInput
Parameters
[in]analysisAnalysis name
[in]nameInput name
[in]indexData index
Returns
Array of analysis input values

◆ GetIntAnalysisInput()

int [] GetIntAnalysisInput ( const string &in  analysis,
const string &in  name,
int  index = 0 
)

Get the current integer values for the particular analysis, input, and data index

//==== Analysis: VSPAero Compute Geometry ====//
string analysis_name = "VSPAEROComputeGeometry";
// Set to panel method
array< int > analysis_method = GetIntAnalysisInput( analysis_name, "AnalysisMethod" );
analysis_method[0] = ( VSPAERO_ANALYSIS_METHOD::VORTEX_LATTICE );
SetIntAnalysisInput( analysis_name, "AnalysisMethod", analysis_method );
See also
RES_DATA_TYPE, SetIntAnalysisInput
Parameters
[in]analysisAnalysis name
[in]nameInput name
[in]indexData index
Returns
Array of analysis input values

◆ GetNumAnalysis()

int GetNumAnalysis ( )

Get the number of analysis types available in the Analysis Manager

int nanalysis = GetNumAnalysis();
Print( "Number of registered analyses: " + nanalysis );
Returns
Number of analyses

◆ GetNumAnalysisInputData()

int GetNumAnalysisInputData ( const string &in  analysis,
const string &in  name 
)

Get the number of input data for the particular analysis type and input

Parameters
[in]analysisAnalysis name
[in]nameInput name
Returns
Number of input data

◆ GetStringAnalysisInput()

string [] GetStringAnalysisInput ( const string &in  analysis,
const string &in  name,
int  index = 0 
)

Get the current string values for the particular analysis, input, and data index

array<string> fileNameInput = GetStringAnalysisInput( "ParasiteDrag", "FileName" );
fileNameInput[0] = "ParasiteDragExample";
SetStringAnalysisInput( "ParasiteDrag", "FileName", fileNameInput );
See also
RES_DATA_TYPE, SetStringAnalysisInput
Parameters
[in]analysisAnalysis name
[in]nameInput name
[in]indexData index
Returns
Array of analysis input values

◆ GetVec3dAnalysisInput()

vec3d [] GetVec3dAnalysisInput ( const string &in  analysis,
const string &in  name,
int  index = 0 
)

Get the current vec3d values for the particular analysis, input, and data index

// PlanarSlice
array<vec3d> norm = GetVec3dAnalysisInput( "PlanarSlice", "Norm" );
norm[0].set_xyz( 0.23, 0.6, 0.15 );
SetVec3dAnalysisInput( "PlanarSlice", "Norm", norm );
See also
RES_DATA_TYPE, SetVec3dAnalysisInput
Parameters
[in]analysisAnalysis name
[in]nameInput name
[in]indexData index
Returns
Array of analysis input values

◆ ListAnalysis()

string [] ListAnalysis ( )

Get the name of every available analysis in the Analysis Manager

array< string > @analysis_array = ListAnalysis();
Print( "List of Available Analyses: " );
for ( int i = 0; i < int( analysis_array.size() ); i++ )
{
Print( ( "/t" + analysis_array[i] + "/n" ) );
}
Returns
Array of analysis names

◆ PrintAnalysisInputs()

void PrintAnalysisInputs ( const string &in  analysis)

Print to stdout all current input values for a specific analysis

//==== Analysis: VSPAero Compute Geometry ====//
string analysis_name = "VSPAEROComputeGeometry";
// list inputs, type, and current values
PrintAnalysisInputs( analysis_name );
Parameters
[in]analysisAnalysis name

◆ SetAnalysisInputDefaults()

void SetAnalysisInputDefaults ( const string &in  analysis)

Set all input values to their defaults for a specific analysis

//==== Analysis: VSPAero Compute Geometry ====//
string analysis_name = "VSPAEROComputeGeometry";
// Set defaults
SetAnalysisInputDefaults( analysis_name );
Parameters
[in]analysisAnalysis name

◆ SetDoubleAnalysisInput()

void SetDoubleAnalysisInput ( const string &in  analysis,
const string &in  name,
double@[]  indata_arr,
int  index = 0 
)

Set the value of a particular analysis input of double type

//==== Analysis: CpSlicer ====//
string analysis_name = "CpSlicer";
// Setup cuts
ycuts.push_back( 2.0 );
ycuts.push_back( 4.5 );
ycuts.push_back( 8.0 );
SetDoubleAnalysisInput( analysis_name, "YSlicePosVec", ycuts, 0 );
See also
GetDoubleAnalysisInput
Parameters
[in]analysisAnalysis name
[in]nameInput name
[in]indata_arrArray of double values to set the input to
[in]indexData index

◆ SetIntAnalysisInput()

void SetIntAnalysisInput ( const string &in  analysis,
const string &in  name,
int@[]  indata_arr,
int  index = 0 
)

Set the value of a particular analysis input of integer type

//==== Analysis: VSPAero Compute Geometry ====//
string analysis_name = "VSPAEROComputeGeometry";
// Set to panel method
array< int > analysis_method = GetIntAnalysisInput( analysis_name, "AnalysisMethod" );
analysis_method[0] = ( VSPAERO_ANALYSIS_METHOD::VORTEX_LATTICE );
SetIntAnalysisInput( analysis_name, "AnalysisMethod", analysis_method );
See also
GetIntAnalysisInput
Parameters
[in]analysisAnalysis name
[in]nameInput name
[in]indata_arrArray of integer values to set the input to
[in]indexData index

◆ SetStringAnalysisInput()

void SetStringAnalysisInput ( const string &in  analysis,
const string &in  name,
string@[]  indata_arr,
int  index = 0 
)

Set the value of a particular analysis input of string type

array<string> fileNameInput = GetStringAnalysisInput( "ParasiteDrag", "FileName" );
fileNameInput[0] = "ParasiteDragExample";
SetStringAnalysisInput( "ParasiteDrag", "FileName", fileNameInput );
See also
GetStringAnalysisInput
Parameters
[in]analysisAnalysis name
[in]nameInput name
[in]indata_arrArray of string values to set the input to
[in]indexData index

◆ SetVec3dAnalysisInput()

void SetVec3dAnalysisInput ( const string &in  analysis,
const string &in  name,
vec3d@[]  indata_arr,
int  index = 0 
)

Set the value of a particular analysis input of vec3d type

// PlanarSlice
array<vec3d> norm = GetVec3dAnalysisInput( "PlanarSlice", "Norm" );
norm[0].set_xyz( 0.23, 0.6, 0.15 );
SetVec3dAnalysisInput( "PlanarSlice", "Norm", norm );
See also
GetVec3dAnalysisInput
Parameters
[in]analysisAnalysis name
[in]nameInput name
[in]indata_arrArray of vec3d values to set the input to
[in]indexint Data index
GetIntAnalysisInput
int[] GetIntAnalysisInput(const string &in analysis, const string &in name, int index=0)
GetAnalysisInputType
int GetAnalysisInputType(const string &in analysis, const string &in name)
GetStringAnalysisInput
string[] GetStringAnalysisInput(const string &in analysis, const string &in name, int index=0)
ExecAnalysis
string ExecAnalysis(const string &in analysis)
ListAnalysis
string[] ListAnalysis()
GetNumAnalysis
int GetNumAnalysis()
GetDoubleAnalysisInput
double[] GetDoubleAnalysisInput(const string &in analysis, const string &in name, int index=0)
array
AngelScript ScriptExtension for representing the C++ std::vector.
Definition: openvsp_as.h:244
SetDoubleAnalysisInput
void SetDoubleAnalysisInput(const string &in analysis, const string &in name, double[]@ indata_arr, int index=0)
Print
void Print(const string &in data, bool new_line=true)
GetVec3dAnalysisInput
vec3d[] GetVec3dAnalysisInput(const string &in analysis, const string &in name, int index=0)
GetAnalysisInputNames
string[] GetAnalysisInputNames(const string &in analysis)
SetIntAnalysisInput
void SetIntAnalysisInput(const string &in analysis, const string &in name, int[]@ indata_arr, int index=0)
SetAnalysisInputDefaults
void SetAnalysisInputDefaults(const string &in analysis)
SetVec3dAnalysisInput
void SetVec3dAnalysisInput(const string &in analysis, const string &in name, vec3d[]@ indata_arr, int index=0)
VORTEX_LATTICE
Definition: openvsp_as.h:1990
PrintAnalysisInputs
void PrintAnalysisInputs(const string &in analysis)
SetStringAnalysisInput
void SetStringAnalysisInput(const string &in analysis, const string &in name, string[]@ indata_arr, int index=0)