GroundPlane

class ansys.speos.core.ground_plane.GroundPlane(project, ground=None)

Speos feature: ground plane.

Only usable when there is at least one Ambient Environment Source in the project.

Parameters:

projectproject.Project

Project that will own the feature.

Parameters:

• project (GroundPlane.__init__.project)

• ground (Optional[ansys.speos.core.kernel.scene.ProtoScene.GroundPlane])

Overview

Methods

get	Get dictionary corresponding to the ground plane - read only.
commit	Save feature: send the local data to the speos server database.
reset	Reset feature: override local data by the one from the speos server database.
delete	Delete feature: delete data from the speos server database.

Properties

ground_origin	Ground origin.
ground_zenith	Zenith direction.
ground_height	Ground height.

Special methods

__str__

Return the string representation of the ground plane property.

Import detail

from ansys.speos.core.ground_plane import GroundPlane

Property detail

property GroundPlane.ground_origin: List[float]

Ground origin.

This property gets and sets the origin of the ground plane. Default as [0, 0, 0]

Parameters:

value: List[float]

Ground origin.

Returns:

List[float]

Ground origin.

property GroundPlane.ground_zenith: List[float]

Zenith direction.

This property gets and sets the zenith direction of the ground plane. Default as [0, 0, 1]

Parameters:

value: List[float]

Zenith direction.

Returns:

List[float]

Zenith direction.

property GroundPlane.ground_height: float

Ground height.

This property gets and sets the height of the ground plane. Default as 1000.0

Parameters:

value: float

Ground height.

Returns:

float

Ground height.

Method detail

GroundPlane.get(key='')

Get dictionary corresponding to the ground plane - read only.

Parameters:

key: str

Returns:

str | dict

GroundPlane.__str__()

Return the string representation of the ground plane property.

GroundPlane.commit()

Save feature: send the local data to the speos server database.

Returns:

ansys.speos.core.ground_plane.GroundPlane

Ground plane feature.

GroundPlane.reset()

Reset feature: override local data by the one from the speos server database.

Returns:

ansys.speos.core.ground_plane.GroundPlane

Ground plane feature.

GroundPlane.delete()

Delete feature: delete data from the speos server database.

The local data are still available

Returns:

ansys.speos.core.ground_plane.GroundPlane

Ground plane feature.