NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAE::OptimizerAutotest Class Reference

Represents a class that is used for NX CAE Optimizer testing. More...

Public Member Functions

int DoOptimization (const std::vector< double > &constraintRespValues, double objectiveRespValue, std::vector< double > &newDesVariableValues)
 Execute the optimization for an iteration, should be called in a loop.
 
void InitializeMemory (int numDesignVariables, int numDesignConstraints, int maxNumIterations, double maxConstraintViolation, double relativeConvergence, double absoluteConvergence, double perturbationFraction)
 Initialize the internal memory that will be needed by the optimizer.
 
void InitializeRun (const std::vector< double > &desVarInitValues, const std::vector< double > &desVarLowerValues, const std::vector< double > &desVarUpperValues, const std::vector< double > &constraintLimitValues, const std::vector< int > &constraintLimitTypes, int objGoalType, double objTargetValue)
 Initialize the optimizer with design data.
 
void OptResultsPrintTestData (bool bAbsTolerance, double toleranceValue)
 Print optimization results test data to autotest XML file.
 
void SelectAndLoadOptimizer (bool bUseHyperopt)
 Set autotest to use HyperOpt or default NX Optimizer and load the optimizer library.
 
tag_t Tag () const
 Returns the tag of this object.
 
void Terminate ()
 Terminate optimization test and release all data memory.
 

Detailed Description

Represents a class that is used for NX CAE Optimizer testing.

This class should not be made available to customers
To obtain an instance of this class, refer to DebugSession

Created in NX9.0.0.

Member Function Documentation

int NXOpen::CAE::OptimizerAutotest::DoOptimization ( const std::vector< double > &  constraintRespValues,
double  objectiveRespValue,
std::vector< double > &  newDesVariableValues 
)

Execute the optimization for an iteration, should be called in a loop.

Returns

Created in NX9.0.0.

License requirements : None
Parameters
constraintRespValuesconstraintrespvalues
objectiveRespValueobjectiverespvalue
newDesVariableValuesnewdesvariablevalues
void NXOpen::CAE::OptimizerAutotest::InitializeMemory ( int  numDesignVariables,
int  numDesignConstraints,
int  maxNumIterations,
double  maxConstraintViolation,
double  relativeConvergence,
double  absoluteConvergence,
double  perturbationFraction 
)

Initialize the internal memory that will be needed by the optimizer.


Created in NX9.0.0.

License requirements : None

Parameters
numDesignVariablesnumdesignvariables
numDesignConstraintsnumdesignconstraints
maxNumIterationsmaxnumiterations
maxConstraintViolationmaxconstraintviolation
relativeConvergencerelativeconvergence
absoluteConvergenceabsoluteconvergence
perturbationFractionperturbationfraction
void NXOpen::CAE::OptimizerAutotest::InitializeRun ( const std::vector< double > &  desVarInitValues,
const std::vector< double > &  desVarLowerValues,
const std::vector< double > &  desVarUpperValues,
const std::vector< double > &  constraintLimitValues,
const std::vector< int > &  constraintLimitTypes,
int  objGoalType,
double  objTargetValue 
)

Initialize the optimizer with design data.


Created in NX9.0.0.

License requirements : None

Parameters
desVarInitValuesdesvarinitvalues
desVarLowerValuesdesvarlowervalues
desVarUpperValuesdesvaruppervalues
constraintLimitValuesconstraintlimitvalues
constraintLimitTypesconstraintlimittypes
objGoalTypeobjgoaltype
objTargetValueobjtargetvalue
void NXOpen::CAE::OptimizerAutotest::OptResultsPrintTestData ( bool  bAbsTolerance,
double  toleranceValue 
)

Print optimization results test data to autotest XML file.

Must be called before terminate method.
Created in NX9.0.0.

License requirements : None

Parameters
bAbsTolerancebabstolerance
toleranceValuetolerancevalue
void NXOpen::CAE::OptimizerAutotest::SelectAndLoadOptimizer ( bool  bUseHyperopt)

Set autotest to use HyperOpt or default NX Optimizer and load the optimizer library.

Must be called first.
Created in NX9.0.0.

License requirements : None

Parameters
bUseHyperoptbusehyperopt
tag_t NXOpen::CAE::OptimizerAutotest::Tag ( ) const

Returns the tag of this object.

void NXOpen::CAE::OptimizerAutotest::Terminate ( )

Terminate optimization test and release all data memory.


Created in NX9.0.0.

License requirements : None


The documentation for this class was generated from the following file:
Copyright 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.