SpatialAnalysisToolVolumeGridFactory

class ansys.stk.core.analysis_workbench.SpatialAnalysisToolVolumeGridFactory

The factory is used to create instances of volume grids.

Overview

Methods

create	Create and registers a volume grid using specified name and description.
create_cartesian	Create and registers a cartesian volume grid type using specified name and description.
is_type_supported	Return whether the specified type is supported.
create_cylindrical	Create and registers a cylindrical volume grid type using specified name and description.
create_spherical	Create and registers a spherical volume grid type using specified name and description.
create_constrained	Create and registers a volume grid of type that can be constrained by conditions using specified name and description.
create_latitude_longitude_altitude	Create and registers cartographic volume grid type using specified name and description.
create_bearing_altitude	Create and registers a volume grid of type surface bearing using specified name and description.

Import detail

from ansys.stk.core.analysis_workbench import SpatialAnalysisToolVolumeGridFactory

Method detail

SpatialAnalysisToolVolumeGridFactory.create(self, name: str, description: str, type: VolumeGridType) → ISpatialAnalysisToolVolumeGrid

Create and registers a volume grid using specified name and description.

Parameters:

name : str

description : str

type : VolumeGridType

Returns:

ISpatialAnalysisToolVolumeGrid

SpatialAnalysisToolVolumeGridFactory.create_cartesian(self, name: str, description: str) → ISpatialAnalysisToolVolumeGrid

Create and registers a cartesian volume grid type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolumeGrid

SpatialAnalysisToolVolumeGridFactory.is_type_supported(self, type: VolumeGridType) → bool

Return whether the specified type is supported.

Parameters:

type : VolumeGridType

Returns:

bool

SpatialAnalysisToolVolumeGridFactory.create_cylindrical(self, name: str, description: str) → ISpatialAnalysisToolVolumeGrid

Create and registers a cylindrical volume grid type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolumeGrid

SpatialAnalysisToolVolumeGridFactory.create_spherical(self, name: str, description: str) → ISpatialAnalysisToolVolumeGrid

Create and registers a spherical volume grid type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolumeGrid

SpatialAnalysisToolVolumeGridFactory.create_constrained(self, name: str, description: str) → ISpatialAnalysisToolVolumeGrid

Create and registers a volume grid of type that can be constrained by conditions using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolumeGrid

SpatialAnalysisToolVolumeGridFactory.create_latitude_longitude_altitude(self, name: str, description: str) → ISpatialAnalysisToolVolumeGrid

Create and registers cartographic volume grid type using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolumeGrid

SpatialAnalysisToolVolumeGridFactory.create_bearing_altitude(self, name: str, description: str) → ISpatialAnalysisToolVolumeGrid

Create and registers a volume grid of type surface bearing using specified name and description.

Parameters:

name : str

description : str

Returns:

ISpatialAnalysisToolVolumeGrid