Skip to main content

DPF Cpp Client Library 2026 R1

Class ansys::dpf::TimeFreqSupport

Last update: 25.03.2026

Define a time/frequency set.

The time freq support describes an analysis' temporal or frequential space. For a transient analysis all the time sets cumulatives indices with their times are described. For a harmonic analysis, the real and imaginary frequencies, the RPMs, the load steps are described.

Inherits from:

Members

Friends

Public functions

Function TimeFreqSupport

ansys::dpf::TimeFreqSupport::TimeFreqSupport()

Return type:

Function TimeFreqSupport

ansys::dpf::TimeFreqSupport::TimeFreqSupport(Client const *const client)

Create a new TimeFreqSupport on a server.

Parameters:

  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type:

Function TimeFreqSupport

ansys::dpf::TimeFreqSupport::TimeFreqSupport(int id, Client const *const client)

Retrieve an existing instance of TimeFreqSupport on a server.

Parameters:

  • int id: [in] Id of the TimeFreqSupport object on the server's database.
  • Client const *const client: [in] Client instance designating the IP, port and protocol to use.

Return type:

Function ~TimeFreqSupport

virtual ansys::dpf::TimeFreqSupport::~TimeFreqSupport()

Return type:

Function TimeFreqSupport

ansys::dpf::TimeFreqSupport::TimeFreqSupport(TimeFreqSupport const &)

Parameters:

  • TimeFreqSupport const &

Return type:

Function TimeFreqSupport

ansys::dpf::TimeFreqSupport::TimeFreqSupport(TimeFreqSupport &&) noexcept

Parameters:

  • TimeFreqSupport &&

Return type:

Function operator=

TimeFreqSupport & ansys::dpf::TimeFreqSupport::operator=(TimeFreqSupport const &)

Parameters:

  • TimeFreqSupport const &

Return type: TimeFreqSupport &

Function operator=

TimeFreqSupport & ansys::dpf::TimeFreqSupport::operator=(TimeFreqSupport &&) noexcept

Parameters:

  • TimeFreqSupport &&

Return type: TimeFreqSupport &

Function numberOfSets

dp_int ansys::dpf::TimeFreqSupport::numberOfSets() const

Returns:

Number of time frequency sets.

Return type: dp_int

Function numberOfSteps

dp_int ansys::dpf::TimeFreqSupport::numberOfSteps() const

Returns:

Number of steps.

Return type: dp_int

Function numberOfSubStepsByStepIndex

dp_int ansys::dpf::TimeFreqSupport::numberOfSubStepsByStepIndex(dp_int stepIndex) const

Returns:

Number of sub steps for a given step index (0 based).

Parameters:

Return type: dp_int

Function numberOfSubStepsByStepId

dp_int ansys::dpf::TimeFreqSupport::numberOfSubStepsByStepId(dp_int stepId) const

Returns:

Number of sub steps for a given step id.

Parameters:

Return type: dp_int

Function getSetIndexByStepIndexAndSubStep

dp_int ansys::dpf::TimeFreqSupport::getSetIndexByStepIndexAndSubStep(dp_int step, dp_int sub_step) const

Returns:

set index (0 based) at a given step index and substep index.

Parameters:

Return type: dp_int

Function getImaginaryFreqByStep

dp_double ansys::dpf::TimeFreqSupport::getImaginaryFreqByStep(dp_index step, dp_index sub_step) const

Returns:

imaginary frequency at a given step index and substep indices.

Parameters:

  • dp_index step: [in] step index (0 based).
  • dp_index sub_step: [in] sub_step index (0 based).

Return type: dp_double

Function getTimeFreqByStep

dp_double ansys::dpf::TimeFreqSupport::getTimeFreqByStep(dp_index step, dp_index sub_step) const

Returns:

time frequency at a given step index and substep indices.

Parameters:

  • dp_index step: [in] step index (0 based).
  • dp_index sub_step: [in] sub_step index (0 based).

Return type: dp_double

Function getImaginaryFreqSetIndexByValue

dp_int ansys::dpf::TimeFreqSupport::getImaginaryFreqSetIndexByValue(dp_double frequency) const

Returns:

set index (0 based) for given imaginary frequency.

Parameters:

Return type: dp_int

Function getSetIndexByTimeFreq

