Example Proposal

[elenamiralles]

Hello Terrarium Community!

I've been exploring Terrarium (I was referred here from Oceananigans!) and I am excited to see where you all could go developing this package. I'm interested in contributing and I had an idea for an example since the example section seems a bit sparse. I wanted to check with the community to get a sense if this would be desired first!

My idea is to use Terrarium's soil heat solver to verify the numerical solution for the 1D heat equation with its known analytical solution and sinusoidal BCs.

$$\frac{\partial T}{\partial t} = \frac{k_h}{C} \frac{\partial^2 T}{\partial z^2}$$

$$T(z,t) = T_0 + A e^{-z/d} \sin(\omega t - z/d), \quad d = \sqrt{\frac{2\kappa_h}{C \omega}}$$

where $d$ is the thermal damping depth, $\kappa_h$ is thermal conductivity, $C$ is volumetric heat capacity, and $\omega$ is the angular frequency of the surface forcing.

Does this example fit the direction you have in mind for the examples section? Or are there other potential ideas that you all had?

Would love to hear feedback and help in any way I can!

[bgroenks96]

Hey @elenamiralles! Welcome, and yes you're absolutely right that our examples are quite sparse at the moment. We're working on that, and thanks a ton for offering to help out!

I think the example you propose would be great to have, and there's actually already a unit test that does this, so it's actually a perfect way for you to get started. Feel free to use that code as a basis and modify it however you like (also let me know if you find any mistakes).

Please don't hesitate to drop a comment here or in an issue if you encounter any difficulties or have any questions, big or small.

[elenamiralles]

Thank you! I'll get started.