SourceAmbientUsStandard

class ansys.speos.core.source.SourceAmbientUsStandard(project, name, description='', metadata=None, source_instance=None, default_parameters=None)

Bases: BaseSourceAmbient

U.S. Standard atmosphere ambient source.

By default, [0, 0, 1] is used as zenith direction, [0, 1, 0] as north direction, and sun type is set to automatic.

Parameters:

projectansys.speos.core.project.Project

Project that will own the feature.

namestr

Name of the feature.

descriptionstr

Description of the feature. By default, "".

metadataOptional[Mapping[str, str]]

Metadata of the feature. By default, {}.

default_parametersOptional[ ansys.speos.core.generic.parameters.AmbientUsStandardParameters] = None

If defined the values in the SourceAmbientUsStandard instance

will be overwritten by the values of the data class.

Parameters:

• project (SourceAmbientUsStandard.__init__.project)

• name (str)

• description (str)

• metadata (Optional[Mapping[str, str]])

• source_instance (Optional[ansys.speos.core.kernel.scene.ProtoScene.SourceInstance])

• default_parameters (Optional[ansys.speos.core.generic.parameters.AmbientUsStandardParameters])

Overview

Methods

set_sun_automatic	Set U.S. Standard sun type as automatic.
set_sun_manual	Set U.S. Standard sun type as manual.

Properties

zenith_direction	Zenith direction of the U.S. Standard ambient source.
reverse_zenith_direction	Reverse zenith direction flag of the U.S. Standard ambient source.
north_direction	North direction of the U.S. Standard ambient source.
reverse_north_direction	Reverse north direction flag of the U.S. Standard ambient source.

Import detail

from ansys.speos.core.source import SourceAmbientUsStandard

Property detail

property SourceAmbientUsStandard.zenith_direction: List[float]

Zenith direction of the U.S. Standard ambient source.

Returns:

List[float]

Direction defining the zenith.

property SourceAmbientUsStandard.reverse_zenith_direction: bool

Reverse zenith direction flag of the U.S. Standard ambient source.

Returns:

bool

True to reverse zenith direction, False otherwise.

property SourceAmbientUsStandard.north_direction: List[float]

North direction of the U.S. Standard ambient source.

Returns:

List[float]

Direction defining north.

property SourceAmbientUsStandard.reverse_north_direction: bool

Reverse north direction flag of the U.S. Standard ambient source.

Returns:

bool

True to reverse north direction, False otherwise.

Method detail

SourceAmbientUsStandard.set_sun_automatic()

Set U.S. Standard sun type as automatic.

Returns:

ansys.speos.core.source.BaseSourceAmbient.AutomaticSun

Sun automatic type feature to complete.

SourceAmbientUsStandard.set_sun_manual()

Set U.S. Standard sun type as manual.

Returns:

ansys.speos.core.source.BaseSourceAmbient.Manual

Sun manual type feature to complete.