Structure of the code (aka where is everything?)

Yes, we know, GRChombo is a big code. At first the many files will seem overwhelming, but with time you will start to learn where to find things and the structure will make (some) sense.

On this page we provide some hints on how to find your way around the code, but in the end you just have to dive in and learn as you go. Unless you are extremely proficient at coding and NR already, we strongly recommend working with a member of the collaboration who can guide you. See our website www.grchombo.org for details of members of the collaboration.

Hierarchy of GRChombo

The code is designed to have 3 main levels in its hierarchy, as follows:

1. Specific Example, e.g. BinaryBH - specific actions relevant to the Binary BH example - key classes: BHAMR, BinaryBHLevel, SimulationParameters

This inherits from:

2. GRChombo - specific physics actions common to most 
 GR problems - key classes: GRAMR, GRAMRLevel, SimulationParametersBase
 Inherits from:

This inherits from:

3. Chombo - overall program flow relevant to any initial value problem - key classes: AMR, AMRLevel, ChomboParameters


A useful pdf guide on this topic from the latest GRChombo training day can be found in Useful resources.

Where to find the files

...