Description

Writes the cell data from a 3D Grid Wall analysis results node to a collection of files in "Brick of Values" format.  This format can be read into the VisIt visualization package and is suitable for processing by custom software programs.

Syntax

bFlag = ARNExportToBOVFiles( arnNode, fNameBase )

Parameters

bFlag (Boolean)

Returned boolean flag indicating successful export (True) or failure (False).

arnNode As Long

Node number of the 3D Grid Wall analysis result node whose cell data is being exported.

fName As String

Base file name for the output files generated.  Output files with the *.bov extension contain header information while those with the *.dat extension contain the cell data values.  The following files will be written:

fName_Absorbed.bov

fName_Absorbed.dat

fName_InFlux.bov

fName_InFlux.dat

fName_OutFlux.bov

fName_OutFlux.dat

Example

The following example traces a set of rays, retrieves the ARN produced by a 3D Box detector entity and then writes the result to a set of BOV files.

Sub Main

    'Delete existing rays and ARNs, trace new rayset

    DeleteRays()

    ARNDeleteAllNodes()

    TraceCreate

    'Retrieve the ARN created by 3D Box detector entity

    Dim Box3dDe As Long, arnNode As Long

    Box3dDe = FindFullName( "Analysis Surface(s).Detector Entity - 1x1" )

    arnNode = DEGetMostRecentARNNum( Box3dDe )

    'Export result to BOV files

    Dim success As Boolean

    Dim fNameBase As String

    fNameBase = GetDocDir() & "\3dGridWallResult"

    success = ARNExportToBOVFiles( arnNode, fNameBase )

    If success Then

        Print "ARN successfully saved to BOV files."

    Else

        Print "ARN not saved to BOV files."

    End If

End Sub

See Also

All ARN Scripting Commands