Skip to content

Commit

Permalink
Merge pull request #116 from openearth/add_content
Browse files Browse the repository at this point in the history
updated readthedocs
  • Loading branch information
JannisHoch committed Jul 17, 2020
2 parents 7fd6dff + dc68f93 commit 892f284
Show file tree
Hide file tree
Showing 30 changed files with 10,403 additions and 919 deletions.
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"restructuredtext.confPath": "${workspaceFolder}\\doc"
}
28 changes: 1 addition & 27 deletions doc/BMI.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _basicModelInterface:

*******************************
The Basic Model Interface
The BMI
*******************************

Introduction
Expand Down Expand Up @@ -52,32 +52,6 @@ Also, all 'bmi'ed' models can still be executed in stand-alone mode.

Compared to 'non-bmi'ed' version of a model, run times of the 'bmi'ed' version are near-identical.

GLOFRIM workflow
================
By applyting the BMI functions, the following workflow is followed in GLOFRIM. The example shows coupling between a
hydrologic and a hydrodynamic model, but would be identical if other or more models were coupled.

.. image:: _images/workflow.png
:scale: 40%
:align: center

After the model are chosen and coupling settings are defined in the GLOFRIM ini-file, the ini-file is read by GLOFRIM
to first initialize the model-specific configuration files and then initialize both models as a coupled entity.

Essential part of creating the coupled entity is the coupling of grids which is explained in more detail in :ref:`gridCoupling`.

Once the coupled models are initialized, a loop is entered, starting at the start time and terminating at the end time
as specified in the python executiont command (see :ref:`run_from_commandline`).

During the loop, models are individually updated from the upstream end of the model cascade to the most downstream model,
depending on the number of models coupled.

After a model is updated, the variables to be exchanged (as defined in GLOFRIM ini-file) are retrieved from the providing model,
if necessary aligned, and inserted to the receiving model. Only then, model time of the receiving model is forward integrated
until the model time of the providing model is reached.

If model end time is reached, model execution is finalized.




Expand Down
Binary file removed doc/_images/Fig5_qsim_DFMvsLFP.png
Binary file not shown.
Binary file removed doc/_images/GermanDischarge.png
Binary file not shown.
Binary file removed doc/_images/bridge.png
Binary file not shown.
Binary file removed doc/_images/fig_06.png
Binary file not shown.
Binary file removed doc/_images/logo.png
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes

0 comments on commit 892f284

Please sign in to comment.