CorrelSolution Class — NXOpen Python API Reference 12.0.0 documentation

# CorrelSolution Class

class `NXOpen.CAE.``CorrelSolution`

  Bases: `NXOpen.NXObject`

  Represents a `NXOpen.CAE.CorrelSolution`, which is a meta-solution used to compare results from two structural dynamics solutions

  To create or edit an instance of this class, use `NXOpen.CAE.CorrelSolutionBuilder`

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
IsOccurrence | Returns whether this object is an occurrence or not.
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
Name | Returns the custom name of the object.
OwningComponent | Returns the owning component, if this object is an occurrence.
OwningPart | Returns the owning part of this object
Prototype | Returns the prototype of this object if it is an occurrence.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
CalculateComacs | Computes the CoMAC correlation metric for active modes
CloneCorrelation | Make a clone of a correl solution.
ComputeMacs | Computes the Model Assurance Criterion (MAC) correlation metric for active modes
ComputeModePairsForSol | Compute mode pairs for correlation solution
CreateAttributeIterator | Create an attribute iterator
CreateModePairingBuilder | Creates the builder object for mode pairing editing
DeleteAllAttributesByType | Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle | Deletes an attribute by type and title.
DeleteUserAttribute | Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes | Deletes the attributes on the object, if any, that satisfy the given iterator
Destroy | Deletes a correlation solution
ExportModePairCsvFile | Export mode pair to CSV file
ExportNodeMapCsvFile | Export node map to CSV file
ExportShapeMetricsCsvFile | Export shape metrics to CSV file
FindObject | Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.
GenerateComacResults | Create COMAC results
GenerateMatchingDofset | Create Matching DOFSet
GetAttributeTitlesByType | Gets all the attribute titles of a specific type.
GetBooleanUserAttribute | Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute | Gets a time attribute by Title and array Index.
GetIntegerAttribute | Gets an integer attribute by title.
GetIntegerUserAttribute | Gets an integer attribute by Title and array Index.
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue | Gets the value of PDM Reference attribute for given object.
GetRealAttribute | Gets a real attribute by title.
GetRealUserAttribute | Gets a real attribute by Title and array Index.
GetReferenceAttribute | Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetSolutionName | Returns the correlation solution name
GetStringAttribute | Gets a string attribute value by title.
GetStringUserAttribute | Gets a string attribute by Title and array Index.
GetTimeAttribute | Gets a time attribute by title.
GetTimeUserAttribute | Gets a time attribute by Title and array Index.
GetUserAttribute | Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString | Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount | Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock | Determine the lock of the given attribute.
GetUserAttributeSize | Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects | Returns an array of objects from which this object presents attributes.
GetUserAttributes | Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object.
HasUserAttribute | Determines if an attribute exists on the object, that satisfies the given iterator
ImportNodeMapCsvFile | Import node map CSV file
LockNodeMap | Lock the node map.
Print | Prints a representation of this object to the system log file.
SetActiveModePair | Sets a specific mode pair as active or not
SetActiveRefMode | Sets a specific reference mode as active or not
SetActiveSensor | Sets a specific sensor as active or not
SetActiveSensorDof | Sets a specific sensor DOF as active or not
SetActiveSensorDofOrientation | Sets a specific sensor DOF orientation
SetActiveWorkMode | Sets a specific work mode as active or not
SetAttribute | Creates or modifies an integer attribute.
SetBooleanUserAttribute | Creates or modifies a boolean attribute with the option to update or not.
SetName | Sets the custom name of the object.
SetPdmReferenceAttribute | Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute | Creates or modifies a string attribute which uses a reference string.
SetSolutionName | Sets the correlation solution name
SetTimeAttribute | Creates or modifies a time attribute.
SetTimeUserAttribute | Creates or modifies a time attribute with the option to update or not.
SetUserAttribute | Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock | Lock or unlock the given attribute.
UnlockNodeMap | Unlock the node map.
UpdateNodeMatchings | Update correlation node matchings
UpdateResultsForSolution | Update results for correlation solution

