`RAOutputData`#

class ansys.rocky.app.ra_output_data.RAOutputData(id: str, model_id: str | None = None)#

Bases: ansys.rocky.app.api_element_item.ApiElementItem

Rocky PrePost Scripting wrapper to manipulate the Output Data.

output_data = study.GetOutputData()
# To enabled/disabled individual properties:
output_data.SetStandardOutputPropertyEnabled('Geometries', 'Area : Cell', enabled=False)
# To enabled/disabled all properties under a root parent:
output_data.SetStandardOutputPropertyEnabled('Geometries', enabled=False)

Overview#

Constructors

`GetWrappedClass`
`GetClassName`

Methods

`GetStandardOutputPropertyEnabled`	Retrieve enable state of given “Standard Output Property”.
`SetStandardOutputPropertyEnabled`	Set enable state of given “Standard Output Property”.
`GetAdditionalOutputPropertyEnabled`	Retrieve enable state of given “Additional Output Property”.
`SetAdditionalOutputPropertyEnabled`	Set enable state of given “Additional Output Property”.
`GetModulesOutputPropertyEnabled`	Retrieve enable state of given “Modules Output Property”.
`SetModulesOutputPropertyEnabled`	Set enable state of given “Modules Output Property”.
`GetStandardOutputPropertiesData`	returns: The current value of “Standard Output Properties”.
`SetStandardOutputPropertiesData`	Set the current value of “Standard Output Properties”.
`GetModulesOutputPropertiesData`	returns: The current value of “Modules Output Properties”.
`SetModulesOutputPropertiesData`	Set the current value of “Modules Output Properties”.
`RestoreOutputPropertiesDefaults`	Restore default values of “Output Properties”.
`GetCollectJointData`	Get the value of “Collect Joint Data”.
`SetCollectJointData`	Set the value of “Collect Joint Data”.
`EnableCollectJointData`	Set the value of “Collect Joint Data” to True.
`DisableCollectJointData`	Set the value of “Collect Joint Data” to False.
`IsCollectJointDataEnabled`	Check if the “Collect Joint Data” is enabled.
`GetCollectContactsData`	Get the value of “Collect Contacts Data”.
`SetCollectContactsData`	Set the value of “Collect Contacts Data”.
`EnableCollectContactsData`	Set the value of “Collect Contacts Data” to True.
`DisableCollectContactsData`	Set the value of “Collect Contacts Data” to False.
`IsCollectContactsDataEnabled`	Check if the “Collect Contacts Data” is enabled.
`GetIncludeAdhesiveContacts`	Get the value of “Include Adhesive Contacts”.
`SetIncludeAdhesiveContacts`	Set the value of “Include Adhesive Contacts”.
`EnableIncludeAdhesiveContacts`	Set the value of “Include Adhesive Contacts” to True.
`DisableIncludeAdhesiveContacts`	Set the value of “Include Adhesive Contacts” to False.
`IsIncludeAdhesiveContactsEnabled`	Check if the “Include Adhesive Contacts” is enabled.
`GetSphEulerianSolutionEnabled`	Delegates the method to the project sph settings.
`SetSphEulerianSolutionEnabled`	Delegate the method to the project sph settings.
`EnableSphEulerianSolution`	Set the value of “Eulerian Solution” to True.
`DisableSphEulerianSolution`	Set the value of “Eulerian Solution” to False.
`IsSphEulerianSolutionEnabled`	Check if the “Eulerian Solution” is enabled.

Static methods

`GetAvailableStandardOutputProperties`	returns: The available “Standard Output Properties”.
`GetAvailableModulesOutputProperties`	returns: The available “Modules Output Properties”.

Import detail#

from ansys.rocky.app.ra_output_data import RAOutputData

Method detail#

classmethod RAOutputData.GetWrappedClass() → type#

classmethod RAOutputData.GetClassName() → str#

RAOutputData.GetStandardOutputPropertyEnabled(*output_property: str) → bool#

Retrieve enable state of given “Standard Output Property”.

Parameters:: output_property – The output property name.

RAOutputData.SetStandardOutputPropertyEnabled(*output_property: str, enabled: bool) → None#

Set enable state of given “Standard Output Property”.

Parameters:

output_property – The output property name.
enabled – The enable state of given “Standard Output Property”.