dp_int ansys::dpf::TimeFreqSupport::getSetIndexByTimeFreq(dp_double frequency) const

Returns:

set index (0 based) for given time frequency.

Parameters:

Return type: dp_int

Function getStepAndSubStep

std::pair< dp_id, dp_index > ansys::dpf::TimeFreqSupport::getStepAndSubStep(int cumulative_index) const

Returns:

step index and substep at a given set index (0 based).

Parameters:

  • int cumulative_index

Return type: std::pair< dp_id, dp_index >

Function frequencies

Field ansys::dpf::TimeFreqSupport::frequencies() const

Returns:

Field associated with time frequency.

Return type: Field

Function imaginaryFrequencies

Field ansys::dpf::TimeFreqSupport::imaginaryFrequencies() const

Returns:

Field associated with imaginary part of time frequency.

Return type: Field

Function rpms

Field ansys::dpf::TimeFreqSupport::rpms() const

Returns:

RPMS associated with time frequency.

Return type: Field

Function harmonicIndeces

Field ansys::dpf::TimeFreqSupport::harmonicIndeces(dp_int stage=0) const

Returns:

Harmonic indices associated with time frequency.

Parameters:

Return type: Field

Function timeFrequenciesSubstepIds

PropertyField ansys::dpf::TimeFreqSupport::timeFrequenciesSubstepIds() const

Returns:

substep id associated with time frequency.

Return type: PropertyField

Function harmonicIndicesScoping

Scoping ansys::dpf::TimeFreqSupport::harmonicIndicesScoping() const

Returns:

Scoping containing all the stage numbers of the TimeFreqSupport.

Return type: Scoping

Function numberOfSingularSets

dp_int ansys::dpf::TimeFreqSupport::numberOfSingularSets() const

Returns:

Number of unique time frequency entries.

Return type: dp_int

Function setTimeFrequencies

void ansys::dpf::TimeFreqSupport::setTimeFrequencies(Field field)

Set time frequency from given field.

Parameters:

  • Field field: [in] Field from which to set time frequency.

Return type: void

Function setImaginaryFrequencies

void ansys::dpf::TimeFreqSupport::setImaginaryFrequencies(Field field)

Set imaginary part of time frequency from given field.

Parameters:

  • Field field: [in] Field from which to set imaginary part of time frequency.

Return type: void

Function setRpms

void ansys::dpf::TimeFreqSupport::setRpms(Field field)

Set rpms of time frequency support from given field.

Parameters:

  • Field field: [in] Field from which to set imaginary part of time frequency.

Return type: void

Function setHarmonicIndices

void ansys::dpf::TimeFreqSupport::setHarmonicIndices(Field field, dp_int stage=0)

Set harmonic indices of time frequency support from given field for a specified stage.

Parameters:

  • Field field: [in] Field from which to set imaginary part of time frequency.
  • dp_int stage = 0 : [in] Optional stage number (default is 0).

Return type: void

Function boundingCumulativeIndecesOfTimeFreq

std::pair< dp_int, dp_int > ansys::dpf::TimeFreqSupport::boundingCumulativeIndecesOfTimeFreq(double time_freq, int loadstep=0) const

Returns:

Bounding indices for given time time frequency and load step.

Parameters:

  • double time_freq: [in] Time frequency for which to find bounding indices.
  • int loadstep = 0 : [in] Optional load step.

Return type: std::pair< dp_int, dp_int >

Function timeFreq

dp_double ansys::dpf::TimeFreqSupport::timeFreq(dp_int cumul_index, dp_int complex_id=0) const

Returns:

Time/Frequency for given index.

Parameters:

  • dp_int cumul_index: [in] Index for which to get time frequency.
  • dp_int complex_id = 0 : [in] Optional non-zero indicates to get imaginary part of time frequency.

Return type: dp_double

Function deep_copy

TimeFreqSupport ansys::dpf::TimeFreqSupport::deep_copy(ansys::dpf::Client const *const client=nullptr) const

Create a new TimeFreqSupport on a server by copying all the data of this TimeFreqSupport.

Parameters:

Return type: TimeFreqSupport

Public static functions

Function emptyTimeFreqSupport

static TimeFreqSupport ansys::dpf::TimeFreqSupport::emptyTimeFreqSupport()

Return type: TimeFreqSupport

Connect with Ansys