`SourceSurface`#

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

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_parametersOptional[ ansys.speos.core.generic.parameters.SurfaceSourceParameters] = None: If defined the values in the SourceSurface instance will be overwritten by the values of the data class.

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_parameters (Optional[ansys.speos.core.generic.parameters.SurfaceSourceParameters])

Overview#

Methods

`set_flux_from_intensity_file`	Take flux from intensity file provided.
`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.
`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

`visual_data`	Property containing Surface source visualization data.
`flux`	Flux property of the Surface source.
`intensity`	Intensity property.
`flux_variation_file_uri`	Location of the flux variation file.
`relative_lag`	Relative lag.
`spectrum`	Spectrum property of the Source.

Import detail#

from ansys.speos.core.source import SourceSurface

Property detail#

property SourceSurface.visual_data: ansys.speos.core.generic.visualization_methods._VisualData#

Property containing Surface source visualization data.

Returns:

ansys.speos.core.generic.visualization_methods._VisualData: Instance of VisualData Class for pyvista.PolyData of feature rays, coordinate_systems.

property SourceSurface.flux: SourceSurface#

Flux property of the Surface source.

Returns:

ansys.speos.core.source.SourceSurface.Flux: flux object of the source

property SourceSurface.intensity: ansys.speos.core.intensity.Intensity#

Intensity property.

Returns:

ansys.speos.core.intensity.Intensity: Intensity.

property SourceSurface.flux_variation_file_uri: str#

Location of the flux variation file.

This property gets or sets the flux variation file applied to the surface source. If the file uri is empty, no flux variation is applied.

Parameters:

uriUnion[str, pathlib.Path]: Flux variation file uri.

Returns:

str: Flux variation file uri.

property SourceSurface.relative_lag: float#

Relative lag.

This property gets or sets the relative lag applied to the surface source. If the flux_variation_file_uri is not set, setting the relative lag will raise an error.

Parameters:

relative_lagfloat: Relative lag value to apply to the surface source.

Returns:

float: Relative lag.

property SourceSurface.spectrum: ansys.speos.core.spectrum.Spectrum#

Spectrum property of the Source.

Returns:

ansys.speos.core.spectrum.Spectrum: Spectrum.

Method detail#

SourceSurface.set_flux_from_intensity_file()#

Take flux from intensity file provided.

Returns:

ansys.speos.core.source.SourceSurface: Surface source.

SourceSurface.set_exitance_constant()#

Set existence constant.

Returns:

ansys.speos.core.source.SourceSurface.ExitanceConstant: ExitanceConstant of 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.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#

`Flux`	Different types of flux including luminous flux of intensity.
`ExitanceConstant`	Type of surface source existence : existence constant.
`ExitanceVariable`	Type of surface source existence : existence variable.