Navigation: Scripting Reference Manual > Functions & Subroutines > VectorFieldToARN

 

VectorFieldToARN

 

Contact Us: fredsupport@photonengr.com

 

Description

Computes the vector field using an analysis surface and returns the results to an ARN.  Incoherent or Coherent unpolarized rays are ignored.  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 = VectorFieldToARN( anaNode, arnName, arnNode )

 

 

Parameters

numRays (Long or Huge_)

Number of rays included in the analysis.

 

anaNode As Long

Node number of the analysis surface to be used in the analysis.  The analysis surface's ray filters are applied.

 

arnName As String

Name of the ARN being created.

 

arnNode As Long

Node number of the newly created ARN.  Returned by the function.

 

 

Remarks

The following example performs an energy density calculation on an existing rayset.

 

Dim anaNode As Long

Dim arnNode As Long

Dim numRays As Long

 

anaNode = FindFullName( "Analysis Surface(s).Analysis 1" )

numRays = VectorFieldToARN( anaNode, "Example ARN", arnNode )

 

 

Multiple wavelengths

When a coherent field calculation encounters multiple wavelengths, the calculation will proceed using only the first wavelength which satisfies the ray filter criteria.  A warning dialog will be displayed which provides the wavelength range and the value used in the calculation (to 7 significant digits).  All other wavelengths are ignored.

 

See Also

VectorField

VectorFieldToFile

VectorFieldToFileAS

 

 

 

 

 

Copyright © Photon Engineering, LLC