Skip to main content

DPF Cpp Client Library 2026 R1

Class ansys::dpf::ResultInfo

Last update: 25.03.2026

Provides information on all available results

Inherits from:

Inner classes

Members

Public types

Enumeration type analysis_type

enum analysis_type {
  eStatic = 0,
  eBukling = 1,
  eModal = 2,
  eHarmonic = 3,
  eCMS = 4,
  eTransient = 5,
  eMSUP = 6,
  eSubStruct = 7,
  eSpectrum = 8,
  eUnknownAnalysis = 9,
  ePSD = 10
}

Analysis Type.

Enumerator eStatic

Static.

Enumerator eBukling

Bukling.

Enumerator eModal

Modal.

Enumerator eHarmonic

Harmonic.

Enumerator eCMS

CMS.

Enumerator eTransient

Transient.

Enumerator eMSUP

MSUP.

Enumerator eSubStruct

SubStruct.

Enumerator eSpectrum

Spectrum.

Enumerator eUnknownAnalysis

Unknown analysis type.

Enumerator ePSD

PSD.

Enumeration type physics_type

enum physics_type {
  eMecanic = 0,
  eThermal = 1,
  eMagnetic = 2,
  eElectric = 3,
  eFluid = 5,
  eUnknownPhysics = 4
}

Physics Type.

Enumerator eMecanic

Mechanical.

Enumerator eThermal

Thermal.

Enumerator eMagnetic

Magnetic.

Enumerator eElectric

Electric.

Enumerator eFluid

Fluid.

Enumerator eUnknownPhysics

Unknown physics type.

Friends

Public functions

Function ResultInfo

ansys::dpf::ResultInfo::ResultInfo(analysis_type const &analysis_type=analysis_type::eUnknownAnalysis, physics_type const &physics_type=physics_type::eUnknownPhysics)

Parameters:

Return type:

Function ~ResultInfo

virtual ansys::dpf::ResultInfo::~ResultInfo()

Return type:

Function ResultInfo

ansys::dpf::ResultInfo::ResultInfo(ResultInfo const &)

Parameters:

  • ResultInfo const &

Return type:

Function ResultInfo

ansys::dpf::ResultInfo::ResultInfo(ResultInfo &&) noexcept

Parameters:

  • ResultInfo &&

Return type:

Function operator=

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

Parameters:

  • ResultInfo const &

Return type: ResultInfo &

Function operator=

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

Parameters:

  • ResultInfo &&

Return type: ResultInfo &

Function analysisType

analysis_type ansys::dpf::ResultInfo::analysisType() const

Returns:

Analysis type for all results.

Return type: analysis_type

Function physicsType

physics_type ansys::dpf::ResultInfo::physicsType() const

Returns:

Phyiscs type for all results.

Return type: physics_type

Function unitSystem

UnitSystem ansys::dpf::ResultInfo::unitSystem() const

Returns:

Unit system for all results.

Return type: UnitSystem

Function analysisTypeName

std::string ansys::dpf::ResultInfo::analysisTypeName() const

Returns:

Analysis type name for all results.

Return type: std::string

Function physicsTypeName

std::string ansys::dpf::ResultInfo::physicsTypeName() const

Returns:

Phyiscs type name for all results.

Return type: std::string

Function unitSystemName

std::string ansys::dpf::ResultInfo::unitSystemName() const

Returns:

Unit system name for all results.

Return type: std::string

Function numberOfResults

dp_int ansys::dpf::ResultInfo::numberOfResults() const

Returns:

Number of results.

Return type: dp_int

Function availableResults

std::set< std::string > ansys::dpf::ResultInfo::availableResults() const

The result name might be something like temperature. Returns:

Set of names for all results.

Return type: std::set< std::string >

Function resultNameByOperatorName

std::string ansys::dpf::ResultInfo::resultNameByOperatorName(std::string const &op_name) const

For a result name like Temperature, the operator name might be something like TEMP. Returns:

Name of result

Parameters:

  • std::string const & op_name: [in] Operator name.

Return type: std::string

Function operatorName

std::string ansys::dpf::ResultInfo::operatorName(std::string const &res_name) const

The operator name might be something like TEMP, where the result name is Temperature. Returns:

Operator name

Parameters:

  • std::string const & res_name: [in] Result name.

Return type: std::string

Function scriptingName

std::string ansys::dpf::ResultInfo::scriptingName(std::string const &res_name) const

The operator scripting name is used to instantiate the operator in scripting, ex: displacement, elastic_strain... Returns:

Operator scripting name

Parameters:

  • std::string const & res_name: [in] Result name.

Return type: std::string

Function unit

ansys::dpf::Unit ansys::dpf::ResultInfo::unit(std::string const &res_name) const

Returns:

Unit for given result name.

Parameters:

  • std::string const & res_name: [in] Result name.

Return type: ansys::dpf::Unit

Function numberOfComponents

dp_int ansys::dpf::ResultInfo::numberOfComponents(std::string const &res_name) const

Returns:

Number of components for given result name.

Parameters:

  • std::string const & res_name: [in] Result name.

Return type: dp_int

Function description

std::string ansys::dpf::ResultInfo::description(std::string const &res_name) const

Returns:

Description of given result name.

Parameters:

  • std::string const & res_name: [in] Result name.

Return type: std::string

Function location

ansys::dpf::Location ansys::dpf::ResultInfo::location(std::string const &res_name) const

Returns:

Location of given result name.

Parameters:

  • std::string const & res_name: [in] Result name.

Return type: ansys::dpf::Location

Function nature

Dimensionality::ENature ansys::dpf::ResultInfo::nature(std::string const &res_name) const

Returns:

Nature for given result name.

Parameters:

  • std::string const & res_name: [in] Result name.

Return type: Dimensionality::ENature

Function qualifiers

LabelSpacesVector ansys::dpf::ResultInfo::qualifiers(std::string const &res_name) const

Parameters:

  • std::string const & res_name: [in] Result name.

Return type: LabelSpacesVector

Function numberOfSubResults

dp_int ansys::dpf::ResultInfo::numberOfSubResults(std::string const &res_name) const

Returns:

Number of subresults for given result name.

Parameters:

  • std::string const & res_name: [in] Result name.

Return type: dp_int

Function availableSubResults

std::set< std::string > ansys::dpf::ResultInfo::availableSubResults(std::string const &res_name) const

Returns:

Set of names of subresults for given result name.

Parameters:

  • std::string const & res_name: [in] Result name.

Return type: std::set< std::string >

Function subResultOperatorName

std::string ansys::dpf::ResultInfo::subResultOperatorName(std::string const &res_name, std::string const &subres_name) const

Returns:

Operator name for given subresult name of given result name

Parameters:

  • std::string const & res_name: [in] Result name.
  • std::string const & subres_name: [in] Subresult name.

Return type: std::string

Function subResultDescription

std::string ansys::dpf::ResultInfo::subResultDescription(std::string const &res_name, std::string const &subres_name) const

Returns:

Description for given subresult name of given result name.

Parameters:

  • std::string const & res_name: [in] Result name.
  • std::string const & subres_name: [in] Subresult name.

Return type: std::string

Function operatorNameIsAvailable

bool ansys::dpf::ResultInfo::operatorNameIsAvailable(std::string const &op_name) const

Returns:

Indication that operator is available within results and subresults.

Parameters:

  • std::string const & op_name: [in] Operator name.

Return type: bool

Function solver_version

void ansys::dpf::ResultInfo::solver_version(int &major_version, int &minor_version) const

Gets solver version.

Parameters:

  • int & major_version: [out] Major version.
  • int & minor_version: [out] Minor version.

Return type: void

Function solve_date_time

void ansys::dpf::ResultInfo::solve_date_time(int &solve_date, int &solve_time) const

Gets solver date and time.

Parameters:

  • int & solve_date: [out] Date.
  • int & solve_time: [out] Time.

Return type: void

Function user_name

std::string ansys::dpf::ResultInfo::user_name() const

Returns:

User name.

Return type: std::string

Function job_name

std::string ansys::dpf::ResultInfo::job_name() const

Returns:

Job name.

Return type: std::string

Function product_name

std::string ansys::dpf::ResultInfo::product_name() const

Returns:

Product name.

Return type: std::string

Function main_title