# Property Detail

## IsOccurrence

`CorrelSolution.``IsOccurrence`

  Returns whether this object is an occurrence or not.

  `-------------------------------------`

  Getter Method

  Signature `IsOccurrence`

  Returns: | This object is an occurrence
  Return type: | bool

  New in version NX3.0.0.

  License requirements: None.

## JournalIdentifier

`CorrelSolution.``JournalIdentifier`

  Returns the identifier that would be recorded in a journal for this object.

  This may not be the same across different releases of the software.

  `-------------------------------------`

  Getter Method

  Signature `JournalIdentifier`

  Returns: |
  Return type: | str

  New in version NX3.0.0.

  License requirements: None.

## Name

`CorrelSolution.``Name`

  Returns the custom name of the object.

  `-------------------------------------`

  Getter Method

  Signature `Name`

  Returns: |
  Return type: | str

  New in version NX3.0.0.

  License requirements: None.

## OwningComponent

`CorrelSolution.``OwningComponent`

  Returns the owning component, if this object is an occurrence.

  `-------------------------------------`

  Getter Method

  Signature `OwningComponent`

  Returns: |
  Return type: | `NXOpen.Assemblies.Component`

  New in version NX3.0.0.

  License requirements: None.

## OwningPart

`CorrelSolution.``OwningPart`

  Returns the owning part of this object

  `-------------------------------------`

  Getter Method

  Signature `OwningPart`

  Returns: | The owning part of this object or null if it does not have an owner
  Return type: | `NXOpen.BasePart`

  New in version NX3.0.0.

  License requirements: None.

## Prototype

`CorrelSolution.``Prototype`

  Returns the prototype of this object if it is an occurrence.

  `-------------------------------------`

  Getter Method

  Signature `Prototype`

  Returns: | The prototype of this object or null if this object is not an occurrence
  Return type: | `NXOpen.INXObject`

  New in version NX3.0.0.

  License requirements: None.

# Method Detail

## CalculateComacs

`CorrelSolution.``CalculateComacs`

  Computes the CoMAC correlation metric for active modes

  Signature `CalculateComacs()`

  Returns: | a tuple
  Return type: | A tuple consisting of (comacValues, referenceModeNumbers, workModeNumbers, referenceModeFrequencies, workModeFrequencies, refNodesHaveSensors, refNodeIndex, refDofIndex) comacValues is a list of float. comac values referenceModeNumbers is a list of int. reference mode numbers workModeNumbers is a list of int. work mode numbers referenceModeFrequencies is a list of float. reference mode frequencies workModeFrequencies is a list of float. work mode frequencies refNodesHaveSensors is a list of int. indicates if nodes have a sensor (0=yes, 1=no) refNodeIndex is a list of int. reference node index refDofIndex is a list of int. reference dof index

  New in version NX6.0.2.

  License requirements: nx_correl_base (“FE Correlation”)

## CloneCorrelation

`CorrelSolution.``CloneCorrelation`

  Make a clone of a correl solution.

  Signature `CloneCorrelation()`

  Returns: | Cloned solution
  Return type: | `NXOpen.CAE.CorrelSolution`

  New in version NX8.0.1.

  License requirements: nx_correl_base (“FE Correlation”)

## ComputeMacs

`CorrelSolution.``ComputeMacs`

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

  Signature `ComputeMacs()`

  Returns: | a tuple
  Return type: | A tuple consisting of (macValues, referenceModeFrequencies, referenceModeNumbers, workModeFrequencies, workModeNumbers) macValues is a list of float. the MAC values computed referenceModeFrequencies is a list of float. ref mode frequencies referenceModeNumbers is a list of int. ref mode numbers workModeFrequencies is a list of float. work mode frequencies workModeNumbers is a list of int. work mode numbers

  New in version NX6.0.1.

  License requirements: nx_correl_base (“FE Correlation”)

## ComputeModePairsForSol

