Currently the model has three diffusion and viscous parameters, if #175 is implemented it will have four.
The current ones are:
ah horizontal thickness diffusivity
ar linear drag between layers (for the momentum equations)
au horizontal viscosity for the momentum equations
Including vertical diffusion of thickness requires another parameter. If we follow this naming scheme it could be az implying vertical thickness diffusion.
However, I think it would be preferable to introduce a distinction between viscous parameters (that affect the momentum equations for u and v) and thickness diffusivities (that affect the equation for h). To that end I propose:
using the a prefix to signify viscous parameters for the momentum equations, which means
keeping au as the horizontal viscosity
keeping ar as the linear momentum drag between layers
using a k prefix to signify thickness diffusivities, which requires
renaming ah to kh everywhere in the code and documentation
when implementing #175, add a new diffusivity kv
This represents a breaking change, and if we follow semantic versioning would therefore require incrementing the major version number. However, since the model is still in the 0.X phase of development, I'd prefer not to do that.
edoddridge
commented
6 years ago
Currently the model has three diffusion and viscous parameters, if #175 is implemented it will have four.
The current ones are:
ahhorizontal thickness diffusivityarlinear drag between layers (for the momentum equations)auhorizontal viscosity for the momentum equationsIncluding vertical diffusion of thickness requires another parameter. If we follow this naming scheme it could be
azimplying vertical thickness diffusion.However, I think it would be preferable to introduce a distinction between viscous parameters (that affect the momentum equations for
uandv) and thickness diffusivities (that affect the equation forh). To that end I propose:aprefix to signify viscous parameters for the momentum equations, which meansauas the horizontal viscosityaras the linear momentum drag between layerskprefix to signify thickness diffusivities, which requiresahtokheverywhere in the code and documentationkvThis represents a breaking change, and if we follow semantic versioning would therefore require incrementing the major version number. However, since the model is still in the 0.X phase of development, I'd prefer not to do that.