Skip to content

v0.118.0

Choose a tag to compare

@github-actions github-actions released this 12 Nov 13:23

Oceananigans v0.118.0

Diff since v0.117.2

Breaking changes

  • Lagrangian particles are advanced stage-wise with the model's time stepper (#6440). Particles now take one step per stage of RK3, QAB2 and split RK, instead of one forward-Euler step after each stage.
    • LagrangianParticleTracking.advect_particle is removed. It is split into particle_coordinate_velocity and enforce_particle_boundary_conditions; packages that extended advect_particle should extend these instead.
    • advect_lagrangian_particles!(particles, model, Δt, stage) and the _advect_particles! kernel take a stage.
    • Time steppers call the new substep_lagrangian_particles!(model, Δt, stage) at the start of each stage. step_lagrangian_particles!(particles, model, Δt) is kept. A particle type that extends only step_lagrangian_particles! is still stepped once per time step, at the first stage.
    • Model constructors should call the new materialize_lagrangian_particles(particles, timestepper), which allocates the particles' per-stage storage.
  • Oceananigans.Utils.time_difference_seconds is renamed to time_difference_in_seconds (#6443).
  • LatitudeLongitudeGrid has two new type parameters and fields, south_pole and north_pole (#6334). Code that writes out the full parameter list or constructs the grid with the positional inner constructor must be updated.
  • Simulation has a new type parameter for stop_iteration (#6357), which can now be a device number under Reactant.

New features and performance

  • BatchedTridiagonalSolver carries the Thomas sweep in registers, about 2–4% faster per time step for vertically implicit models, bitwise unchanged. A new keyword, factorized = true, stores the factorization; compute_factorization!(solver, args...) recomputes it whenever the coefficients change, and solve! then only substitutes (#6493).
  • DateTime clocks: some remaining gaps are closed (#6443).
  • Docstring signatures now show default values (#6263).

Fixes

  • The bounded vertical flux divergence scales w by the explicit fraction of adaptive implicit vertical advection (#6487).
  • Uniform tracers stay uniform at open boundaries under z★ with the split-explicit free surface (#6362).
  • Horizontal biharmonic viscosity is dissipative on PartialCellBottom grids (#6451).
  • Tripolar coordinates are computed with one call per location (#6467).

Reactant

  • stop_iteration is a device number, so a compiled run! can change its step count without recompiling (#6357).
  • Fields can be allocated inside compiled functions on LatitudeLongitudeGrid (#6334).
  • The node accessors of a ReactantState grid return host arrays (#6435).
  • KernelFunctionOperation's eltype is kept and bound when it is traced (#6375, #6473).
  • Fields can be indexed with a traced element type without ambiguity (#6453).
  • traced_type_inner methods are correctly despecialized (#6468).

Dependencies and infrastructure

  • Requires a newer CubedSphere (#6483).
  • Expensive docs examples are built only on main, on tags, or on labeled PRs (#6469).
  • Docs dependency bumps: StructArrays (#6444), Enzyme (#6464).

Closed issues:

  • xnodes/ynodes on a ReactantState LatitudeLongitudeGrid index device arrays from the host (#6325)
  • Indexing a reduced Field allocated inside a Reactant-compiled function is ambiguous (#6326)
  • Allocating a Field on a ReactantState LatitudeLongitudeGrid inside a compiled function fails at the polar boundary check (#6333)
  • Reactant: a compiled run! cannot change its step count without recompiling (#6356)