Navigation: Scripting Reference Manual > Functions & Subroutines > ReadSourceUserRays2

 

ReadSourceUserRays2

 

Contact Us: fredsupport@photonengr.com

 

Description

Reads in a subset or all rays from a ray file into the specified User-defined source.  Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long.  Please see Multi-threaded Raytracing for more information.

 

Syntax

numRays = ReadSourceUserRays2 ( n, fname, from, to, increment )

 

Parameters

numRays (Long or Huge_)

The total number of rays in the source, or -1 if the function failed.

 

n As Long

Node number of the source.

 

fname As String

The ray file to read into FRED.

 

from As Long (or Huge_)

The ray number to begin reading at.

 

to As Long (or Huge_)

The ray number to stop reading at.  Use -1 to read to the end of the file.

 

increment As Long (or Huge_)

The number of rays to increment between reads. Setting this variable to 1 tells FRED to read every ray between from and to.

 

Remarks

Reads in a subset or all rays from a ray file into the specified User-defined source. If there is a problem the function returns -1 and does not set an error.

 

This command scales the source positions based upon units provided in the ray file header.

 

See Also

AddSourceUserRays

ReadSourceUserRays

ReadBasicRayDataFromFile

WriteBasicRayDataToFCRFile

Ray Import

ReadRaysFromFRBSFileToRayBuffer

WriteRaysFromRayBufferToFRBSFile

SetSourcePosImported

 

 

 

 

 

Copyright © Photon Engineering, LLC