New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docstring needed for `ShallowWaterScalarDiffusivity` #2939

Closed

navidcy opened this issue Feb 22, 2023 · 0 comments · Fixed by #2941

Labels

documentation 📜

Collaborator

navidcy commented Feb 22, 2023

Oceananigans.jl/src/Models/ShallowWaterModels/shallow_water_diffusion_operators.jl

Lines 28 to 32 in 56309fc

    
           function ShallowWaterScalarDiffusivity(FT::DataType=Float64; ν=0, ξ=0, discrete_form = false)  
        
               ν = convert_diffusivity(FT, ν; discrete_form) 
        
               ξ = convert_diffusivity(FT, ξ; discrete_form) 
        
               return ShallowWaterScalarDiffusivity(ν, ξ) 
        
           end

navidcy added the documentation 📜 label

navidcy mentioned this issue

Docstring for ShallowWaterScalarDiffusivity #2941

Merged

navidcy closed this as completed in #2941

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment