WVModelOutputFile

A WVModelOutputFile represents a file to be written to disk and has one or more output groups

---

Declaration

WVModelOutputFile < handle

Overview

A WVModelOutputFile represents a file to be written to disk, that may or may not have been created yet, depending on the model time. The ncfile property therefore may be empty if a NetCDF file is not yet created for writing.

A WVModelOutputFile holds onto one or more output groups, instances of WVModelOutputGroup, and internally they orchestrate pausing the model and writing to groups

Usage

You probably do not ever need to initialize a WVModelOutputFile directly, but instead should use the convenience method defined in WVModel,

outputFile = model.addNewOutputFile("myfile.nc");

At this stage the file contains no output groups and will not write anything to file. You can now add output groups to the file. Most users will want to simply use

outputFile = model.createNetCDFFileForModelOutput("myfile.nc",outputInterval=86400);

which will additionally add the evenly-spaced output group and record the wave-vortex coefficients.

Topics

• Properties
  • didInitializeStorage boolean indicating whether or not the internal structure of the NetCDF file has been created
  • filename name of the current (or future) NetCDF file
  • model reference to the WVModel being used
  • ncfile reference to the NetCDFFile being used for model output
  • outputGroups array of WVModelOutputGroups that will be written to file
  • path current (or future) path of the NetCDF file
  • tInitialize time at which the NetCDF file will be created
  • wvt pass-through of the wvt instance
• Internal
  • closeNetCDFFile closes the netcdf file after informing the output groups
  • initializeOutputFile tells the output groups to initialize themselves in the NetCDF file
  • observingSystemWillWriteWaveVortexCoefficients A simple check to see if one of the observing systems will be writing wave-vortex coefficients
  • outputTimesForIntegrationPeriod returns a unique, ordered array of the aggregate output times during the requested integration period.
  • recordNetCDFFileHistory tells the output groups to log this time step in the NetCDF history
  • writeTimeStepToOutputFile tells the output groups to write data at time t
• Initialization
  • WVModelOutputFile initialize a WVModelOutputFile
  • modelOutputFileFromFile create a WVModelOutputFile from an existing NetCDFFile
• Output groups
  • addNewEvenlySpacedOutputGroup add an evenly-spaced output group to this file
  • addObservingSystem add an observing system to the ouput group (if there is only one group)
  • addOutputGroup add an output group to this file
  • outputGroupNames retrieve the names of all output group names
  • outputGroupWithName retrieve a WVModelOutputGroup by name

---