WVModelOutputFile

Organize one NetCDF output file for a WVModel.

---

Declaration

WVModelOutputFile < handle

Overview

A WVModelOutputFile owns the writable NetCDF handle and one or more output groups. The file is opened when its first group initializes, so ncfile may be empty before output begins.

Most users create a configured file through WVModel:

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

This adds an evenly spaced output group containing the wave-vortex coefficients. For explicit control, first create an empty file description and then add one or more groups:

outputFile = model.addNewOutputFile("myfile.nc");
outputGroup = outputFile.addNewEvenlySpacedOutputGroup( ...
"daily",initialTime=model.t,outputInterval=86400);

An empty output file has no schedule and writes nothing until a group is added. The physical NetCDF file is created lazily at the first scheduled output time, so ncfile remains empty beforehand. Close the file through the model or output-file facade when writing is complete.

Topics

• Create model output
  • WVModelOutputFile initialize a WVModelOutputFile
• Manage output observers
  • addObservingSystem add an observing system to the ouput group (if there is only one group)
• Write and close output
  • closeNetCDFFile closes the netcdf file after informing the output groups
  • initializeOutputFile tells the output groups to initialize themselves in the NetCDF file
  • writeTimeStepToOutputFile tells the output groups to write data at time t

Developer Topics

These items document internal implementation details and are not part of the primary public API.

• Output persistence and scheduling
  • addNewEvenlySpacedOutputGroup add an evenly-spaced output group to this file
  • addOutputGroup add an output group to this file
  • 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
  • modelOutputFileFromFile create a WVModelOutputFile from an existing NetCDFFile
  • ncfile reference to the NetCDFFile being used for model output
  • outputGroupNames retrieve the names of all output group names
  • outputGroupWithName retrieve a WVModelOutputGroup by name
  • outputGroups array of WVModelOutputGroups that will be written to file
  • 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
• Output internals
  • model reference to the WVModel being used
  • observingSystemWillWriteWaveVortexCoefficients A simple check to see if one of the observing systems will be writing wave-vortex coefficients
  • 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

---