FrequencyDefinition Class — NXOpen Python API Reference 12.0.0 documentation

# FrequencyDefinition Class

class `NXOpen.CAE.ResponseSimulation.``FrequencyDefinition`

  Bases: `NXOpen.TaggedObject`

  Represents the frequency setting to perform FRF evaluation

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
ContributorNumber | Returns or sets the number of contributors.
EndValue | Returns or sets the end value of frequency range.
EvaluationType | Returns or sets the method to define frequency
GenerateMaximumContributors | Returns or sets the option for generating maximum contributors or not.
InterpolationMethodOption | Returns or sets the interpolation method.
NormalizeResults | Returns or sets the option to normalize results.
SpectralLine | Returns or sets the additional spectral lines.
StartValue | Returns or sets the start value of frequency range.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
GetFrequencies | Returns frequency values to perform FRF evaluation.
SetFrequencies | Sets the frequency values to perform FRF evaluation.

# Enumerations

FrequencyDefinitionDefinition Enumeration | Specifies the method to define frequency
FrequencyDefinitionInterpolationMethod Enumeration | Specifies the method for interpolation

# Property Detail

## ContributorNumber

`FrequencyDefinition.``ContributorNumber`

  Returns or sets the number of contributors.

  Only available when maximu contributors will be generated

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

  Getter Method

  Signature `ContributorNumber`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `ContributorNumber`

  Parameters: | contributorNumber (int) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## EndValue

`FrequencyDefinition.``EndValue`

  Returns or sets the end value of frequency range.

  Only available when the frequency is defined by `CAE.ResponseSimulation.FrequencyDefinitionDefinition.Range`

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

  Getter Method

  Signature `EndValue`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `EndValue`

  Parameters: | endValue (float) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## EvaluationType

`FrequencyDefinition.``EvaluationType`

  Returns or sets the method to define frequency

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

  Getter Method

  Signature `EvaluationType`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.FrequencyDefinitionDefinition`

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `EvaluationType`

  Parameters: | type (`NXOpen.CAE.ResponseSimulation.FrequencyDefinitionDefinition`) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## GenerateMaximumContributors

`FrequencyDefinition.``GenerateMaximumContributors`

  Returns or sets the option for generating maximum contributors or not.

  Only available when frequency definition metod is `CAE.ResponseSimulation.FrequencyDefinitionDefinition.ModalContribution`

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

  Getter Method

  Signature `GenerateMaximumContributors`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `GenerateMaximumContributors`

  Parameters: | generateMaximumContributors (bool) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## InterpolationMethodOption

`FrequencyDefinition.``InterpolationMethodOption`

  Returns or sets the interpolation method.

  Only available when the frequency is defined by `CAE.ResponseSimulation.FrequencyDefinitionDefinition.Range`

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

  Getter Method

  Signature `InterpolationMethodOption`

  Returns: |
  Return type: | `NXOpen.CAE.ResponseSimulation.FrequencyDefinitionInterpolationMethod`

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `InterpolationMethodOption`

  Parameters: | interpolationMethod (`NXOpen.CAE.ResponseSimulation.FrequencyDefinitionInterpolationMethod`) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## NormalizeResults

`FrequencyDefinition.``NormalizeResults`

  Returns or sets the option to normalize results.

  Only available when maximu contributors will be generated

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

  Getter Method

  Signature `NormalizeResults`

  Returns: |
  Return type: | bool

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `NormalizeResults`

  Parameters: | normalizeResults (bool) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## SpectralLine

`FrequencyDefinition.``SpectralLine`

  Returns or sets the additional spectral lines.

  Only available when frequency is defined by `CAE.ResponseSimulation.FrequencyDefinitionDefinition.Range`

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

  Getter Method

  Signature `SpectralLine`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `SpectralLine`

  Parameters: | spectralLines (int) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## StartValue

`FrequencyDefinition.``StartValue`

  Returns or sets the start value of frequency range.

  Only available when the frequency is defined by `CAE.ResponseSimulation.FrequencyDefinitionDefinition.Range`

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

  Getter Method

  Signature `StartValue`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

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

  Setter Method

  Signature `StartValue`

  Parameters: | startValue (float) –

  New in version NX5.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

# Method Detail

## GetFrequencies

`FrequencyDefinition.``GetFrequencies`

  Returns frequency values to perform FRF evaluation.

  Only available when the frequency definition method is `CAE.ResponseSimulation.FrequencyDefinitionDefinition.ModalContribution`

  Signature `GetFrequencies()`

  Returns: |
  Return type: | list of float

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)

## SetFrequencies

`FrequencyDefinition.``SetFrequencies`

  Sets the frequency values to perform FRF evaluation.

  Only available when the frequency definition method is `CAE.ResponseSimulation.FrequencyDefinitionDefinition.ModalContribution`

  Signature `SetFrequencies(frequencies)`

  Parameters: | frequencies (list of float) –

  New in version NX6.0.0.

  License requirements: nx_response_anlys (“NX Response Analysis”)