Volumetric#

class ansys.stk.core.stkobjects.Volumetric#

Bases: ISTKObject, ILifetimeInformation

The Volumetric class.

Overview#

set_volume_grid_definition_type

Set volume grid definition type, using the VolumetricDefinitionType enumeration.

compute

Compute computations for Volumetric.

clear

Clear computations for Volumetric.

get_volumetric_export_tool

Volumetric export tool.

compute_in_parallel

Compute computations in parallel for Volumetric.

volume_grid_definition_type

Get Volume Grid definition type. A member of the VolumetricDefinitionType enumeration.

volume_grid_definition

Get Volume Grid definition.

volume_analysis_interval

Get Volume Analysis Interval.

advanced

Get Advanced options.

graphics_3d

Get the 3D Graphics properties for the volumetric object.

Import detail#

from ansys.stk.core.stkobjects import Volumetric

Property detail#

property Volumetric.volume_grid_definition_type: VolumetricDefinitionType#

Get Volume Grid definition type. A member of the VolumetricDefinitionType enumeration.

property Volumetric.volume_grid_definition: IVolumetricGridDefinition#

Get Volume Grid definition.

property Volumetric.volume_analysis_interval: VolumetricAnalysisInterval#

Get Volume Analysis Interval.

property Volumetric.advanced: VolumetricAdvancedSettings#

Get Advanced options.

property Volumetric.graphics_3d: VolumetricGraphics3D#

Get the 3D Graphics properties for the volumetric object.

Method detail#

Volumetric.set_volume_grid_definition_type(self, vm_grid_calc_type: VolumetricDefinitionType) None#

Set volume grid definition type, using the VolumetricDefinitionType enumeration.

Parameters:

vm_grid_calc_type : VolumetricDefinitionType

Returns:

None

Volumetric.compute(self) None#

Compute computations for Volumetric.

Returns:

None

Volumetric.clear(self) None#

Clear computations for Volumetric.

Returns:

None

Volumetric.get_volumetric_export_tool(self) VolumetricExportTool#

Volumetric export tool.

Returns:

VolumetricExportTool

Volumetric.compute_in_parallel(self) None#

Compute computations in parallel for Volumetric.

Returns:

None