Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 1.63 KB

README.md

File metadata and controls

58 lines (42 loc) · 1.63 KB
Raw

License: MIT

convect-py

Welcome! Here is my Python code to simulate 2D convection in a Cartesian box. Theory and methods used can be found in Introduction to Modeling Convection in Planets and Stars: Magnetic Field, Density Stratification, Rotation.

Getting Started

Pre-requisites

Package structure

convect-py
    docs/
    scripts/
      convect_nonlinear.py
    src/
        data_utils.py
        postprocess.py
        routines.py
    LICENSE.md
    README.md

Examples

Nonlinear convection

  1. Open scripts/convect_nonlinear.py

  2. Specify input parameters

# Inputs
nz = 101 # no. of vertical gridpoints
nn = 50 # no. of Fourier modes (excluding zeroth mode)
a = 3 # L/D aspect ratio
Ra = 1e6 # Rayleigh number
Pr = 0.5 # Prandtl number
dt = 3e-6 # timestep size
nt = 1e4 # no. of timesteps
nout = 1e2 # save output every nout timesteps
initOn = 1 # initialise run, otherwise load existing data
saveDir = "/Users/wongj/Documents/convect-out/2021-09-03" # save directory
  1. Run script from terminal using python <working directory>/convect-jl/src/convect_nonlinear.py (or from IPython using %run <working directory>/convect-jl/src/convect_nonlinear.py)

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

🎉