SourceSurface

class ansys.speos.core.source.SourceSurface(project, name, description='', metadata=None, source_instance=None, default_values=True)

Bases: BaseSource

Type of Source : Surface.

By default, a luminous flux and existence constant are chosen. With a monochromatic spectrum, and lambertian intensity (cos with N = 1).

Parameters:

speos_clientansys.speos.core.kernel.client.SpeosClient

The Speos instance client.

namestr

Name of the source feature.

surfaceansys.api.speos.source.v1.source_pb2.SourceTemplate.Surface

Surface source to complete.

surface_propsansys.api.speos.scene.v2.scene_pb2.Scene.SourceInstance.SurfaceProperties

Surface source properties to complete.

default_valuesbool

Uses default values when True.

Parameters:

• project (SourceSurface.__init__.project)

• name (str)

• description (str)

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

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

• default_values (bool)

Overview

Methods

set_flux_from_intensity_file	Take flux from intensity file provided.
set_flux_luminous	Set luminous flux.
set_flux_radiant	Set radiant flux.
set_flux_luminous_intensity	Set luminous intensity flux.
set_intensity	Set intensity.
set_exitance_constant	Set existence constant.
set_exitance_variable	Set existence variable, taken from XMP map.
set_spectrum_from_xmp_file	Take spectrum from xmp file provided.
set_spectrum	Set spectrum of the Source.
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.

Import detail

from ansys.speos.core.source import SourceSurface

Method detail

SourceSurface.set_flux_from_intensity_file()

Take flux from intensity file provided.

Returns:

ansys.speos.core.source.SourceSurface

Surface source.

SourceSurface.set_flux_luminous(value=683)

Set luminous flux.

Parameters:

valuefloat

Luminous flux in lumens. By default, 683.0.

Returns:

ansys.speos.core.source.SourceSurface

Surface source.

SourceSurface.set_flux_radiant(value=1)

Set radiant flux.

Parameters:

valuefloat

Radiant flux in watts. By default, 1.0.

Returns:

ansys.speos.core.source.SourceSurface

Surface source.

SourceSurface.set_flux_luminous_intensity(value=5)

Set luminous intensity flux.

Parameters:

valuefloat

Luminous intensity in candelas. By default, 5.0.

Returns:

ansys.speos.core.source.SourceSurface

Surface source.

SourceSurface.set_intensity()

Set intensity.

Returns:

ansys.speos.core.intensity.Intensity

Intensity.

SourceSurface.set_exitance_constant(geometries)

Set existence constant.

Parameters:

geometriesList[tuple[ansys.speos.core.geo_ref.GeoRef, bool]]

List of (face, reverseNormal).

Returns:

ansys.speos.core.source.SourceSurface

Surface source.

SourceSurface.set_exitance_variable()

Set existence variable, taken from XMP map.

Returns:

ansys.speos.core.source.SourceSurface.ExitanceVariable

ExitanceVariable of surface source.

SourceSurface.set_spectrum_from_xmp_file()

Take spectrum from xmp file provided.

Returns:

ansys.speos.core.source.SourceSurface

Surface source.

SourceSurface.set_spectrum()

Set spectrum of the Source.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum.

SourceSurface.commit()

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

Returns:

ansys.speos.core.source.SourceSurface

Source feature.

SourceSurface.reset()

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

Returns:

ansys.speos.core.source.SourceSurface

Source feature.

SourceSurface.delete()

Delete feature: delete data from the speos server database.

The local data are still available

Returns:

ansys.speos.core.source.SourceSurface

Source feature.

Classes

ExitanceVariable

Type of surface source existence : existence variable.