Description

Writes the cell data from a 3D Grid Wall analysis results node to the specified file location in VTK format.  This file format can be read into software such as ParaView or VisIt.  The file extension is *.vti.

Syntax

bFlag = ARNExportToVTKFile( arnNode, fName, params )

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

Full path name of the output file being created (*.vti extension).

params As String

Parameter string identifying the quantity to export.  Options are:

"Quantity=AbsorbedFlux"

"Quantity=InFlux"

"Quantity=OutFlux"

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 VTK file.

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 VTK files

    Dim success As Boolean

    Dim fName As String

    fName = GetDocDir() & "\3dGridWallResult.vti"

    success = ARNExportToVTKFile( arnNode, fName, "Quantity=AbsorbedFlux" )

    If success Then

        Print "ARN successfully saved to a VTK file."

    Else

        Print "ARN not saved to a VTK file."

    End If

End Sub

See Also

All ARN Scripting Commands