Class ansys::dpf::Result
Last update: 25.03.2026
Encapsulation of results.
Members
- EvaluateAmplitudeAtGivenStepIndexAndSubStep
- EvaluateAmplitudeAtGivenTime
- EvaluateAmplitudeAtGivenTimeIndex
- EvaluateAtGivenStepIndexAndSubStep
- EvaluateAtGivenTime
- EvaluateAtGivenTimeIndex
- EvaluateWithPhaseAtGivenStepIndexAndSubStep
- EvaluateWithPhaseAtGivenTime
- EvaluateWithPhaseAtGivenTimeIndex
- Result
- Result
- Result
- Result
- ~Result
Public functions
Function Result
ansys::dpf::Result::Result(const char *res_name, Operator &stream_provider, Operator &timefreq_support_provider)
Create a new result from res_name using given stream and timefreq.
Parameters:
- const char * res_name: [in] Name of result on which to create result.
- Operator & stream_provider: [in] Stream from which to create result.
- Operator & timefreq_support_provider: [in] Time/frequency from which to create result.
Return type:
Function Result
ansys::dpf::Result::Result(const char *res_name, Operator &stream_provider, Operator &timefreq_support_provider, Scoping meshScoping)
Create a new result from res_name using given stream, timefreq, and scoping.
Parameters:
- const char * res_name: [in] Name of result on which to create result.
- Operator & stream_provider: [in] Stream from which to create result.
- Operator & timefreq_support_provider: [in] Time/frequency from which to create result.
- Scoping meshScoping: [in] Scoping from which to create result.
Return type:
Function Result
ansys::dpf::Result::Result(const char *res_name, Operator &stream_provider, Operator &timefreq_support_provider, Scoping meshScoping, Location requested_location, int cs_id)
Create a new result from res_name using given stream, timefreq, scoping, and location.
Parameters:
- const char * res_name: [in] Name of result on which to create result.
- Operator & stream_provider: [in] Stream from which to create result.
- Operator & timefreq_support_provider: [in] Time/frequency from which to create result.
- Scoping meshScoping: [in] Scoping from which to create result.
- Location requested_location: [in] Location on which to create result.
- int cs_id: [in] Not used.
Return type:
Function Result
ansys::dpf::Result::Result(const char *res_name, Operator &stream_provider, Operator &timefreq_support_provider, Operator &mesh_provider, const char *named_selection, Location requested_location, bool bInclusive, int cs_id)
Create a new result from res_name using given stream, timefreq, mesh, named_selection, and location.
Parameters:
- const char * res_name: [in] Name of result on which to create result.
- Operator & stream_provider: [in] Stream from which to create result.
- Operator & timefreq_support_provider: [in] Time/frequency from which to create result.
- Operator & mesh_provider: [in] Mesh from which to create result.
- const char * named_selection: [in] Named selection from which to create result.
- Location requested_location: [in] Location on which to create result.
- bool bInclusive: [in] If named_selection is a nodal region and location is elemental, this flag indicates to include full/partial contained elements in named_selection.
- int cs_id: [in] Not used.
Return type:
Function ~Result
virtual ansys::dpf::Result::~Result()
Return type:
Function EvaluateAtGivenTime
FieldsContainer ansys::dpf::Result::EvaluateAtGivenTime(double dTime, DpfError &error)
Get the fields associated with results at a given time. Returns:
FieldsContainer for given time.
Parameters:
- double dTime: [in] Time for which to get fields.
- DpfError & error: [out] Status of call.
Return type: FieldsContainer
Function EvaluateAtGivenTimeIndex
FieldsContainer ansys::dpf::Result::EvaluateAtGivenTimeIndex(dp_int iSet, DpfError &error)
Get the fields associated with results at given TimeFreqSupport index. Returns:
FieldsContainer for given time/frequency index.
Parameters:
- dp_int iSet: [in] Index of TimeFreqSupport.
- DpfError & error: [out] Status of call.
Return type: FieldsContainer
Function EvaluateAtGivenStepIndexAndSubStep
FieldsContainer ansys::dpf::Result::EvaluateAtGivenStepIndexAndSubStep(dp_int iStep, dp_int iSubStep, DpfError &error)
Results are evaluated for at a given TimeFreqSupport. This is arranged in TimeFreqSupport::numberOfSteps groups of size TimeFreqSupport::numberOfSubStepsByStepIndex. Returns:
FieldsContainer for given step and substep index.
Parameters:
- dp_int iStep: [in] Grouping index.
- dp_int iSubStep: [in] Subgrouping index.
- DpfError & error: [out] Status of call.
Return type: FieldsContainer
Function EvaluateAmplitudeAtGivenTime
FieldsContainer ansys::dpf::Result::EvaluateAmplitudeAtGivenTime(double dTime, DpfError &error)
Get the amplitude of the real and imaginary part of results at a given time. Returns:
FieldsContainer for given time.
Parameters:
- double dTime: [in] Time for which to get fields.
- DpfError & error: [out] Status of call.
Return type: FieldsContainer
Function EvaluateAmplitudeAtGivenTimeIndex
FieldsContainer ansys::dpf::Result::EvaluateAmplitudeAtGivenTimeIndex(int iSet, DpfError &error)
Get the amplitude of the real and imaginary part of results of given TimeFreqSupport index. Returns:
FieldsContainer for given TimeFreqSupport index.
Parameters:
- int iSet: [in] Index of TimeFreqSupport.
- DpfError & error: [out] Status of call.
Return type: FieldsContainer
Function EvaluateAmplitudeAtGivenStepIndexAndSubStep
FieldsContainer ansys::dpf::Result::EvaluateAmplitudeAtGivenStepIndexAndSubStep(int iStep, int iSubStep, DpfError &error)
Get the amplitude of the real and imaginary part of results of given TimeFreqSupport. Results are evaluated at a given TimeFreqSupport. This is arranged in TimeFreqSupport::numberOfSteps groups of size TimeFreqSupport::numberOfSubStepsByStepIndex. Returns:
FieldsContainer for given step and substep index.
Parameters:
- int iStep: [in] Grouping index.
- int iSubStep: [in] Subgrouping index.
- DpfError & error: [out] Status of call.
Return type: FieldsContainer
Function EvaluateWithPhaseAtGivenTime
FieldsContainer ansys::dpf::Result::EvaluateWithPhaseAtGivenTime(double dTime, double dPhase, DpfError &error)
Get the sweeping phase at a given time and phase. Returns:
FieldsContainer for given time and phase.
Parameters:
- double dTime: [in] Time for which to get fields.
- double dPhase: [in] Phase angle measured in degrees.
- DpfError & error: [out] Status of call.
Return type: FieldsContainer
Function EvaluateWithPhaseAtGivenTimeIndex
FieldsContainer ansys::dpf::Result::EvaluateWithPhaseAtGivenTimeIndex(int iSet, double dPhase, DpfError &error)
Get the sweeping phase at given TimeFreqSupport index and phase Returns:
FieldsContainer for given TimeFreqSupport index and phase.
Parameters:
- int iSet: [in] Index of TimeFreqSupport.
- double dPhase: [in] Phase angle measured in degrees.
- DpfError & error: [out] Status of call.
Return type: FieldsContainer
Function EvaluateWithPhaseAtGivenStepIndexAndSubStep
FieldsContainer ansys::dpf::Result::EvaluateWithPhaseAtGivenStepIndexAndSubStep(int iStep, int iSubStep, double dPhase, DpfError &error)
Get the sweeping phase at given TimeFreqSupport and phase. Results are evaluated at a given TimeFreqSupport. This is arranged in TimeFreqSupport::numberOfSteps groups of size TimeFreqSupport::numberOfSubStepsByStepIndex. Returns:
FieldsContainer for given step and substep index and phase.
Parameters:
- int iStep: [in] Grouping index.
- int iSubStep: [in] Subgrouping index.
- double dPhase: [in] Phase angle measured in degrees.
- DpfError & error: [out] Status of call.
Return type: FieldsContainer