WVModel

The WVModel is responsible for time-stepping (integrating) the ocean state forward in time, as represented by a WVTransform.

---

Overview

Assuming you have already initialized a WVTransform, e.g.,

 wvt = WVTransformConstantStratification([Lx, Ly, Lz], [Nx, Ny, Nz], N0,latitude=latitude);

and maybe set some initial conditions, you can then initialize the model,

 model = WVModel(wvt)

By default the model only takes a linear time-step. To specify a nonlinear flux on initialization, for example,

 model = WVModel(wvt);

You can also initialize a model from existing output,

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

Advanced usage ————–

1. Create 1 or more NetCDFFiles
2. Add 1 or more WVModelOutputGroups to each file
3. Add 1 or more WVObservingSystems to each output group.

Topics

• Initialization
  • WVModel Initialize a model from a WVTransform instance
  • modelFromFile Initialize a model from an existing file
• Model Properties
  • initialTime Initial model time (seconds)
  • isDynamicsLinear Indicates whether or not the model is using linear or nonlinear dynamics.
  • t Current model time (seconds)
  • wvt The WVTransform instance the represents the ocean state.
• Integration
  • integrateToTime Time step the model forward to the requested time.
  • setupIntegrator Customize the time-stepping
• 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.
• Tracer
  • addTracer Add a scalar field tracer to be advected by the flow
  • tracer Scalar field of the requested tracer at the current model time.
• Writing to NetCDF files
  • 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
  • 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.
• Integrated (fluxed) observing systems
  • addFluxedCoefficients add the WVCoefficients to the fluxed observing systems array
  • addFluxedObservingSystem add a WVObservingSystem to the fluxed observing systems array
  • fluxedObservingSystemWithName retrieve a WVObservingSystem by name
  • removeFluxedObservingSystem remove a WVObservingSystem to the fluxed observing systems array
  • wvCoefficientFluxedObservingSystem return the WVCoefficients fluxed observing system
• Other
  • absErrorToleranceCellArray
  • closeNetCDFFile
  • defaultOutputGroupName
  • didBlowUp
  • didSetupIntegrator
  • eulerianObservingSystem
  • finalIntegrationTime set only during an integration
  • fluxAtTimeCellArray
  • fluxedObservingSystems
  • indicesForFluxedSystem
  • initialConditionsCellArray
  • integrationCallback
  • integrationInformTime
  • integrationLastInformModelTime
  • integrationLastInformWallTime wall clock, to keep track of the expected integration time
  • integrationStartModelTime
  • integrationStartWallTime
  • integratorType Array integrator
  • nFluxComponents
  • nFluxComputations
  • nFluxComputationsAtLastInform
  • outputTimesForIntegrationPeriod This will be called exactly once before an integration
  • pseudoIntegrateToTime Time step the model forward linearly
  • recomputeIndicesForFluxedSystems
  • recordNetCDFFileHistory
  • shouldShowIntegrationDiagnostics
  • showIntegrationFinishDiagnostics
  • showIntegrationStartDiagnostics
  • showIntegrationTimeDiagnostics
  • summarize
  • updateIntegratorValuesFromCellArray We must set the time here. If we are integrating the
  • writeTimeStepToNetCDFFile

---