RAOutputData.GetAdditionalOutputPropertyEnabled(*output_property: str) → bool#

Retrieve enable state of given “Additional Output Property”.

Parameters:: output_property – The output property name.

RAOutputData.SetAdditionalOutputPropertyEnabled(*output_property: str, enabled: bool) → None#

Set enable state of given “Additional Output Property”.

Parameters:

output_property – The output property name.
enabled – The enable state of given “Additional Output Property”.

RAOutputData.GetModulesOutputPropertyEnabled(*output_property: str) → bool#

Retrieve enable state of given “Modules Output Property”.

Parameters:: output_property – The output property name.

RAOutputData.SetModulesOutputPropertyEnabled(*output_property: str, enabled: bool) → None#

Set enable state of given “Modules Output Property”.

Parameters:

output_property – The output property name.
enabled – The enable state of given “Modules Output Property”.

static RAOutputData.GetAvailableStandardOutputProperties() → dict#

Returns:: The available “Standard Output Properties”.

static RAOutputData.GetAvailableModulesOutputProperties() → dict#

Returns:: The available “Modules Output Properties”.

RAOutputData.GetStandardOutputPropertiesData() → dict#

Returns:: The current value of “Standard Output Properties”.

RAOutputData.SetStandardOutputPropertiesData(data_dict: dict) → None#

Set the current value of “Standard Output Properties”.

Parameters:: data_dict – The data dictionary to set.

RAOutputData.GetModulesOutputPropertiesData() → dict#

Returns:: The current value of “Modules Output Properties”.

RAOutputData.SetModulesOutputPropertiesData(data_dict: dict) → None#

Set the current value of “Modules Output Properties”.

Parameters:: data_dict – The data dictionary to set.

RAOutputData.RestoreOutputPropertiesDefaults() → None#: Restore default values of “Output Properties”.

RAOutputData.GetCollectJointData() → bool#: Get the value of “Collect Joint Data”.

RAOutputData.SetCollectJointData(value: bool) → None#

Set the value of “Collect Joint Data”.

Parameters:: value – The value to set.

RAOutputData.EnableCollectJointData() → None#: Set the value of “Collect Joint Data” to True.

RAOutputData.DisableCollectJointData() → None#: Set the value of “Collect Joint Data” to False.

RAOutputData.IsCollectJointDataEnabled() → bool#: Check if the “Collect Joint Data” is enabled.

RAOutputData.GetCollectContactsData() → bool#: Get the value of “Collect Contacts Data”.

RAOutputData.SetCollectContactsData(value: bool) → None#

Set the value of “Collect Contacts Data”.

Parameters:: value – The value to set.

RAOutputData.EnableCollectContactsData() → None#: Set the value of “Collect Contacts Data” to True.

RAOutputData.DisableCollectContactsData() → None#: Set the value of “Collect Contacts Data” to False.

RAOutputData.IsCollectContactsDataEnabled() → bool#: Check if the “Collect Contacts Data” is enabled.

RAOutputData.GetIncludeAdhesiveContacts() → bool#: Get the value of “Include Adhesive Contacts”.

RAOutputData.SetIncludeAdhesiveContacts(value: bool) → None#

Set the value of “Include Adhesive Contacts”.

Parameters:: value – The value to set.

RAOutputData.EnableIncludeAdhesiveContacts() → None#: Set the value of “Include Adhesive Contacts” to True.

RAOutputData.DisableIncludeAdhesiveContacts() → None#: Set the value of “Include Adhesive Contacts” to False.

RAOutputData.IsIncludeAdhesiveContactsEnabled() → bool#: Check if the “Include Adhesive Contacts” is enabled.

RAOutputData.GetSphEulerianSolutionEnabled() → bool#: Delegates the method to the project sph settings.

RAOutputData.SetSphEulerianSolutionEnabled(value: bool) → None#

Delegate the method to the project sph settings.

Parameters:: value – The value to set.

RAOutputData.EnableSphEulerianSolution() → None#: Set the value of “Eulerian Solution” to True.

RAOutputData.DisableSphEulerianSolution() → None#: Set the value of “Eulerian Solution” to False.

RAOutputData.IsSphEulerianSolutionEnabled() → bool#: Check if the “Eulerian Solution” is enabled.

RAOutputData#

Overview#

Import detail#

Method detail#

`RAOutputData`#