ResultInfo#

class ansys.dpf.core.result_info.physics_types(value)#

'Physics_types' enumerates the different types of physics that an analysis can have.

MECANIC#
THERMAL#
MAGNETIC#
ELECTRIC#
UNKNOWN_PHYSICS#
class ansys.dpf.core.result_info.analysis_types(value)#

'Analysis_types' enumerates the different types of analysis.

MECANIC#
THERMAL#
MAGNETIC#
ELECTRIC#
UNKNOWN_PHYSICS#
class ansys.dpf.core.result_info.ResultInfo(result_info, server=None)#

Represents the result information.

This class describes the metadata of the analysis and the available results.

Parameters

result_info (ansys.grpc.dpf.result_info_pb2.ResultInfo message) –

serveransys.dpf.core.server, optional

Server with the channel connected to the remote or local instance. The default is None, in which case an attempt is made to use the global server.

Examples

Explore the result info from the model

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> transient = examples.download_transient_result()
>>> model = dpf.Model(transient)
>>> result_info = model.metadata.result_info # printable result_info
>>> result_info.available_results[0].name
'displacement'
>>> result_info.available_results[0].homogeneity
'length'
property analysis_type#

Retrieves the analysis type.

Returns

analysis_type – Type of the analysis, such as static or transient.

Return type

str

Examples

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> transient = examples.download_transient_result()
>>> model = dpf.Model(transient)
>>> result_info = model.metadata.result_info
>>> result_info.analysis_type
'static'
property physics_type#

Type of the physics.

Examples

Mechanical result

>>> from ansys.dpf import core as dpf
>>> from ansys.dpf.core import examples
>>> transient = examples.download_transient_result()
>>> model = dpf.Model(transient)
>>> result_info = model.metadata.result_info
>>> result_info.physics_type
'mecanic'
property n_results#

Number of results.

property unit_system#

Unit system of the result.

property cyclic_symmetry_type#

Cyclic symmetry type of the result.

Returns

cyclic_symmetry_type – Cyclic symmetry type of the results. Options are "single_stage", "multi_stage", and "not_cyclic".

Return type

str

property has_cyclic#

Check the result file for cyclic symmetry.

Returns

has_cyclic – Returns True if the result file has cyclic symmetry or is multistage.

Return type

bool

property cyclic_support#

Cyclic expansion information for a result file that has cyclic symmetry or is multistage.

Returns

cyclic_support

Return type

CyclicSupport

Examples

Get a cyclic support from a model.

>>> from ansys.dpf.core import Model
>>> from ansys.dpf.core import examples
>>> multi_stage = examples.download_multi_stage_cyclic_result()
>>> model = Model(multi_stage)
>>> result_info = model.metadata.result_info
>>> cyc_support = result_info.cyclic_support
property unit_system_name#

Name of the unit system.

property solver_version#

Version of the solver.

property solver_date#

Date of the solver.

property solver_time#

Time of the solver.

property user_name#

Name of the user.

property job_name#

Name of the job.

property product_name#

Name of the product.

property main_title#

Main title.

property available_results#

Available results, containing all information about results present in the result files.

Returns

available_result

Return type

list[AvailableResult]