Table of Contents
Coding conventions
- Use the snake_case naming convention.
- The first word of each function call refers to the file in which it is defined.
- The lines should not exceed 80 cols.
- Tab is equivalent to 3 spaces.
- Segregate the sections using “!————!”.
- Segregate the functions using “!=============!”.
- Add comments to the right of the code.
- Comments are in CAPS.
Variable names
| eq_grid_* | Equilibrium grid from g-file data |
| eq_psi_grid_* | Equilibrium psi-grid from g-file data |
| profile_grid_* | Profile grid from “profile.dat” |
| grid_* | Simulation grid generated by G2C3 |
| mid_grid_* | Simulation grid in the middle of the toroidal domain for $\nabla_{||}$ computation |
| psi_grid_* | Outer mid-plane grid generated by G2C3 |
| inner_grid_* | Inner simulation grid boundary generated by G2C3 |
| outer_grid_* | Outer simulation grid boundary generated by G2C3 |
Based on grids
| rlim, zlim | Limiter grid |
| rbbbs, zbbbs | Container boundary grid |
Based on input
ID's (Depends on MPI)
| mpi_id | MPI-core number |
| pp_id | Poloidal plane number |
| pp_zeta | Zeta value at the poloidal plane |
| prev_mpi_id | next_mpi_id |
| prev_pp_id | next_pp_id |
Spline variables
| spline_<grid_type>_* | Arrays for 3rd order spline interpolation |
Particles
| num_axis | 7 |
|---|---|
| r_axis | 1 |
| z_axis | 2 |
| t_axis | 3 |
| vp_axis | 4 |
| df_axis | 5 |
| mu_axis | 6 |
| tri_axis | 7 |
Counting
Dimensions
Function names
File names
UPDATES
- Please log all your updates in “UPDATE.txt”, along with the dates.
- Also, log any issues you encounter, with a clear description.
Do's and Don'ts
