SourceRayFile

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

Bases: BaseSource

RayFile Source.

By default, flux and spectrum from ray file are selected.

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

If defined the values in the SourceRayFile instance will be overwritten by the values of the data class.

Parameters:

• project (SourceRayFile.__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.RayFileSourceParameters])

Overview

Methods

set_flux_from_ray_file	Take flux from ray file provided.
set_spectrum_from_ray_file	Take spectrum from ray file provided.
set_exit_geometries	Set exit geometries.

Properties

visual_data	Property containing Rayfile source visualization data.
ray_file_uri	Ray file URI.
flux	Flux definition of the Rayfile source.
spectrum	Spectrum property of the Source.
axis_system	Axis system of the Source.

Import detail

from ansys.speos.core.source import SourceRayFile

Property detail

property SourceRayFile.visual_data: ansys.speos.core.generic.visualization_methods._VisualData

Property containing Rayfile source visualization data.

Returns:

ansys.speos.core.generic.visualization_methods._VisualData

Instance of VisualData Class for pyvista.PolyData of feature rays, coordinate_systems.

property SourceRayFile.ray_file_uri: str

Ray file URI.

This property retrieve and defines the file uri of ray file used.

Parameters:

uriUnion[pathlib.Path, str]

Ray file URI.

Returns:

str

Ray file URI.

property SourceRayFile.flux: BaseSource

Flux definition of the Rayfile source.

Returns:

ansys.speos.core.source.BaseSource.Flux

flux object of the source

property SourceRayFile.spectrum: ansys.speos.core.spectrum.Spectrum

Spectrum property of the Source.

Returns:

ansys.speos.core.spectrum.Spectrum

Spectrum.

property SourceRayFile.axis_system: List[float]

Axis system of the Source.

This property retrieve and defines the axis system of the source.

Parameters:

axis_systemList[float]

Position of the rayfile source [Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz]. By default, [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1].

Returns:

List[float]

Position of the rayfile source [Ox Oy Oz Xx Xy Xz Yx Yy Yz Zx Zy Zz]. By default, [0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1].

Method detail

SourceRayFile.set_flux_from_ray_file()

Take flux from ray file provided.

Returns:

ansys.speos.core.source.SourceRayFile

RayFile source.

SourceRayFile.set_spectrum_from_ray_file()

Take spectrum from ray file provided.

Returns:

ansys.speos.core.source.SourceRayFile

RayFile source.

SourceRayFile.set_exit_geometries()

Set exit geometries.

Returns:

ansys.speos.core.source.SourceRayFile.ExitGeometries

ExitGeometries settings of rayfile source.

Classes

ExitGeometries

ExitGeometries of rayfile source.