`CorrelSolution.``ComputeModePairsForSol`

  Compute mode pairs for correlation solution

  Signature `ComputeModePairsForSol()`

  New in version NX7.5.0.

  License requirements: nx_correl_base (“FE Correlation”)

## CreateModePairingBuilder

`CorrelSolution.``CreateModePairingBuilder`

  Creates the builder object for mode pairing editing

  Signature `CreateModePairingBuilder()`

  Returns: |
  Return type: | `NXOpen.CAE.CorrelModePairingBuilder`

  New in version NX6.0.1.

  License requirements: nx_correl_base (“FE Correlation”)

## Destroy

`CorrelSolution.``Destroy`

  Deletes a correlation solution

  Signature `Destroy(deleteResultFile)`

  Parameters: | deleteResultFile (bool) – delete the result files associated with the solution or not

  New in version NX5.0.0.

  License requirements: nx_correl_base (“FE Correlation”)

## ExportModePairCsvFile

`CorrelSolution.``ExportModePairCsvFile`

  Export mode pair to CSV file

  Signature `ExportModePairCsvFile(filename)`

  Parameters: | filename (str) – CSV file name.

  New in version NX7.5.0.

  License requirements: nx_correl_base (“FE Correlation”)

## ExportNodeMapCsvFile

`CorrelSolution.``ExportNodeMapCsvFile`

  Export node map to CSV file

  Signature `ExportNodeMapCsvFile(filename)`

  Parameters: | filename (str) – CSV file name.

  New in version NX9.0.1.

  License requirements: nx_correl_base (“FE Correlation”)

## ExportShapeMetricsCsvFile

`CorrelSolution.``ExportShapeMetricsCsvFile`

  Export shape metrics to CSV file

  Signature `ExportShapeMetricsCsvFile(metricCode, filename)`

  Parameters:

  - metricCode (`NXOpen.CAE.CorrelShapemetrictype`) – shape metric code
  - filename (str) – CSV file name.

  New in version NX7.5.0.

  License requirements: nx_correl_base (“FE Correlation”)

## FindObject

`CorrelSolution.``FindObject`

  Finds the `NXOpen.NXObject` with the given identifier as recorded in a journal.

  An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

  An exception will be thrown if no object can be found with the given journal identifier.

  Signature `FindObject(journalIdentifier)`

  Parameters: | journalIdentifier (str) – Journal identifier of the object
  Returns: |
  Return type: | `NXOpen.INXObject`

  New in version NX3.0.0.

  License requirements: None.

## GenerateComacResults

`CorrelSolution.``GenerateComacResults`

  Create COMAC results

  Signature `GenerateComacResults()`

  New in version NX7.5.1.

  License requirements: nx_correl_base (“FE Correlation”)

## GenerateMatchingDofset

`CorrelSolution.``GenerateMatchingDofset`

  Create Matching DOFSet

  Signature `GenerateMatchingDofset()`

  New in version NX7.5.0.

  License requirements: nx_correl_base (“FE Correlation”)

## GetSolutionName

`CorrelSolution.``GetSolutionName`

  Returns the correlation solution name

  Signature `GetSolutionName()`

  Returns: | the `NXOpen.CAE.CorrelSolution` name
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

## ImportNodeMapCsvFile

`CorrelSolution.``ImportNodeMapCsvFile`

  Import node map CSV file

  Signature `ImportNodeMapCsvFile(filename)`

  Parameters: | filename (str) – CSV file name.

  New in version NX9.0.1.

  License requirements: nx_correl_base (“FE Correlation”)

## LockNodeMap

`CorrelSolution.``LockNodeMap`

  Lock the node map.

  Signature `LockNodeMap()`

  New in version NX11.0.0.

  License requirements: nx_correl_base (“FE Correlation”)

## Print

`CorrelSolution.``Print`

  Prints a representation of this object to the system log file.

  Signature `Print()`

  New in version NX3.0.0.

  License requirements: None.

## SetActiveModePair

