Description

This function interpolates a value at user supplied position x,y,z from a 3D Grid Wall type ARN (produced by a 3D Box detector entity).

Syntax

interpVal = ARNInterpolateCellValue3D( arn3D, xpos, ypos, zpos, quantity, isOut )

Parameters

interpVal (Double)

Returned interpolated value from arn3D.

arn3D As Long

Node number of the 3D Grid Wall type ARN whose value at position (apos,bpos,cpos) is being interpolated.

xpos As Double

X position in the coordinate system of the ARN whose value is being interpolated.

ypos As Double

Y position in the coordinate system of the ARN whose value is being interpolated.

zpos As Double

Z position in the coordinate system of the ARN whose value is being interpolated.

quantity As Long

Integer indicating which cell quantity of the 3D Grid Wall ARN is being interpolated.  Allowed options are:

isOut As Boolean

After the function executes, the value of this variable indicates whether the supplied x,y,z position was out of bounds (True) or not (False).

Example

The example below queries a 3D Grid Wall type ARN for its interpolated value at position 0,0,0 in the ARN coordinate system and then reports the result to the output window.

Sub Main

    Dim arn3D As Long

    arn3D = ARNFindName( "Box 1 - HiRes - 1" )

    Dim interpVal As Double, xpos As Double,  ypos As Double, zpos As Double

    Dim isOut As Boolean

    Dim quantity As Long

    xpos      = 0

    ypos      = 0

    zpos      = 0

    quantity  = 0 'Absorbed flux

    interpVal = ARNInterpolateCellValue3D( arn3D, xpos, ypos, zpos, quantity, isOut )

    Print "Position" & Chr(9) & "X" & Chr(9) & "Y" & Chr(9) & "Z"

    Print Chr(9) & xpos & Chr(9) & ypos & Chr(9) & zpos

    Print "Interpolated value: " & interpVal

    Print "Out of bounds?: " & isOut

End Sub

See Also

All ARN Scripting Commands