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 | vsp::GetNumAnalysis () |
std::vector< std::string > | vsp::ListAnalysis () |
std::vector< std::string > | vsp::GetAnalysisInputNames (const std::string &analysis) |
std::string | vsp::GetAnalysisDoc (const std::string &analysis) |
std::string | vsp::GetAnalysisInputDoc (const std::string &analysis, const std::string &name) |
std::string | vsp::ExecAnalysis (const std::string &analysis) |
int | vsp::GetNumAnalysisInputData (const std::string &analysis, const std::string &name) |
int | vsp::GetAnalysisInputType (const std::string &analysis, const std::string &name) |
const std::vector< int > & | vsp::GetIntAnalysisInput (const std::string &analysis, const std::string &name, int index=0) |
const std::vector< double > & | vsp::GetDoubleAnalysisInput (const std::string &analysis, const std::string &name, int index=0) |
const std::vector< std::string > & | vsp::GetStringAnalysisInput (const std::string &analysis, const std::string &name, int index=0) |
const std::vector< vec3d > & | vsp::GetVec3dAnalysisInput (const std::string &analysis, const std::string &name, int index=0) |
void | vsp::SetAnalysisInputDefaults (const std::string &analysis) |
void | vsp::SetIntAnalysisInput (const std::string &analysis, const std::string &name, const std::vector< int > &indata, int index=0) |
void | vsp::SetDoubleAnalysisInput (const std::string &analysis, const std::string &name, const std::vector< double > &indata, int index=0) |
void | vsp::SetStringAnalysisInput (const std::string &analysis, const std::string &name, const std::vector< std::string > &indata, int index=0) |
void | vsp::SetVec3dAnalysisInput (const std::string &analysis, const std::string &name, const std::vector< vec3d > &indata, int index=0) |
void | vsp::PrintAnalysisInputs (const std::string &analysis_name) |
void | vsp::PrintAnalysisDocs (const std::string &analysis_name) |
std::string vsp::ExecAnalysis | ( | const std::string & | analysis | ) |
Execute an analysis through the Analysis Manager
[in] | analysis | Analysis name |
std::string vsp::GetAnalysisDoc | ( | const std::string & | analysis | ) |
Get the analysis documentation string
[in] | analysis | Analysis name |
std::string vsp::GetAnalysisInputDoc | ( | const std::string & | analysis, |
const std::string & | name | ||
) |
Get the documentation string for the particular analysis and input
[in] | analysis | Analysis name |
[in] | name | Input name |
std::vector<std::string> vsp::GetAnalysisInputNames | ( | const std::string & | analysis | ) |
Get the name of every available input for a particular analysis
[in] | analysis | Analysis name |
int vsp::GetAnalysisInputType | ( | const std::string & | analysis, |
const std::string & | name | ||
) |
Get the data type for a particulat analysis type and input
[in] | analysis | Analysis name |
[in] | name | Input name |
const std::vector< double >& vsp::GetDoubleAnalysisInput | ( | const std::string & | analysis, |
const std::string & | name, | ||
int | index = 0 |
||
) |
Get the current double values for the particular analysis, input, and data index
[in] | analysis | string Analysis name |
[in] | name | string Input name |
[in] | index | int Data index |
const std::vector< int >& vsp::GetIntAnalysisInput | ( | const std::string & | analysis, |
const std::string & | name, | ||
int | index = 0 |
||
) |
Get the current integer values for the particular analysis, input, and data index
[in] | analysis | string Analysis name |
[in] | name | string Input name |
[in] | index | int Data index |
int vsp::GetNumAnalysis | ( | ) |
Get the number of analysis types available in the Analysis Manager
int vsp::GetNumAnalysisInputData | ( | const std::string & | analysis, |
const std::string & | name | ||
) |
Get the documentation string for the particular analysis and input
[in] | analysis | Analysis name |
[in] | name | Input name |
const std::vector<std::string>& vsp::GetStringAnalysisInput | ( | const std::string & | analysis, |
const std::string & | name, | ||
int | index = 0 |
||
) |
Get the current string values for the particular analysis, input, and data index
[in] | analysis | string Analysis name |
[in] | name | string Input name |
[in] | index | int Data index |
const std::vector< vec3d >& vsp::GetVec3dAnalysisInput | ( | const std::string & | analysis, |
const std::string & | name, | ||
int | index = 0 |
||
) |
Get the current vec3d values for the particular analysis, input, and data index
[in] | analysis | string Analysis name |
[in] | name | string Input name |
[in] | index | int Data index |
std::vector<std::string> vsp::ListAnalysis | ( | ) |
Get the name of every available analysis in the Analysis Manager
void vsp::PrintAnalysisDocs | ( | const std::string & | analysis_name | ) |
Print to stdout all current input documentation for a specific analysis
[in] | analysis_name | string Name of analysis |
void vsp::PrintAnalysisInputs | ( | const std::string & | analysis_name | ) |
Print to stdout all current input values for a specific analysis
[in] | analysis_name | string Name of analysis |
void vsp::SetAnalysisInputDefaults | ( | const std::string & | analysis | ) |
Set all input values to their defaults for a specific analysis
[in] | analysis | Analysis name |
void vsp::SetDoubleAnalysisInput | ( | const std::string & | analysis, |
const std::string & | name, | ||
const std::vector< double > & | indata, | ||
int | index = 0 |
||
) |
Set the value of a particular analysis input of double type
[in] | analysis | string Analysis name |
[in] | name | string Input name |
[in] | indata | vector<double> Array of double values to set the input to |
[in] | index | int Data index |
void vsp::SetIntAnalysisInput | ( | const std::string & | analysis, |
const std::string & | name, | ||
const std::vector< int > & | indata, | ||
int | index = 0 |
||
) |
Set the value of a particular analysis input of integer type
[in] | analysis | string Analysis name |
[in] | name | string Input name |
[in] | indata | vector<int> Array of integer values to set the input to |
[in] | index | int Data index |
void vsp::SetStringAnalysisInput | ( | const std::string & | analysis, |
const std::string & | name, | ||
const std::vector< std::string > & | indata, | ||
int | index = 0 |
||
) |
Set the value of a particular analysis input of string type
[in] | analysis | string Analysis name |
[in] | name | string Input name |
[in] | indata | vector<string> Array of string values to set the input to |
[in] | index | int Data index |
void vsp::SetVec3dAnalysisInput | ( | const std::string & | analysis, |
const std::string & | name, | ||
const std::vector< vec3d > & | indata, | ||
int | index = 0 |
||
) |