ModeSet Class

class NXOpen.CAE.ModeSet

Bases: NXOpen.CAE.AlternateFemRepresentationSource, NXOpen.CAE.IPostScenarioDataSource

This is the class representing a Mode set.

Not support KF.

New in version NX12.0.0.

Properties

Property Description
Tag Returns the Tag for this object.

Methods

Method Description
ForceUpdate Force update of the Alternate Fem Representation Source
GetModeByIndex Get the data of a mode.
GetNumberOfModes Get the number of modes.
Rename Set the name of the Alternate Fem Representation Source
SetModeAnnotation Modify the annotation of a mode.
SetModeDampingRatio Modify the damping ratio of a mode.
SetModeModalMass Modify the modal mass of a mode.
SetModeStatus Modify the status of a mode.
SetModeUndampedFrequency Modify the undamped frequency of a mode.

Method Detail

GetModeByIndex

ModeSet.GetModeByIndex

Get the data of a mode.

Signature GetModeByIndex(index)

Parameters:index (int) – the index of the mode
Returns:a tuple
Return type:A tuple consisting of (label, status, undampedFrequency, dampingRatio, modalMassReal, modalMassImg, annotation) label is a int. the label of the mode status is a bool. the status of the mode undampedFrequency is a float. the undamped frequency of the mode dampingRatio is a float. the damping ratio of the mode modalMassReal is a float. the real part of the modal mass of the mode modalMassImg is a float. the imaginary part of the modal mass of the mode annotation is a str. the annotation of the mode

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

GetNumberOfModes

ModeSet.GetNumberOfModes

Get the number of modes.

Signature GetNumberOfModes()

Returns:The number of modes.
Return type:int

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetModeAnnotation

ModeSet.SetModeAnnotation

Modify the annotation of a mode.

Signature SetModeAnnotation(index, annotation)

Parameters:
  • index (int) – the index of the mode
  • annotation (str) – the annotation of the mode

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetModeDampingRatio

ModeSet.SetModeDampingRatio

Modify the damping ratio of a mode.

Signature SetModeDampingRatio(index, dampingRatio)

Parameters:
  • index (int) – the index of the mode
  • dampingRatio (float) – the damping ratio of the mode

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetModeModalMass

ModeSet.SetModeModalMass

Modify the modal mass of a mode.

Signature SetModeModalMass(index, modalMassReal, modalMassImg)

Parameters:
  • index (int) – the index of the mode
  • modalMassReal (float) – the real part of the modal mass of the mode
  • modalMassImg (float) – the imaginary part of the modal mass of the mode

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetModeStatus

ModeSet.SetModeStatus

Modify the status of a mode.

Signature SetModeStatus(index, status)

Parameters:
  • index (int) – the index of the mode
  • status (bool) – the status of the mode

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)

SetModeUndampedFrequency

ModeSet.SetModeUndampedFrequency

Modify the undamped frequency of a mode.

Signature SetModeUndampedFrequency(index, undampedFrequency)

Parameters:
  • index (int) – the index of the mode
  • undampedFrequency (float) – the undamped frequency of the mode

New in version NX12.0.0.

License requirements: nx_masterfem (“Finite Element Modeling”)