-
Notifications
You must be signed in to change notification settings - Fork 42
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.
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
Conversation
|
MFraters
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for writing this! A few suggestions for clarifications and a bit of rewording.
| ``` | ||
| ``` | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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. |
|
|
||
| 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. | ||
|
|
||
| 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`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| 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`. |
|
I am closing this since I accidentally push it to the upstream and not my fork repository. |
This PR adds a brief documentation of the code structure to address #532 . I am keeping the original comment of what this file should include for reference.