Collaboration diagram for NetCDF field:

NetCDF field SimObject for loading field data from NetCDF files and looking it up by position.

Author: Biao Su

This SimObject loads a current field from a NetCDF file, either a 3-D grid or a depth profile, and returns its velocity at query positions: the value of the node at the lower corner of the position's cell, without interpolation, with positions off the grid clamped to its edge. NetcdfHandler describes the two file layouts; xc is north and u the north component. Other SimObjects find the field as the NCField shared resource (see CNCField). Supports visualization of field vectors using 3D arrows.

Note: Must be placed after Environment SimObject in XML for resource availability.

Example Configuration (XML)

<Lib
    LibName = "fhsim_environment"
    SimObject = "NetCDFField"
    Name = "NetCDF_Field"
    NetCDFFileName = "path/to/field.nc"
/>

Parameters

Name	Width	Description
NetCDFFileName	1	Path to the NetCDF field file. Mandatory. A file that cannot be read is an error.

Visualization parameters (visualization builds only)

Name	Width	Description
VisGridSize	3	Arrow grid spacing [dx, dy, dz] [m]. Arrows are drawn only when the first component is positive. (Default: -1, -1, -1)
VisGridOrigin	3	Horizontal centre [x, y] and starting z of the arrow grid [m]. Mandatory when arrows are drawn.
VisGridDimensions	3	Extent [Lx, Ly, Lz] of the arrow grid [m]. Mandatory when arrows are drawn.
VisArrowColor	3	Arrow colour [r, g, b]. (Default: 1, 0, 0)
VisArrowMaxValue	1	Field magnitude at which an arrow reaches full length. (Default: 1.0)
VisScaleNum	1	Number of depth levels in the optional radial clipping envelope. (Default: 0)
VisScaleDepth	<VisScaleNum>	Depth of each envelope level [m]. Mandatory when VisScaleNum > 0.
VisScaleRadius	<VisScaleNum>	Radius of the envelope at each level [m]; arrows outside the interpolated radius are hidden. Mandatory when VisScaleNum > 0.

This SimObject is referred to as NetCDFField