Navigation: Scripting Reference Manual > Functions & Subroutines > ReadSourceUserRays

 

ReadSourceUserRays

 

Contact Us: fredsupport@photonengr.com

 

Description

Reads in all the 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 = ReadSourceUserRays ( n, fname )

 

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.

 

Remarks

This function reads in all the rays from a ray file into a particular source. Calling this function is the same as calling

numRays = ReadSourceUserRays2 (id, file, 1, -1, 1) If there is a problem the function returns -1 and does not set an error.

 

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

 

See Also

AddSourceUserRays

ReadSourceUserRays2

ReadBasicRayDataFromFile

WriteBasicRayDataToFCRFile

Ray Import

ReadRaysFromFRBSFileToRayBuffer

WriteRaysFromRayBufferToFRBSFile

SetSourcePosImported

 

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC