OpenVSP API Documentation  3.37.0
Functions
Design File Functions

This group of functions is available for managing Design Variables through the API. Click here to return to the main page. More...

Functions

void vsp::ReadApplyDESFile (const std::string &file_name)
 
void vsp::WriteDESFile (const std::string &file_name)
 
void vsp::ReadApplyXDDMFile (const std::string &file_name)
 
void vsp::WriteXDDMFile (const std::string &file_name)
 
int vsp::GetNumDesignVars ()
 
void vsp::AddDesignVar (const std::string &parm_id, int type)
 
void vsp::DeleteAllDesignVars ()
 
std::string vsp::GetDesignVar (int index)
 
int vsp::GetDesignVarType (int index)
 

Detailed Description

Function Documentation

◆ AddDesignVar()

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

Add a design variable

See also
XDDM_QUANTITY_TYPE
Parameters
[in]parm_idstring Parm ID
[in]typeXDDM type enum (XDDM_VAR or XDDM_CONST)

◆ DeleteAllDesignVars()

void vsp::DeleteAllDesignVars ( )

Delete all design variables

◆ GetDesignVar()

std::string vsp::GetDesignVar ( int  index)

Get the Parm ID of the specified design variable

Parameters
[in]indexIndex of design variable
Returns
Parm ID

◆ GetDesignVarType()

int vsp::GetDesignVarType ( int  index)

Get the XDDM type of the specified design variable

See also
XDDM_QUANTITY_TYPE
Parameters
[in]indexIndex of design variable
Returns
XDDM type enum (XDDM_VAR or XDDM_CONST)

◆ GetNumDesignVars()

int vsp::GetNumDesignVars ( )

Get the number of design variables

Returns
int Number of design variables

◆ ReadApplyDESFile()

void vsp::ReadApplyDESFile ( const std::string &  file_name)

Read in and apply a design file (*.des) to the current OpenVSP project

Parameters
[in]file_name*.des input file

◆ ReadApplyXDDMFile()

void vsp::ReadApplyXDDMFile ( const std::string &  file_name)

Read in and apply a Cart3D XDDM file (*.xddm) to the current OpenVSP project

Parameters
[in]file_name*.xddm input file

◆ WriteDESFile()

void vsp::WriteDESFile ( const std::string &  file_name)

Write all design variables to a design file (*.des)

Parameters
[in]file_name*.des output file

◆ WriteXDDMFile()

void vsp::WriteXDDMFile ( const std::string &  file_name)

Write all design variables to a Cart3D XDDM file (*.xddm)

Parameters
[in]file_name*.xddm output file