Navigation: Scripting Reference Manual > Functions & Subroutines > SetSourcePosGrid

 

SetSourcePosGrid

 

Contact Us: fredsupport@photonengr.com

 

Description

Sets the data for a source with a Grid Plane ray position type.

 

Syntax

SetSourcePosGrid n, semiWidthX, semiWidthY, numX, numY, isEllipse

 

Parameters

n As Long

Node number of the source.

 

semiWidthX As Double

The new semi aperture of the ray positions in the X direction.

 

semiWidthY As Double

The new semi aperture of the ray positions in the Y direction.

 

numX As Long

The new number of rays across in the X direction.

 

numY As Long

The new number of rays across in the Y direction.

 

isEllipse As Boolean

The new aperture shape. Set to True for elliptical apertures, False for rectangular ones.

 

Remarks

This subroutine sets the data for a source with a Grid Plane ray position type, i.e. a planar grid of rays arranged in a rectangular pattern. If there is a problem the function returns without modifying the source and does not set an error.

 

See Also

IsSourcePosGrid

GetSourcePosGrid

Examples

Sources

 

 

 

 

 

 

Copyright © Photon Engineering, LLC