std::string ansys::dpf::ResultInfo::main_title() const

Returns:

Main title.

Return type: std::string

Function getCyclicSupport

CyclicSupport ansys::dpf::ResultInfo::getCyclicSupport() const

Returns:

the cyclic support if the result file has cyclic symmetry (or multistage). The CyclicSupport contains information relevant for cyclic expansion

Return type: CyclicSupport

Function hasCyclicSymmetry

bool ansys::dpf::ResultInfo::hasCyclicSymmetry(std::string &cyc_symmetry_type) const

Returns:

true if the result file has cyclic symmetry (or multistage)

Parameters:

  • std::string & cyc_symmetry_type: [out] "single_stage", "multi_stage" or "not_cyclic".

Return type: bool

Function hasCyclicSymmetry

bool ansys::dpf::ResultInfo::hasCyclicSymmetry() const

Returns:

true if the result file has cyclic symmetry (or multistage)

Return type: bool

Function getStringProperty

std::string ansys::dpf::ResultInfo::getStringProperty(std::string const &property_name) const

Returns:

a property value: most common are 'user_name', 'job_name', 'product_name', 'main_title', 'cyclic_symmetry_type'.

Parameters:

  • std::string const & property_name

Return type: std::string

Function getIntProperty

int ansys::dpf::ResultInfo::getIntProperty(std::string const &property_name) const

Returns:

a property value: most common are 'solve_time', 'solve_date', 'solver_minor_version', 'solver_major_version'.

Parameters:

  • std::string const & property_name

Return type: int

Function availableQualifierLabels

std::vector< std::string > ansys::dpf::ResultInfo::availableQualifierLabels() const

Return type: std::vector< std::string >

Function qualifierTypeSupport

ansys::dpf::Support ansys::dpf::ResultInfo::qualifierTypeSupport(ansys::dpf::Label const &qualifier) const

Returns:

Support describing the Domain definition of the qualifier type.

Parameters:

  • ansys::dpf::Label const & qualifier: [in] Label describing the location of the qualifier: ex phase, species...

Return type: ansys::dpf::Support

Function setUnitSystem

void ansys::dpf::ResultInfo::setUnitSystem(UnitSystem const &unit_system)

Set the unit system.

Parameters:

Return type: void

Function addResult

void ansys::dpf::ResultInfo::addResult(std::string const &operator_name, std::string const &scripting_name, ansys::dpf::Dimensionality dimensionality, ansys::dpf::Location const &location, ansys::dpf::Homogeneity const &homogeneity, std::string const &description="")

Add a result.

Parameters:

Return type: void

Function addResult

void ansys::dpf::ResultInfo::addResult(Result const &res)

Add a result.

Parameters:

  • Result const & res

Return type: void

Function addProperties

void ansys::dpf::ResultInfo::addProperties(std::vector< std::pair< std::string, std::string > >const &properties)

Parameters:

  • std::vector< std::pair< std::string, std::string > >const & properties: [in] Most common are 'user_name', 'job_name', 'product_name', 'main_title', 'cyclic_symmetry_type'.

Return type: void

Function addProperties

void ansys::dpf::ResultInfo::addProperties(std::vector< std::pair< std::string, int > >const &properties)

Parameters:

  • std::vector< std::pair< std::string, int > >const & properties: [in] Most common are: 'solve_time', 'solve_date', 'solver_minor_version', 'solver_major_version'.

Return type: void

Function addAvailableQualifiersForAllResults

void ansys::dpf::ResultInfo::addAvailableQualifiersForAllResults(LabelSpacesVector const &available_qualifiers)

Set the available sub qualifiers (or domains) available for all Results in the ResultInfo.

Parameters:

  • LabelSpacesVector const & available_qualifiers

Return type: void

Function setQualifierLabelSupport

void ansys::dpf::ResultInfo::setQualifierLabelSupport(ansys::dpf::Label const &qualifier, ansys::dpf::Support const &support)

Describe the Domain definition for a given qualifier.

Parameters:

Return type: void

Public static functions

Function emptyResultInfo

static ResultInfo ansys::dpf::ResultInfo::emptyResultInfo()

Return type: ResultInfo

Connect with Ansys