WVModelOutputGroup

A WVModelOutputGroup represents a group of observing system to be written to file at particular output times

---

Declaration

WVModelOutputFile < handle

Overview

A WVModelOutputGroup encapsulates a netcdf group with particular output times t; it has one or more observing systems that get written to the group at those times.

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

The reason for this abstraction is that some observing systems do not have evenly spaced output intervals, e.g., the AlongTrackSimulator, and it is often the case that one might want to sample the model for a short interval at higher frequency, e.g., sampling a mooring at high frequency to resolve the buoyancy frequency, or running a tracer experiment for 24 hours in the middle of a long model run.

Usage

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

Topics

• Properties
  • didInitializeStorage boolean indicating whether or not the internal structure of the NetCDF file has been created
  • model Reference to the WVModel being used
  • name of the current (or future) group in the NetCDF file
• Observing systems
  • addObservingSystem add an observing system to this file
  • observingSystemWithName retrieve an observing system by name
  • observingSystems array of WVObservingSystem that will be written to the group
  • removeObservingSystem remove an observing system to this file
• Required subclass overrides
  • outputTimesForIntegrationPeriod returns a unique, ordered array of the aggregate output times during the requested integration period.
• Internal
  • closeNetCDFFile notification that the NetCDF file will close
  • initObservingSystemsFromGroup asks the output group to load the observing systems in the NetCDF file
  • initializeOutputGroup initializes a new output group in the NetCDF file
  • recordNetCDFFileHistory losg this time step in the NetCDF history
  • writeTimeStepToNetCDFFile writes data at time t
• Initialization
  • WVModelOutputGroup initialize a WVModelOutputGroup
  • modelOutputGroupFromGroup initialize a WVModelOutputGroup instance from NetCDF file
• Writing to NetCDF files
  • group Reference to the NetCDFGroup being used for model output
• Integration
  • incrementsWrittenToGroup output index of the current/most recent step.
  • timeOfLastIncrementWrittenToGroup output index of the current/most recent step.

---