NX Open C++ Reference Guide
Public Member Functions
NXOpen::CAE::CorrelSolution Class Reference

Represents a CAE::CorrelSolution , which is a meta-solution used to compare results from two structural dynamics solutions
Created in NX6.0.0. More...

Inheritance diagram for NXOpen::CAE::CorrelSolution:
NXOpen::NXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::CAE::ModelUpdateSolution

List of all members.

Public Member Functions

std::vector< double > CalculateComacs (std::vector< int > &referenceModeNumbers, std::vector< int > &workModeNumbers, std::vector< double > &referenceModeFrequencies, std::vector< double > &workModeFrequencies, std::vector< int > &refNodesHaveSensors, std::vector< int > &refNodeIndex, std::vector< int > &refDofIndex)
 Computes the CoMAC correlation metric for active modes.
NXOpen::CAE::CorrelSolutionCloneCorrelation ()
 Make a clone of a correl solution.
void ComputeComacs ()
 Computes the CoMAC correlation metric for active modes

std::vector< double > ComputeMacs (std::vector< double > &referenceModeFrequencies, std::vector< int > &referenceModeNumbers, std::vector< double > &workModeFrequencies, std::vector< int > &workModeNumbers)
 Computes the Model Assurance Criterion (MAC) correlation metric for active modes.
void ComputeModePairsForSol ()
 Compute mode pairs for correlation solution
Created in NX7.5.0.
NXOpen::CAE::CorrelAlignmentBuilderCreateAlignmentBuilder ()
 Creates the builder object for mode alignment editing.
NXOpen::CAE::CorrelModePairingBuilderCreateModePairingBuilder ()
 Creates the builder object for mode pairing editing.
void Destroy (bool deleteResultFile)
 Deletes a correlation solution
Created in NX5.0.0.
void ExportModePairCsvFile (const NXString &filename)
 Export mode pair to CSV file
Created in NX7.5.0.
void ExportShapeMetricsCsvFile (NXOpen::CAE::CorrelShapemetrictype metricCode, const NXString &filename)
 Export shape metrics to CSV file
Created in NX7.5.0.
void GenerateComacResults ()
 Create COMAC results
Created in NX7.5.1.
void GenerateMatchingDofset ()
 Create Matching DOFSet
Created in NX7.5.0.
NXString GetSolutionName ()
 Returns the correlation solution name.
void SetActiveModePair (int referenceModeNumber, int workModeNumber, bool active)
 Sets a specific mode pair as active or not
Created in NX6.0.1.
void SetActiveRefMode (int refModeNumber, bool active)
 Sets a specific reference mode as active or not
Created in NX6.0.1.
void SetActiveSensor (int sensorNumber, bool active)
 Sets a specific sensor as active or not
Created in NX7.5.0.
void SetActiveSensorDof (int sensorNumber, int dofNumber, bool active)
 Sets a specific sensor DOF as active or not
Created in NX7.5.0.
void SetActiveSensorDofOrientation (int sensorNumber, int dofNumber, bool orientation)
 Sets a specific sensor DOF orientation
Created in NX7.5.0.
void SetActiveWorkMode (int workModeNumber, bool active)
 Sets a specific work mode as active or not
Created in NX6.0.1.
void SetSolutionName (const NXString &solutionName, bool renameResultFile)
 Sets the correlation solution name
Created in NX5.0.0.
void UpdateNodeMatchings ()
 Update correlation node matchings
Created in NX7.5.0.
void UpdateResultsForSolution (NXOpen::CAE::SimSolution *tSolution, bool ignoreReload)
 Update results for correlation solution
Created in NX7.5.0.

Detailed Description

Represents a CAE::CorrelSolution , which is a meta-solution used to compare results from two structural dynamics solutions
Created in NX6.0.0.



Member Function Documentation

std::vector<double> NXOpen::CAE::CorrelSolution::CalculateComacs ( std::vector< int > &  referenceModeNumbers,
std::vector< int > &  workModeNumbers,
std::vector< double > &  referenceModeFrequencies,
std::vector< double > &  workModeFrequencies,
std::vector< int > &  refNodesHaveSensors,
std::vector< int > &  refNodeIndex,
std::vector< int > &  refDofIndex 
)

Computes the CoMAC correlation metric for active modes.

Returns:
comac values
Created in NX6.0.2.

License requirements : nx_correl_base ("FE Correlation")
Parameters:
referenceModeNumbersreference mode numbers
workModeNumberswork mode numbers
referenceModeFrequenciesreference mode frequencies
workModeFrequencieswork mode frequencies
refNodesHaveSensorsindicates if nodes have a sensor (0=yes, 1=no)
refNodeIndexreference node index
refDofIndexreference dof index

