ansys.dpf.core.operators.result.spectrum_data#

class ansys.dpf.core.operators.result.spectrum_data(streams=None, data_sources=None, config=None, server=None)#

Bases: ansys.dpf.core.dpf_operator.Operator

Read spectral data from the result files contained in the streams or data sources.

Parameters:

  • streams (StreamsContainer, optional) – Result file container allowed to be kept open to cache data.

  • data_sources (DataSources) – Result file path container, used if no streams are set.

Returns:

  • participation_factors (FieldsContainer) – Fields container holding participation factors.

  • mode_coefficients (FieldsContainer) – Fields container holding mode coefficients (PRS File).

  • damping_ratios (FieldsContainer) – Fields container holding damping ratios (PRS File).

  • global_damping (FieldsContainer) – Fields container holding for each spectrum: Global Damping Ratio, Damping Stiffness Coefficient & Damping Mass Coefficient (PRS File).

  • missing_mass (FieldsContainer) – Fields container holding for each spectrum: Missing Mass Mode (0: None, 1: Active), Missing Mass Effect ZPA (PRS File).

  • rigid_response (FieldsContainer) – Fields container holding for each spectrum: Rigid Response Mode (0: None, 1: Gupta, 2: Lindley), Freq Begin (Gupta) / ZPA (Lindley), Freq End (Gupta) (PRS File).

Examples

>>> from ansys.dpf import core as dpf

>>> # Instantiate operator
>>> op = dpf.operators.result.spectrum_data()

>>> # Make input connections
>>> my_streams = dpf.StreamsContainer()
>>> op.inputs.streams.connect(my_streams)
>>> my_data_sources = dpf.DataSources()
>>> op.inputs.data_sources.connect(my_data_sources)

>>> # Instantiate operator and connect inputs in one line
>>> op = dpf.operators.result.spectrum_data(
...     streams=my_streams,
...     data_sources=my_data_sources,
... )

>>> # Get output data
>>> result_participation_factors = op.outputs.participation_factors()
>>> result_mode_coefficients = op.outputs.mode_coefficients()
>>> result_damping_ratios = op.outputs.damping_ratios()
>>> result_global_damping = op.outputs.global_damping()
>>> result_missing_mass = op.outputs.missing_mass()
>>> result_rigid_response = op.outputs.rigid_response()
_inputs#
_outputs#
static _spec() → ansys.dpf.core.operators.specification.Specification#
static default_config(server: ansys.dpf.core.server_types.AnyServerType = None) → ansys.dpf.core.config.Config#

Returns the default config of the operator.

This config can then be changed to the user needs and be used to instantiate the operator. The Configuration allows to customize how the operation will be processed by the operator.

Parameters:

server – Server with channel connected to the remote or local instance. When None, attempts to use the global server.

Returns:

A new Config instance equivalent to the default config for this operator.

Return type:

config

property inputs: InputsSpectrumData#

Enables to connect inputs to the operator

Returns:

An instance of InputsSpectrumData.

Return type:

inputs

property outputs: OutputsSpectrumData#

Enables to get outputs of the operator by evaluating it

Returns:

An instance of OutputsSpectrumData.

Return type:

outputs