WVModel

Integrate a fluid state represented by a WVTransform.

---

Declaration

classdef WVModel < handle

Overview

Construct a transform and use it to initialize the model:

wvt = WVTransformConstantStratification([40e3,30e3,2e3],[8,6,9],N0=5.2e-3,latitude=45);
model = WVModel(wvt);

By default WVModel integrates the transform’s nonlinear forcing and registers its coefficient observing system. Pass shouldUseLinearDynamics=true for analytical linear evolution. Use setupIntegrator to change time-stepping settings.

Model output is assembled in three layers: a model owns one or more WVModelOutputFile objects, each file contains one or more WVModelOutputGroup schedules, and each group writes one or more WVObservingSystem objects. Observing systems with flux components, including coefficients, particles, and tracers, are integrated alongside the transform state; other observing systems sample it at output times.

Restore a model and its output graph from one restart-capable file:

model = WVModel.modelFromFile("SomeFile.nc");

Topics

• Create and restore a model
  • WVModel Initialize a model from a WVTransform instance.
  • modelFromFile Initialize a model from an existing file
• Inspect model state
  • initialTime Initial model time (seconds)
  • isDynamicsLinear Whether the model uses analytical linear dynamics.
  • summarize Print a summary of integrated systems and output files.
  • t Current model time (seconds)
  • wvt WVTransform instance representing the ocean state.
• Configure and run integration
  • integrateToTime Time step the model forward to the requested time.
  • setupIntegrator Customize the time-stepping
• Track particles
  • addParticles Add particles to be advected by the flow.
  • drifterPositions Current positions of the drifter particles
  • floatPositions Returns the positions of the floats at the current time as well as the value of the fields being tracked.
  • particlePositions Positions and values of tracked fields of particles at the current model time.
  • setDrifterPositions Set positions of drifter-like particles to be advected.
  • setFloatPositions Set positions of float-like particles to be advected by the model.
• Advect tracers
  • addTracer Add a scalar field tracer to be advected by the flow
  • tracer Scalar field of the requested tracer at the current model time.
• Manage observing systems
  • addFluxedCoefficients add the WVCoefficients to the fluxed observing systems array
  • addFluxedObservingSystem add a WVObservingSystem to the fluxed observing systems array
  • eulerianObservingSystem
  • fluxedObservingSystemWithName retrieve a WVObservingSystem by name
  • fluxedObservingSystems
  • removeFluxedObservingSystem remove a WVObservingSystem to the fluxed observing systems array
  • wvCoefficientFluxedObservingSystem return the WVCoefficients fluxed observing system
• Write model output
  • addNetCDFOutputVariables Add variables to list of variables to be written to the NetCDF variable during the model run.
  • addNewOutputFile add a WVModelOutputFile, by passing an output path
  • addOutputFile add a WVModelOutputFile, by passing a WVModelOutputFile instance
  • closeNetCDFFile
  • createNetCDFFileForModelOutput Create a NetCDF file for model output
  • ncfile returns the first/primary NetCDF file being written to
  • outputFileNames retrieve the names of all output files
  • outputFileWithName retrieve a WVModelOutputFile by name
  • outputFiles Array of WVModelOutputFile instances
  • removeNetCDFOutputVariables Remove variables from the list of variables to be written to the NetCDF variable during the model run.
  • setNetCDFOutputVariables Set list of variables to be written to the NetCDF variable during the model run.

Developer Topics

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

• Integrator state
  • absErrorToleranceCellArray
  • didBlowUp
  • didSetupIntegrator
  • finalIntegrationTime set only during an integration
  • integrationCallback
  • integrationInformTime
  • integrationLastInformModelTime
  • integrationLastInformWallTime wall clock, to keep track of the expected integration time
  • integrationStartModelTime
  • integrationStartWallTime
  • integratorType Array integrator
  • outputTimesForIntegrationPeriod This will be called exactly once before an integration
  • pseudoIntegrateToTime Time step the model forward linearly
  • shouldShowIntegrationDiagnostics
  • showIntegrationFinishDiagnostics
  • showIntegrationStartDiagnostics
  • showIntegrationTimeDiagnostics
  • updateIntegratorValuesFromCellArray We must set the time here. If we are integrating the
• Flux assembly
  • fluxAtTimeCellArray
  • indicesForFluxedSystem
  • nFluxComponents
  • nFluxComputations
  • nFluxComputationsAtLastInform
  • recomputeIndicesForFluxedSystems
• Output scheduling and persistence
  • defaultOutputGroupName
  • recordNetCDFFileHistory
  • writeTimeStepToNetCDFFile
• Model internals
  • initialConditionsCellArray
  • writePortableRunRequest Write a portable-runtime request for a MATLAB-authored NetCDF bundle.

---