Make a clone of a correl solution.

Returns:
Cloned solution
Created in NX8.0.1.

License requirements : nx_correl_base ("FE Correlation")

Computes the CoMAC correlation metric for active modes

Deprecated:
Deprecated in NX6.0.2.



Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")

std::vector<double> NXOpen::CAE::CorrelSolution::ComputeMacs ( std::vector< double > &  referenceModeFrequencies,
std::vector< int > &  referenceModeNumbers,
std::vector< double > &  workModeFrequencies,
std::vector< int > &  workModeNumbers 
)

Computes the Model Assurance Criterion (MAC) correlation metric for active modes.

Returns:
the MAC values computed
Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")
Parameters:
referenceModeFrequenciesref mode frequencies
referenceModeNumbersref mode numbers
workModeFrequencieswork mode frequencies
workModeNumberswork mode numbers

Compute mode pairs for correlation solution
Created in NX7.5.0.



License requirements : nx_correl_base ("FE Correlation")

Creates the builder object for mode alignment editing.

Returns:

Deprecated:
Deprecated in NX7.5.0.


Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")

Creates the builder object for mode pairing editing.

Returns:

Created in NX6.0.1.

License requirements : nx_correl_base ("FE Correlation")
void NXOpen::CAE::CorrelSolution::Destroy ( bool  deleteResultFile)

Deletes a correlation solution
Created in NX5.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
deleteResultFiledelete the result files associated with the solution or not

Export mode pair to CSV file
Created in NX7.5.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
filenameCSV file name.
NOTE: The full Unicode character set is not supported for this parameter.

Export shape metrics to CSV file
Created in NX7.5.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
metricCodeshape metric code
filenameCSV file name.
NOTE: The full Unicode character set is not supported for this parameter.

Create COMAC results
Created in NX7.5.1.



License requirements : nx_correl_base ("FE Correlation")

Create Matching DOFSet
Created in NX7.5.0.



License requirements : nx_correl_base ("FE Correlation")

Returns the correlation solution name.

Returns:
the CAE::CorrelSolution name
Created in NX5.0.0.

License requirements : None
void NXOpen::CAE::CorrelSolution::SetActiveModePair ( int  referenceModeNumber,
int  workModeNumber,
bool  active 
)

Sets a specific mode pair as active or not
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
referenceModeNumberreference mode of the pair
workModeNumberwork mode of the pair
activeactivate or deactivate flag
void NXOpen::CAE::CorrelSolution::SetActiveRefMode ( int  refModeNumber,
bool  active 
)

Sets a specific reference mode as active or not
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
refModeNumberreference mode to activate or deactivate
activeactivate or deactivate flag
void NXOpen::CAE::CorrelSolution::SetActiveSensor ( int  sensorNumber,
bool  active 
)

Sets a specific sensor as active or not
Created in NX7.5.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
sensorNumbersensor number
activeactivate or deactivate flag
void NXOpen::CAE::CorrelSolution::SetActiveSensorDof ( int  sensorNumber,
int  dofNumber,
bool  active 
)

Sets a specific sensor DOF as active or not
Created in NX7.5.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
sensorNumbersensor number
dofNumberdof number
activeactivate or deactivate flag
void NXOpen::CAE::CorrelSolution::SetActiveSensorDofOrientation ( int  sensorNumber,
int  dofNumber,
bool  orientation 
)

Sets a specific sensor DOF orientation
Created in NX7.5.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
sensorNumbersensor number
dofNumberdof number
orientationtrue for positive orientation or false for negative orientation
void NXOpen::CAE::CorrelSolution::SetActiveWorkMode ( int  workModeNumber,
bool  active 
)

Sets a specific work mode as active or not
Created in NX6.0.1.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
workModeNumberwork mode to activate or deactivate
activeactivate or deactivate flag
void NXOpen::CAE::CorrelSolution::SetSolutionName ( const NXString solutionName,
bool  renameResultFile 
)

Sets the correlation solution name
Created in NX5.0.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
solutionNamenew solution name
renameResultFileif there are result files associated with the solution, rename the files or not

Update correlation node matchings
Created in NX7.5.0.



License requirements : nx_correl_base ("FE Correlation")

Update results for correlation solution
Created in NX7.5.0.



License requirements : nx_correl_base ("FE Correlation")

Parameters:
tSolutionsolution
ignoreReloadignore reload

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