ClimaLand.jl icon indicating copy to clipboard operation
ClimaLand.jl copied to clipboard

add wrapper to hide dss internals

Open juliasloan25 opened this issue 1 year ago • 6 comments

Is your feature request related to a problem? Please describe. Currently, when a user is running a mixed implicit/explicit simulation, we require them to construct a ClimaTimeSteppers ClimaODEFunction manually. Part of this step involves passing in the dss function (see here). Users may not know what dss is, and we want them to be able to use our model without worrying about it.

To solve this, we can create a wrapper function (e.g. make_ode_function), which takes in the tendencies, jacobian update function, and Y, and constructs the jac_kwargs as well as the ClimaODEFunction. This will isolate the usage of our ClimaLSM.dss! function and make the code more user-friendly.

cc @kmdeck

juliasloan25 avatar Aug 08 '23 23:08 juliasloan25