Support BoussinesqEquationOfState in NetCDFWriter

[jbisits]

Still need to add a test.
Added a test that checks that a NetCDFOutputWriter is returned when using BoussinesqEquationOfState and there is a file at the NetCDFOutputWriter 's filepath.

Closes #4251

[tomchor]

Nice catch! Thanks! Let's tag a patch version with this, please.

[tomchor]

Looks good!

[jbisits]

@tomchor did you want me to change to 0.96.1 in Project.toml?

[jbisits]

Also just a question (not for this PR and maybe never). It might be easier to maintain if the main module OceananigansNCDatasetsExt.jl is broken up into smaller scripts. You can do this by placing OceananigansNCDatasetsExt.jl inside a directory called OceananigansNCDatasetsExt then have e.g.

module OceananigansNCDatasetsExt

using NCDatasets

using Dates: AbstractTime, UTC, now
using Printf: @sprintf

using Oceananigans.Fields

using Oceananigans: initialize!, prettytime, pretty_filesize, AbstractModel
using Oceananigans.Grids: Center, Face, Flat, AbstractGrid, RectilinearGrid, LatitudeLongitudeGrid, StaticVerticalDiscretization
using Oceananigans.Grids: topology, halo_size, xspacings, yspacings, zspacings, λspacings, φspacings,
                          parent_index_range, ξnodes, ηnodes, rnodes, validate_index, peripheral_node
using Oceananigans.Fields: reduced_dimensions, reduced_location, location
using Oceananigans.AbstractOperations: KernelFunctionOperation
using Oceananigans.Models: ShallowWaterModel, LagrangianParticles
using Oceananigans.ImmersedBoundaries: ImmersedBoundaryGrid, GridFittedBottom, GFBIBG, GridFittedBoundary
using Oceananigans.TimeSteppers: float_or_date_time
using Oceananigans.BuoyancyFormulations: BuoyancyForce, BuoyancyTracer, SeawaterBuoyancy, LinearEquationOfState
using Oceananigans.Utils: TimeInterval, IterationInterval, WallTimeInterval
using Oceananigans.Utils: versioninfo_with_gpu, oceananigans_versioninfo, prettykeys

using Oceananigans.OutputWriters:
    auto_extension,
    output_averaging_schedule,
    show_averaging_schedule,
    AveragedTimeInterval,
    WindowedTimeAverage,
    NoFileSplitting,
    update_file_splitting_schedule!,
    construct_output,
    time_average_outputs,
    restrict_to_interior,
    fetch_output,
    convert_output,
    fetch_and_convert_output,
    show_array_type

import Oceananigans: write_output!
import Oceananigans.OutputWriters: NetCDFWriter

const c = Center()
const f = Face()

include("utils.jl")
include("getgrids.jl")
include("interpolation.jl")

end

The names above are just placeholders for demonstration! As I said not something that needs to be done just might thank ourselves later!

[jbisits]

Having another look I think my suggestion above would amount to putting each heading section in OceananaigansNCDatasetsExt.jl, i.e. the bits marked with

####
#### section
####

into a different script. But no problem if you prefer as is!

[glwagner]

A nice pattern for Extensions is to mirror the module names in Oceananigans, eg

module OceanaingansNCDatasetsExt

include("Grids.jl")
using .Grids

include("OutputWriters.jl")
using .OutputWriters

end

[jbisits]

@tomchor did you want me to change to 0.96.1 in Project.toml?

I did this and changed title of the PR to reflect this.

[tomchor]

@tomchor did you want me to change to 0.96.1 in Project.toml?

I did this and changed title of the PR to reflect this.

Yes, that's what I meant. Although now I think we need to bump up to 0.96.2 after tests pass.

[jbisits]

@tomchor and @navidcy the tests I added now passed so perhaps after update merging with main this PR could be merged (though now patch might need 0.96.3)?

[glwagner]

@tomchor and @navidcy the tests I added now passed so perhaps after update merging with main this PR could be merged (though now patch might need 0.96.3)?

You can bump the patch after merging, so don't let that slow you down

[glwagner]

The Reactant tests will hopefully be fixed soon, but we can merge this without them. Let me know if that's what you want and I will do it.

[jbisits]

The Reactant tests will hopefully be fixed soon, but we can merge this without them. Let me know if that's what you want and I will do it.

Yes that would be great if this could be merged! Thanks very much!