`CorrelSolution.``SetActiveModePair`

  Sets a specific mode pair as active or not

  Signature `SetActiveModePair(referenceModeNumber, workModeNumber, active)`

  Parameters:

  - referenceModeNumber (int) – reference mode of the pair
  - workModeNumber (int) – work mode of the pair
  - active (bool) – activate or deactivate flag

  New in version NX6.0.1.

  License requirements: nx_correl_base (“FE Correlation”)

## SetActiveRefMode

`CorrelSolution.``SetActiveRefMode`

  Sets a specific reference mode as active or not

  Signature `SetActiveRefMode(refModeNumber, active)`

  Parameters:

  - refModeNumber (int) – reference mode to activate or deactivate
  - active (bool) – activate or deactivate flag

  New in version NX6.0.1.

  License requirements: nx_correl_base (“FE Correlation”)

## SetActiveSensor

`CorrelSolution.``SetActiveSensor`

  Sets a specific sensor as active or not

  Signature `SetActiveSensor(sensorNumber, active)`

  Parameters:

  - sensorNumber (int) – sensor number
  - active (bool) – activate or deactivate flag

  New in version NX7.5.0.

  License requirements: nx_correl_base (“FE Correlation”)

## SetActiveSensorDof

`CorrelSolution.``SetActiveSensorDof`

  Sets a specific sensor DOF as active or not

  Signature `SetActiveSensorDof(sensorNumber, dofNumber, active)`

  Parameters:

  - sensorNumber (int) – sensor number
  - dofNumber (int) – dof number
  - active (bool) – activate or deactivate flag

  New in version NX7.5.0.

  License requirements: nx_correl_base (“FE Correlation”)

## SetActiveSensorDofOrientation

`CorrelSolution.``SetActiveSensorDofOrientation`

  Sets a specific sensor DOF orientation

  Signature `SetActiveSensorDofOrientation(sensorNumber, dofNumber, orientation)`

  Parameters:

  - sensorNumber (int) – sensor number
  - dofNumber (int) – dof number
  - orientation (bool) – true for positive orientation or false for negative orientation

  New in version NX7.5.0.

  License requirements: nx_correl_base (“FE Correlation”)

## SetActiveWorkMode

`CorrelSolution.``SetActiveWorkMode`

  Sets a specific work mode as active or not

  Signature `SetActiveWorkMode(workModeNumber, active)`

  Parameters:

  - workModeNumber (int) – work mode to activate or deactivate
  - active (bool) – activate or deactivate flag

  New in version NX6.0.1.

  License requirements: nx_correl_base (“FE Correlation”)

## SetName

`CorrelSolution.``SetName`

  Sets the custom name of the object.

  NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

  Signature `SetName(name)`

  Parameters: | name (str) –

  New in version NX3.0.0.

  License requirements: None.

## SetSolutionName

`CorrelSolution.``SetSolutionName`

  Sets the correlation solution name

  Signature `SetSolutionName(solutionName, renameResultFile)`

  Parameters:

  - solutionName (str) – new solution name
  - renameResultFile (bool) – if there are result files associated with the solution, rename the files or not

  New in version NX5.0.0.

  License requirements: nx_correl_base (“FE Correlation”)

## UnlockNodeMap

`CorrelSolution.``UnlockNodeMap`

  Unlock the node map.

  Signature `UnlockNodeMap()`

  New in version NX11.0.0.

  License requirements: nx_correl_base (“FE Correlation”)

## UpdateNodeMatchings

`CorrelSolution.``UpdateNodeMatchings`

  Update correlation node matchings

  Signature `UpdateNodeMatchings()`

  New in version NX7.5.0.

  License requirements: nx_correl_base (“FE Correlation”)

## UpdateResultsForSolution

`CorrelSolution.``UpdateResultsForSolution`

  Update results for correlation solution

  Signature `UpdateResultsForSolution(tSolution, ignoreReload)`

  Parameters:

  - tSolution (`NXOpen.CAE.SimSolution`) – solution
  - ignoreReload (bool) – ignore reload

  New in version NX7.5.0.

  License requirements: nx_correl_base (“FE Correlation”)