WVObservingSystem

Observe or integrate additional state alongside a WVModel.

---

Declaration

WVObservingSystem < handle

Overview

WVObservingSystem is the base class for Eulerian fields, wave-vortex coefficients, particles, moorings, and tracers. An observing system belongs to one model. Systems with flux components participate in numerical integration; other systems sample model state when requested or written to output.

Topics

• Create an observing system
  • WVObservingSystem Initialize an observing system for a model.
• Inspect observed state
  • description
  • model reference to the WVModel being used
  • name of the observing system
  • wvt reference to the WVModel being used
• Advance the observing system
  • fluxAtTime return a cell array of the flux of the variables being
  • initialConditions return a cell array of variables that need to be integrated

Developer Topics

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

• Observing-system internals
  • absErrorTolerance return a cell array of the absolute tolerances of the
  • portableImplementationContract Describe availability of the paired portable C++ implementation.
  • updateIntegratorValues passes updated values of the variables being integrated.
• Observing-system persistence
  • initializeStorage called once to allow the observing system to initialize its storage space in the NetCDFGroup
  • observingSystemFromGroup initialize a WVObservingSystem instance from NetCDF file
  • writeTimeStepToFile called at each time for the observing system to write to file
• Observer integration
  • lengthOfFluxComponents return an array containing the numel of each flux component.
  • nFluxComponents number of components that need to be integrated in time.

---