This is a work in progress. My immediate goal is to create general 1D, 2D, and 3D GWMFE reference codes, implemented in modern object-oriented Fortran that will replace the original archaic Fortran 77 codes (1D and 2D here). These will be derived from my existing unreleased Fortran 90 codes (1D is now available here).
The modernization of the 1D code is essentially complete and the code has feature-parity with the legacy GWMFE1DS code. Some rough edges still remain to be smoothed out over time. Development focus is now on enhancing capabilities, algorithm improvements, and coarray parallelization.
April 2023. After a nearly 8-year hiatus, I've returned to this in earnest. I'm currently working on restructuring the 1D code with an eye to parallelizing the code using coarrays (rather than openMP, for example) for multicore shared memory systems. (1D is ridiculously fast in serial as it is, but I'm anticipating this as a pattern for the 2D and 3D codes.)
The code depends on the petaca library whose source is available
here. After compiling and installing the
library, set your environment variable PETACA_ROOT to your installation
path before proceeding. Version v23.12 or later is required.
$ git clone https://github.com/mfeproject/calliope.git
$ cd calliope
$ mkdir build
$ cd build
$ cmake .. -D CMAKE_BUILD_TYPE=Release
$ makeYou may need to set your FC environment variable to the path of your Fortran
compiler before running cmake to ensure that CMake finds the correct compiler.
The code works with the Intel oneAPI classic ifort compiler, GFortran 12.2,
and NAG 7.1. (GFortran 13.1 is buggy; do not use.)
This produces a single executable mfe1 and several shared libraries (*.so
files) located in build/src, which can then be installed:
$ make installThe default installation location is /opt/calliope. This can be changed by
specifying a different location with a -D CMAKE_INSTALL_PREFIX=/my/location
argument to the above cmake command.
From the build directory give the command ctest to run the tests. The tests
run the code and compare against reference results.
The examples directory contains input files for some example problems. To
run them you'll need to add /opt/calliope/bin to your PATH environment
variable and invoke the mfe1 program with an input file as an argument;
for example
mfe1 sod-shock-tube.jsonWhen mfe1 is executed it will load one of the shared libraries that provides
procedures specific to a particular system of PDEs. The current PDE systems are:
- Scalar convection-diffusion equation
- Burgers' equation
- Single-carrier semiconductor drift-diffusion equations
- Compressible Navier-Stokes equations
The program writes diagnostic output to mfelog and the solution at a sequence
of time steps to mfegrf. The format of this file is fairly self-explanatory.
Many tools are capable of visualizing this 1D data. But note that the custom
graphics program gp1 from the legacy GWMFE1DS code,
https://github.com/mfeproject/legacy-gwmfe/tree/master/gwmfe1ds,
is able to read this file.
See doc/input-format.md for documentation of the input file format.