Skip to content

Add the first draft of the code structure. #791

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add the first draft of the code structure. #791

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion doc/sphinx/developer_manual/developing_for_the_GWB/code_structure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,12 @@ Code structure

```{todo}
Go through how the code is actually structured with directories and from core to utilities and pugins.
```
```

The main file that generates the GWB world is `source/world_builder/world.cc` using the specified parameterizations in a given worldbuilder (`*.wb`) file. The executable `gwb-dat` or `gwb-grid` is then used to query the World on a set of specified points or on a grid, respectively.
Copy link
Member

@MFraters MFraters Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The main file that generates the GWB world is `source/world_builder/world.cc` using the specified parameterizations in a given worldbuilder (`*.wb`) file. The executable `gwb-dat` or `gwb-grid` is then used to query the World on a set of specified points or on a grid, respectively.
The main file that is reponsible for creating and accessing the GWB world is `source/world_builder/world.cc`. When creating a new GWB world it uses the parameterizations from the worldbuilder (`*.wb`) input file to create the world. External programs, such as `gwb-dat` or `gwb-grid` or other software such as ASPECT or SEPRAN, can then use the provided interfaces to ask about certain properties (e.g. temperature, composition) on any location.


GWB determines where a given point lies in the World amongst the specified tectonic features. The utility functions to compute the distance of point from a feature are defined in the `source/world_builder/utilities.cc`.
Copy link
Member

@MFraters MFraters Jan 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
GWB determines where a given point lies in the World amongst the specified tectonic features. The utility functions to compute the distance of point from a feature are defined in the `source/world_builder/utilities.cc`.
GWB determines where a given point lies in the World amongst the specified tectonic features. This happens mostly through utility functions, which to compute the distance of point from a feature. These and several other utility functions are defined in the `source/world_builder/utilities.cc`.


The available features are described in the `features` directory. The interface class, which defines all feature models—such as continental plates, plumes, oceanic plates, and faults—is located in `source/world_builder/features/interface.cc`. This class includes member functions that are implemented individually within each feature's class. For instance, both `source/world_builder/continental_plate.cc` and `source/world_builder/fault.cc` override the `declare_entries` function from the `Interface` class to include all the parameters required for their respective feature models.

For each feature model, the GWB calculates properties such as temperature and composition using the available distributions, which are located in the sub-directory corresponding to that feature model. For example, all available functions describing the composition values of a `fault` are stored in the `source/world_builder/features/fault_models/composition` directory. Similar to feature model types, property types are derived from their respective Interface class, defined in the interface.cc file within the same folder. In this case, the interface file would be `source/world_builder/features/fault_models/composition/interface.cc`.
Loading