Skip to content

read_the_code

Jump to bottom Edit New page
Ricardo Torres edited this page May 24, 2023 · 2 revisions

Code structure

A complete graph of the interdependency of each module, subroutine and variable in FVCOM is available. This is the output of an analysis with doxygen and shows how FVCOM is structured. This is useful to find where a variable is defined and which subroutines are called by what.

As a general rule, if you don't know what a variable name contains (and it's not defined in the local namespace), check the ALL_VARS module in mod_main.F or the MOD_TYPES module in mod_types.F.

Running Doxygen

I have copied my doxygen configuration file here for future reference should you choose to run it on your own code. This uses the Twitter Bootstrap theme which requires these header.html and footer.html files.

For questions regarding FVCOM, to contribute to the wiki please subscribe to the mailing list uk-fvcom mailing list If you would like to cite FVCOM, please refer to its main publication and/or URLs.

Background

=== FVCOM Wiki ===

  1. Introduction

User guide

  1. Getting FVCOM

  2. Building and installing

  3. Grid considerations

  4. Setting up a simulation

  5. Additional information of less frequent usage in no particular order

    1. Output of subdomains
    2. Use of Probes
    3. Read the code
    4. Tips and tricks
    5. Semi-implicit considerations

How to cite
Licensing and copyright
Acknowledgements Policy

Build and test DOI

Clone this wiki locally