Using GRBoondi

We assume you were successful in compiling the examples and test units, ensuring your setup works properly.

Here we aim to give a broad outline of using GRBoondi and how it is structured. If you still have further questions after reading these pages, feel free to contact us. It should be noted that GRBoondi is not meant to be a black box. A large effort was put in to crafting succinct comments in the code, to help elucidate what is happening. Should you have suggestions or comments on the in-code documentation, please reach out to us!

Here we will elucidate:

• Running the tests. This allows you to check for yourself the correctness of GRBoondi and verify your setup is correct and functioning.
• Running the Examples. You can run the builtin examples to 1) again verify the code works as intended and 2) mess around with the code to get a general understanding of what goes in to building and executing a simulation.
• Mesh Refinement. This will succintly spell out how to properly setup your fixed/dynamical grid and how to tune your grid refinement for your problem.
• Existing tools. This page spells out the tools available to users builtin to GRBoondi.
• Creating your own Simulation. This will introduce you to building your very own simulation from scratch.
• Where is everything?. The overall structure of the code will be elucidated here. Though the folder and file structure of GRBoondi should be clear, this will help you find everything.
• Creating your workspace. This will help you create your simulation directory.
• Additions to source code. Here the methodology of creating additional source files will be explained.
• Hands on example with generalized Proca. This will explain in a hand-on way how to create a new simulation using an existing example.
• Updating your Branch. Retrieving the most up-to-date code from the GRBoondi repo is explained here.
• Testing. Generals tips and recommendations for testing your code and ensuring proper convergence is explained here.
• Making Plots explains how to use GRBoondi's inbuilt visualization tools.

For code formatting and performance optimization guides, check out GRChombo's wiki pages, specifically the performance optimization page and the clang format page. GRBoondi comes shipped with its own clang format file, so when using clang-format, use GRBoondi's file for this purpose. Additionally, we use clang-format version 13.

Since GRBoondi is a derivative of GRChombo, all their debugging tools are applicable to GRBoondi as well, See this wiki page.