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::AddDesignVarLimits (const std::string &parm_id, int type, double lowerlimit, double upperlimit)
void	vsp::DeleteAllDesignVars ()
std::string	vsp::GetDesignVar (int index)
int	vsp::GetDesignVarType (int index)
int	vsp::GetDesignVarTypeByID (const std::string &parm_id)
void	vsp::DeleteDesignVar (const std::string &parm_id)
std::vector< std::string >	vsp::GetDesignVarVec ()

Detailed Description

Function Documentation

AddDesignVar()

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

extern

Add a design variable

string pid = AddGeom( "POD" );
 
Update();
 
string len = GetParm( pid, "Length", "Design" );
 
AddDesignVar( len, XDDM_VAR );
 
if ( GetNumDesignVars() != 1 )                       { Print( "ERROR: AddDesignVar" ); __failure++; }

See also

XDDM_QUANTITY_TYPE

Parameters

[in]	parm_id	string Parm ID
[in]	type	int XDDM type enum (XDDM_VAR or XDDM_CONST)

Here is the call graph for this function:

Here is the caller graph for this function:

AddDesignVarLimits()

void vsp::AddDesignVarLimits ( const std::string & parm_id, int type, double lowerlimit, double upperlimit )

extern

Add a design variable

See also

XDDM_QUANTITY_TYPE

Parameters

[in]	parm_id	string Parm ID
[in]	type	int XDDM type enum (XDDM_VAR or XDDM_CONST)
[in]	lowerlimit	double Variable lower limit
[in]	upperlimit	double Variable upper limit

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteAllDesignVars()

void vsp::DeleteAllDesignVars ( )

extern

Delete all design variables

string pid = AddGeom( "POD" );
 
Update();
 
string len = GetParm( pid, "Length", "Design" );
 
AddDesignVar( len, XDDM_VAR );
 
DeleteAllDesignVars();
 
if ( GetNumDesignVars() != 0 )                       { Print( "ERROR: DeleteAllDesignVars" ); __failure++; }

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteDesignVar()

void vsp::DeleteDesignVar ( const std::string & parm_id )

extern

Delete a design variable, by its Parm ID.

string pod_id = AddGeom( "POD" );
 
string length_id = FindParm( pod_id, "Length", "Design" );
 
AddDesignVar( length_id, XDDM_CONST );
 
DeleteDesignVar( length_id );
 
if ( GetNumDesignVars() != 0 )
{
    Print( "ERROR: DeleteDesignVar did not delete the variable" );
    __failure++;
}

See also

AddDesignVar, DeleteAllDesignVars

Parameters

[in]

parm_id

string Parm ID of the design variable

Here is the call graph for this function:

Here is the caller graph for this function:

GetDesignVar()

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

extern

Get the Parm ID of the specified design variable

string pid = AddGeom( "POD" );
 
Update();
 
string len = GetParm( pid, "Length", "Design" );
 
AddDesignVar( len, XDDM_VAR );
 
if ( GetDesignVar( 0 ) != len )                      { Print( "ERROR: GetDesignVar" ); __failure++; }

Parameters

[in]

index

int Index of design variable

Returns

string Parm ID

Here is the call graph for this function:

Here is the caller graph for this function:

GetDesignVarType()

int vsp::GetDesignVarType ( int index )

extern

Get the XDDM type of the specified design variable

string pid = AddGeom( "POD" );
 
Update();
 
string len = GetParm( pid, "Length", "Design" );
 
AddDesignVar( len, XDDM_VAR );
 
if ( GetDesignVarType( 0 ) != XDDM_VAR )             { Print( "ERROR: GetDesignVarType" ); __failure++; }

See also

XDDM_QUANTITY_TYPE, GetDesignVarTypeByID

Parameters

[in]

index

int Index of design variable

Returns

int XDDM type enum (XDDM_VAR or XDDM_CONST)

Here is the call graph for this function:

Here is the caller graph for this function:

GetDesignVarTypeByID()

int vsp::GetDesignVarTypeByID ( const std::string & parm_id )

extern

Get the XDDM type of a design variable, by its Parm ID.

string pod_id = AddGeom( "POD" );
 
string length_id = FindParm( pod_id, "Length", "Design" );
 
AddDesignVar( length_id, XDDM_CONST );
 
if ( GetDesignVarTypeByID( length_id ) != XDDM_CONST )
{
    Print( "ERROR: GetDesignVarTypeByID did not return the type" );
    __failure++;
}

See also

XDDM_QUANTITY_TYPE, GetDesignVarType

Parameters

[in]

parm_id

string Parm ID of the design variable

Returns

int XDDM type enum (i.e. XDDM_VAR)

Here is the call graph for this function:

Here is the caller graph for this function:

GetDesignVarVec()

std::vector< std::string > vsp::GetDesignVarVec ( )

extern

Get the Parm IDs of the design variables, in the order of their indexes.

string pod_id = AddGeom( "POD" );
 
string length_id = FindParm( pod_id, "Length", "Design" );
 
AddDesignVar( length_id, XDDM_CONST );
 
array< string > @ids = GetDesignVarVec();
 
if ( ids.size() != 1 || ids[0] != length_id )
{
    Print( "ERROR: GetDesignVarVec did not return the variable" );
    __failure++;
}

See also

GetDesignVar, GetNumDesignVars

Returns

array<string> Array of Parm IDs

Here is the call graph for this function:

Here is the caller graph for this function:

GetNumDesignVars()

int vsp::GetNumDesignVars ( )

extern

Get the number of design variables

string pid = AddGeom( "POD" );
 
Update();
 
string len = GetParm( pid, "Length", "Design" );
 
AddDesignVar( len, XDDM_VAR );
 
if ( GetNumDesignVars() != 1 )                       { Print( "ERROR: GetNumDesignVars" ); __failure++; }

Returns

int Number of design variables

Here is the call graph for this function:

Here is the caller graph for this function:

ReadApplyDESFile()

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

extern

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

string pid = AddGeom( "POD" );
 
Update();
 
string len = GetParm( pid, "Length", "Design" );
 
AddDesignVar( len, XDDM_VAR );
 
WriteDESFile( "TestDesignVars.des" );
 
ReadApplyDESFile( "TestDesignVars.des" );

Parameters

[in]

file_name

string \*.des input file

Here is the call graph for this function:

Here is the caller graph for this function:

ReadApplyXDDMFile()

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

extern

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

string pid = AddGeom( "POD" );
 
Update();
 
string len = GetParm( pid, "Length", "Design" );
 
AddDesignVar( len, XDDM_VAR );
 
WriteXDDMFile( "TestDesignVars.xddm" );
 
ReadApplyXDDMFile( "TestDesignVars.xddm" );

Parameters

[in]

file_name

string \*.xddm input file

Here is the call graph for this function:

Here is the caller graph for this function:

WriteDESFile()

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

extern

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

string pid = AddGeom( "POD" );
 
Update();
 
string len = GetParm( pid, "Length", "Design" );
 
AddDesignVar( len, XDDM_VAR );
 
WriteDESFile( "TestDesignVars.des" );

Parameters

[in]

file_name

string \*.des output file

Here is the call graph for this function:

Here is the caller graph for this function:

WriteXDDMFile()

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

extern

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

string pid = AddGeom( "POD" );
 
Update();
 
string len = GetParm( pid, "Length", "Design" );
 
AddDesignVar( len, XDDM_VAR );
 
WriteXDDMFile( "TestDesignVars.xddm" );

Parameters

[in]

file_name

string \*.xddm output file

Here is the call graph for this function:

Here is the caller graph for this function: