SourceAmbientCieStandardGeneralSky

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

Bases: BaseSourceAmbient

CIE Standard General Sky source.

By default, luminance is set to 1000 cd/m2 [0, 0, 1] is used as zenith direction, [0, 1, 0] as north direction. Sun type is set to be automatic type. CIE type is partly cloudy sky, no gradation towards zenith, slight brightening

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.AmbientCieStandardGeneralSkyParameters] = None

If defined the values in the SourceAmbientCieStandardGeneralSky instance

will be overwritten by the values of the data class.

Parameters:

• project (SourceAmbientCieStandardGeneralSky.__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.AmbientCieStandardGeneralSkyParameters])

Overview

Methods

set_sun_automatic	Set sun type as automatic.
set_sun_manual	Set cie standard general sky sun type as manual.

Properties

luminance	Luminance of the ambient CIE standard general sky source.
cie_type	Get the CIE type.
zenith_direction	Property zenith direction of the ambient source.
reverse_zenith_direction	Property whether reverse zenith direction of the ambient CIE standard general sky source.
north_direction	Property north direction of the ambient CIE standard general sky.
reverse_north_direction	Property whether reverse north direction of the ambient CIE standard general sky.

Import detail

from ansys.speos.core.source import SourceAmbientCieStandardGeneralSky

Property detail

property SourceAmbientCieStandardGeneralSky.luminance: float

Luminance of the ambient CIE standard general sky source.

Parameters:

valuefloat

Luminance value in cd/m^2.

Returns:

float

Luminance value in cd/m^2.

property SourceAmbientCieStandardGeneralSky.cie_type: ansys.speos.core.generic.parameters.CieType

Get the CIE type.

Parameters:

ansys.speos.core.generic.parameters.CieType

allowed type parameter values:

standard_overcast overcast_steep_gradation overcast_azimuthal_uniformity overcast_slight_brightening uniform_luminance cloudy_slight_brightening cloudy_nogradation_circumsolar cloudy_solar_corona cloudy_obscured_sun cloudy_circumsolar_region white_blue_distinct standard_low_luminance standard_polluted_atmosphere cloudless_turbid_corona white_blue_broad

Returns:

ansys.speos.core.generic.parameters.CieType

property SourceAmbientCieStandardGeneralSky.zenith_direction: List[float]

Property zenith direction of the ambient source.

default value to be [0, 0, 1]

Parameters:

directionList[float]

direction defines the zenith direction of the ambient sky

Returns:

List[float]

direction defines the zenith direction of the ambient sky

property SourceAmbientCieStandardGeneralSky.reverse_zenith_direction: bool

Property whether reverse zenith direction of the ambient CIE standard general sky source.

default value to be False.

Parameters:

valuebool

True to reverse zenith direction, False otherwise.

Returns:

bool

True to reverse zenith direction, False otherwise.

property SourceAmbientCieStandardGeneralSky.north_direction: List[float]

Property north direction of the ambient CIE standard general sky.

default value to be [0, 1, 0].

Parameters:

directionList[float]

direction defines the north direction of the ambient CIE standard general sky

Returns:

List[float]

direction defines the north direction of the ambient CIE standard general sky

property SourceAmbientCieStandardGeneralSky.reverse_north_direction: bool

Property whether reverse north direction of the ambient CIE standard general sky.

default value to be False.

Parameters:

valuebool

True to reverse north direction, False otherwise.

Returns:

bool

True as reverse north direction, False otherwise.

Method detail

SourceAmbientCieStandardGeneralSky.set_sun_automatic()

Set sun type as automatic.

Returns:

ansys.speos.core.source.BaseSourceAmbient.AutomaticSun

Sun automatic type feature to complete.

SourceAmbientCieStandardGeneralSky.set_sun_manual()

Set cie standard general sky sun type as manual.

Returns:

ansys.speos.core.source.BaseSourceAmbient.Manual

Sun Manual type feature to complete.