## On this page # ansys::dpf::Result Class Reference Last update: 16.07.2025 `#include ` ## Public Member Functions [Result](classansys_1_1dpf_1_1Result.xhtml#a73de9b4b151118e388e2985a4c88fa4a) (const char \*res\_name, [Operator](classansys_1_1dpf_1_1Operator.xhtml) &stream\_provider, [Operator](classansys_1_1dpf_1_1Operator.xhtml) &timefreq\_support\_provider) [Result](classansys_1_1dpf_1_1Result.xhtml#a83f9071125be65acbd5319b0e9f44699) (const char \*res\_name, [Operator](classansys_1_1dpf_1_1Operator.xhtml) &stream\_provider, [Operator](classansys_1_1dpf_1_1Operator.xhtml) &timefreq\_support\_provider, [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) meshScoping) [Result](classansys_1_1dpf_1_1Result.xhtml#a5ede8932a39a76dc06b9b3b1d21ed606) (const char \*res\_name, [Operator](classansys_1_1dpf_1_1Operator.xhtml) &stream\_provider, [Operator](classansys_1_1dpf_1_1Operator.xhtml) &timefreq\_support\_provider, [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) meshScoping, [Location](structansys_1_1dpf_1_1Location.xhtml) requested\_location, int cs\_id) [Result](classansys_1_1dpf_1_1Result.xhtml#a0087535ae7c95ba3720b5875ad54025b) (const char \*res\_name, [Operator](classansys_1_1dpf_1_1Operator.xhtml) &stream\_provider, [Operator](classansys_1_1dpf_1_1Operator.xhtml) &timefreq\_support\_provider, [Operator](classansys_1_1dpf_1_1Operator.xhtml) &mesh\_provider, const char \*named\_selection, [Location](structansys_1_1dpf_1_1Location.xhtml) requested\_location, bool bInclusive, int cs\_id) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [EvaluateAtGivenTime](classansys_1_1dpf_1_1Result.xhtml#ac8e07e03eba295dacfe13a100603d5c4) (double dTime, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &error) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [EvaluateAtGivenTimeIndex](classansys_1_1dpf_1_1Result.xhtml#aaf145866535c0773a9ba3524b1f65743) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) iSet, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &error) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [EvaluateAtGivenStepIndexAndSubStep](classansys_1_1dpf_1_1Result.xhtml#af60979c0660e293e0eff722767939814) ([dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) iStep, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) iSubStep, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &error) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [EvaluateAmplitudeAtGivenTime](classansys_1_1dpf_1_1Result.xhtml#a439090991ae8107589374384bfca4933) (double dTime, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &error) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [EvaluateAmplitudeAtGivenTimeIndex](classansys_1_1dpf_1_1Result.xhtml#a3df1f87059794e3ff557ccc63b99b171) (int iSet, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &error) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [EvaluateAmplitudeAtGivenStepIndexAndSubStep](classansys_1_1dpf_1_1Result.xhtml#a5e672dee634e76b8a9782cdfab42461b) (int iStep, int iSubStep, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &error) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [EvaluateWithPhaseAtGivenTime](classansys_1_1dpf_1_1Result.xhtml#a53d7529964052d14a60ee1d53f6d1d06) (double dTime, double dPhase, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &error) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [EvaluateWithPhaseAtGivenTimeIndex](classansys_1_1dpf_1_1Result.xhtml#ae1d940c0f56673f96d91716dc736d17f) (int iSet, double dPhase, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &error) [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) [EvaluateWithPhaseAtGivenStepIndexAndSubStep](classansys_1_1dpf_1_1Result.xhtml#a75a2c05527109af736a19ca1156d85a2) (int iStep, int iSubStep, double dPhase, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) &error) ## Detailed Description Encapsulation of results. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#_a85), [ModelTest.cpp](ModelTest_8cpp-example.xhtml#_a41), and [ResultTest.cpp](ResultTest_8cpp-example.xhtml#_a21). ## Constructor & Destructor Documentation ## [◆ ](#a73de9b4b151118e388e2985a4c88fa4a)Result() \[1/4\] ansys::dpf::Result::Result ( const char \* *res\_name*, [Operator](classansys_1_1dpf_1_1Operator.xhtml) & *stream\_provider*, [Operator](classansys_1_1dpf_1_1Operator.xhtml) & *timefreq\_support\_provider* ) inline Create a new result from res\_name using given stream and timefreq. Parameters \[in\]res\_nameName of result on which to create result. \[in\]stream\_providerStream from which to create result. \[in\]timefreq\_support\_providerTime/frequency from which to create result. ## [◆ ](#a83f9071125be65acbd5319b0e9f44699)Result() \[2/4\] ansys::dpf::Result::Result ( const char \* *res\_name*, [Operator](classansys_1_1dpf_1_1Operator.xhtml) & *stream\_provider*, [Operator](classansys_1_1dpf_1_1Operator.xhtml) & *timefreq\_support\_provider*, [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) *meshScoping* ) inline Create a new result from res\_name using given stream, timefreq, and scoping. Parameters \[in\]res\_nameName of result on which to create result. \[in\]stream\_providerStream from which to create result. \[in\]timefreq\_support\_providerTime/frequency from which to create result. \[in\]meshScoping[Scoping](classansys_1_1dpf_1_1Scoping.xhtml "Define a set of entities by ids.") from which to create result. ## [◆ ](#a5ede8932a39a76dc06b9b3b1d21ed606)Result() \[3/4\] ansys::dpf::Result::Result ( const char \* *res\_name*, [Operator](classansys_1_1dpf_1_1Operator.xhtml) & *stream\_provider*, [Operator](classansys_1_1dpf_1_1Operator.xhtml) & *timefreq\_support\_provider*, [Scoping](classansys_1_1dpf_1_1Scoping.xhtml) *meshScoping*, [Location](structansys_1_1dpf_1_1Location.xhtml) *requested\_location*, int *cs\_id* ) inline Create a new result from res\_name using given stream, timefreq, scoping, and location. Parameters \[in\]res\_nameName of result on which to create result. \[in\]stream\_providerStream from which to create result. \[in\]timefreq\_support\_providerTime/frequency from which to create result. \[in\]meshScopingScoping from which to create result. \[in\]requested\_locationLocation on which to create result. \[in\]cs\_idNot used. ## [◆ ](#a0087535ae7c95ba3720b5875ad54025b)Result() \[4/4\] ansys::dpf::Result::Result ( const char \* *res\_name*, [Operator](classansys_1_1dpf_1_1Operator.xhtml) & *stream\_provider*, [Operator](classansys_1_1dpf_1_1Operator.xhtml) & *timefreq\_support\_provider*, [Operator](classansys_1_1dpf_1_1Operator.xhtml) & *mesh\_provider*, const char \* *named\_selection*, [Location](structansys_1_1dpf_1_1Location.xhtml) *requested\_location*, bool *bInclusive*, int *cs\_id* ) inline Create a new result from res\_name using given stream, timefreq, mesh, named\_selection, and location. Parameters \[in\]res\_nameName of result on which to create result. \[in\]stream\_providerStream from which to create result. \[in\]timefreq\_support\_providerTime/frequency from which to create result. \[in\]mesh\_providerMesh from which to create result. \[in\]named\_selectionNamed selection from which to create result. \[in\]requested\_locationLocation on which to create result. \[in\]bInclusiveIf named\_selection is a nodal region and location is elemental, this flag indicates to include full/partial contained elements in named\_selection. \[in\]cs\_idNot used. ## Member Function Documentation ## [◆ ](#a5e672dee634e76b8a9782cdfab42461b)EvaluateAmplitudeAtGivenStepIndexAndSubStep() [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Result::EvaluateAmplitudeAtGivenStepIndexAndSubStep ( int *iStep*, int *iSubStep*, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) & *error* ) inline Get the amplitude of the real and imaginary part of results of given [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set."). Results are evaluated at a given [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set."). This is arranged in [TimeFreqSupport::numberOfSteps](classansys_1_1dpf_1_1TimeFreqSupport.xhtml#a6b3cc037c0283450ac0234dadeddd1b6) groups of size [TimeFreqSupport::numberOfSubStepsByStepIndex](classansys_1_1dpf_1_1TimeFreqSupport.xhtml#a4333cdbfac1c49f802a9c33a18970ed5). ReturnsFieldsContainer for given step and substep index. Parameters \[in\]iStepGrouping index. \[in\]iSubStepSubgrouping index. \[out\]errorStatus of call. ## [◆ ](#a439090991ae8107589374384bfca4933)EvaluateAmplitudeAtGivenTime() [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Result::EvaluateAmplitudeAtGivenTime ( double *dTime*, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) & *error* ) inline Get the amplitude of the real and imaginary part of results at a given time. ReturnsFieldsContainer for given time. Parameters \[in\]dTimeTime for which to get fields. \[out\]errorStatus of call. ## [◆ ](#a3df1f87059794e3ff557ccc63b99b171)EvaluateAmplitudeAtGivenTimeIndex() [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Result::EvaluateAmplitudeAtGivenTimeIndex ( int *iSet*, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) & *error* ) inline Get the amplitude of the real and imaginary part of results of given [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set.") index. Returns[FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml "Contains a group of fields.") for given [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set.") index. Parameters \[in\]iSetIndex of [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set."). \[out\]errorStatus of call. ## [◆ ](#af60979c0660e293e0eff722767939814)EvaluateAtGivenStepIndexAndSubStep() [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Result::EvaluateAtGivenStepIndexAndSubStep ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) *iStep*, [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) *iSubStep*, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) & *error* ) inline Results are evaluated for at a given [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set."). This is arranged in [TimeFreqSupport::numberOfSteps](classansys_1_1dpf_1_1TimeFreqSupport.xhtml#a6b3cc037c0283450ac0234dadeddd1b6) groups of size [TimeFreqSupport::numberOfSubStepsByStepIndex](classansys_1_1dpf_1_1TimeFreqSupport.xhtml#a4333cdbfac1c49f802a9c33a18970ed5). ReturnsFieldsContainer for given step and substep index. Parameters \[in\]iStepGrouping index. \[in\]iSubStepSubgrouping index. \[out\]errorStatus of call. ## [◆ ](#ac8e07e03eba295dacfe13a100603d5c4)EvaluateAtGivenTime() [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Result::EvaluateAtGivenTime ( double *dTime*, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) & *error* ) inline Get the fields associated with results at a given time. ReturnsFieldsContainer for given time. Parameters \[in\]dTimeTime for which to get fields. \[out\]errorStatus of call. Examples[DataApis.cpp](DataApis_8cpp-example.xhtml#a87), and [ModelTest.cpp](ModelTest_8cpp-example.xhtml#a45). ## [◆ ](#aaf145866535c0773a9ba3524b1f65743)EvaluateAtGivenTimeIndex() [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Result::EvaluateAtGivenTimeIndex ( [dp\_int](namespaceansys_1_1dpf.xhtml#a60d181a1f9d29cc7cc38b25dac4401f0) *iSet*, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) & *error* ) inline Get the fields associated with results at given [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set.") index. ReturnsFieldsContainer for given time/frequency index. Parameters \[in\]iSetIndex of [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set."). \[out\]errorStatus of call. Examples[ResultTest.cpp](ResultTest_8cpp-example.xhtml#a23). ## [◆ ](#a75a2c05527109af736a19ca1156d85a2)EvaluateWithPhaseAtGivenStepIndexAndSubStep() [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Result::EvaluateWithPhaseAtGivenStepIndexAndSubStep ( int *iStep*, int *iSubStep*, double *dPhase*, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) & *error* ) inline Get the sweeping phase at given [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set.") and phase. Results are evaluated at a given [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set."). This is arranged in [TimeFreqSupport::numberOfSteps](classansys_1_1dpf_1_1TimeFreqSupport.xhtml#a6b3cc037c0283450ac0234dadeddd1b6) groups of size [TimeFreqSupport::numberOfSubStepsByStepIndex](classansys_1_1dpf_1_1TimeFreqSupport.xhtml#a4333cdbfac1c49f802a9c33a18970ed5). ReturnsFieldsContainer for given step and substep index and phase. Parameters \[in\]iStepGrouping index. \[in\]iSubStepSubgrouping index. \[in\]dPhasePhase angle measured in degrees. \[out\]errorStatus of call. ## [◆ ](#a53d7529964052d14a60ee1d53f6d1d06)EvaluateWithPhaseAtGivenTime() [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Result::EvaluateWithPhaseAtGivenTime ( double *dTime*, double *dPhase*, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) & *error* ) inline Get the sweeping phase at a given time and phase. ReturnsFieldsContainer for given time and phase. Parameters \[in\]dTimeTime for which to get fields. \[in\]dPhasePhase angle measured in degrees. \[out\]errorStatus of call. ## [◆ ](#ae1d940c0f56673f96d91716dc736d17f)EvaluateWithPhaseAtGivenTimeIndex() [FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml) ansys::dpf::Result::EvaluateWithPhaseAtGivenTimeIndex ( int *iSet*, double *dPhase*, [DpfError](classansys_1_1dpf_1_1DpfError.xhtml) & *error* ) inline Get the sweeping phase at given [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set.") index and phase Returns[FieldsContainer](classansys_1_1dpf_1_1FieldsContainer.xhtml "Contains a group of fields.") for given [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set.") index and phase. Parameters \[in\]iSetIndex of [TimeFreqSupport](classansys_1_1dpf_1_1TimeFreqSupport.xhtml "Define a time/frequency set."). \[in\]dPhasePhase angle measured in degrees. \[out\]errorStatus of call.