WVModelOutputGroup

Schedule observing systems into one NetCDF output group.

---

Declaration

WVModelOutputGroup < handle

Overview

A WVModelOutputGroup contains one or more observing systems and defines the model times at which their state is written.

The simplest output group is the WVModelOutputGroupEvenlySpaced which, as the name suggests, writes outputs at an evenly spaced interval.

Separate groups allow different observing systems to use different schedules or bounded output windows within the same file. This matters when an observing system does not sample evenly, such as a satellite along-track simulator, or when one diagnostic needs a shorter, higher-frequency window than the rest of a long model run. For example, a mooring may need to resolve the buoyancy frequency, while a tracer experiment may run for only 24 hours in the middle of the simulation.

Usage

outputFile = model.addNewOutputFile("myfile.nc");
outputGroup = WVModelOutputGroupEvenlySpaced(model,name="high-temporal-resolution",initialTime=wvt.t,outputInterval=wvt.inertialPeriod/20);
outputFile.addOutputGroup(outputGroup);

Topics

• Create model output
  • WVModelOutputGroup initialize a WVModelOutputGroup
• Manage output observers
  • addObservingSystem add an observing system to this file
  • initObservingSystemsFromGroup asks the output group to load the observing systems in the NetCDF file
  • removeObservingSystem remove an observing system to this file
• Write and close output
  • closeNetCDFFile notification that the NetCDF file will close
  • initializeOutputGroup initializes a new output group in the NetCDF file
  • writeTimeStepToNetCDFFile writes 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
  • didInitializeStorage boolean indicating whether or not the internal structure of the NetCDF file has been created
  • group Reference to the NetCDFGroup being used for model output
  • incrementsWrittenToGroup output index of the current/most recent step.
  • modelOutputGroupFromGroup initialize a WVModelOutputGroup instance from NetCDF file
  • outputTimesForIntegrationPeriod returns a unique, ordered array of the aggregate output times during the requested integration period.
  • recordNetCDFFileHistory losg this time step in the NetCDF history
  • timeOfLastIncrementWrittenToGroup output index of the current/most recent step.
• Output internals
  • model Reference to the WVModel being used
  • name of the current (or future) group in the NetCDF file
  • observingSystemWithName retrieve an observing system by name
  • observingSystems array of WVObservingSystem that will be written to the group

---