README.md 4.15 KB
Newer Older
Ron Rahaman's avatar
Ron Rahaman committed
1
MOON
Derek Gaston's avatar
Derek Gaston committed
2 3
=====

Ron Rahaman's avatar
Ron Rahaman committed
4 5 6
[![build status](https://xgitlab.cels.anl.gov/nek5000/moon/badges/develop/build.svg)](https://xgitlab.cels.anl.gov/nek5000/moon/commits/develop)


Ron Rahaman's avatar
Ron Rahaman committed
7
MOON (Multiphysics Object-Oriented Nek5000) uses the [MOOSE](http://www.mooseframework.org/) framework to implement multiphysics coupling with [Nek5000](https://nek5000.mcs.anl.gov/) CFD simulations.  The project is a collaboration between [Idaho National Laboratory](https://www.inl.gov/) and [Argonne National Laboratory](https://www.inl.gov/).
Derek Gaston's avatar
Derek Gaston committed
8

Ron Rahaman's avatar
Ron Rahaman committed
9 10 11 12 13 14 15 16 17 18

Downloading the Repo
--------------------
Cloning the MOON repository requires the `--recursive` flag, since MOOSE and libmesh are included as [Git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules).  For example:
```
git clone --recursive https://xgitlab.cels.anl.gov/nek5000/moon.git
```
This will download and populate the src/moose and src/moose/libmesh.


Ron Rahaman's avatar
Ron Rahaman committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
Building PETSc
--------------
MOON requires PETSc, as described in the [MOOSE installation instructions](http://mooseframework.com/getting-started/).  PETSc is not distributed with MOON.  PETSc must either be compiled from source or installed as part of the MOOSE Environment package.  After installing PETSc, you must define the `$PETSC_DIR` variable in your environment.


Building libmesh
----------------
MOON also requires libmesh, as described in the [MOOSE installation instructions](http://mooseframework.com/getting-started/).  The libmesh source code is distributed with MOOSE.  It should be compiled using the following scripts:
```
$ cd moose/
$ scripts/update\_and\_rebuild\_libmesh.sh.  
```
After installing libmesh, you must define the `$LIBMESH_DIR` in your environment.


Ron Rahaman's avatar
Ron Rahaman committed
34 35 36 37 38 39 40 41 42 43 44
The Example Problems
--------------------

Currently, the only working example problem is "integration_example" in `moon/examples/integration_example`.  

### Building Example Problems

To configure and build each example problem, first generate the `configure` script in the top-level MOON directory:
```
$ cd moon
$ ./bootstrap
Ron Rahaman's avatar
Ron Rahaman committed
45
```
Ron Rahaman's avatar
Ron Rahaman committed
46
Then cd into the example subdirectory and simply run `configure` && `make`.  This will build the MOOSE and Nek5000 libraries, then link them to the executable driver.
Ron Rahaman's avatar
Ron Rahaman committed
47
```
Ron Rahaman's avatar
Ron Rahaman committed
48 49 50 51 52 53 54
$ cd moon/examples/integration_example`
$ ../../configure
$ make
```
The `configure` script may be run with additional options (for example, to point to a custom libmesh or MOOSE installation).  Run `./configure --help` to see a list of the available options.

### Running Example Problems
Ron Rahaman's avatar
Ron Rahaman committed
55

Ron Rahaman's avatar
Ron Rahaman committed
56 57 58
To run an example problem, it is recommended to use the convenience script `moon/examples/build_coupled_nek`.  This script will automatically setup some input files needed by Nek5000 (such as SESSION.NAME).  The script takes one command-line argument for the MOOSE configuration file, `-i <config_file>.i`.
```
$ cd moon/examples/integration_example
59
$ ../../moon-opt -i coefficient_integration.i
Ron Rahaman's avatar
Ron Rahaman committed
60
```
Ron Rahaman's avatar
Ron Rahaman committed
61

Ron Rahaman's avatar
Ron Rahaman committed
62 63 64 65 66
Linking to libmoon
------------------

The MOON libraries are output to the top-level lib/ directory.

Ron Rahaman's avatar
Ron Rahaman committed
67 68 69 70 71 72 73 74 75 76
Developing Nek5000 in MOON
--------------------------
Developers may freely modify src/Nek5000 as if it were a normal part of the MOON repo.  This is because Nek5000 is included as a Git subtree (rather than a submodule).  For routine commits, pushes, and pulls to the MOON repository, no extra Git commands are necessary.

With some additional Git commands, developers may easily merge upstream changes from [https://github.com/Nek5000/Nek5000](https://github.com/Nek5000/Nek5000) into src/Nek5000.  Finally, developers may also request to merge changes from src/Nek5000 to [https://github.com/Nek5000/Nek5000](https://github.com/Nek5000/Nek5000). This [blog post](http://blogs.atlassian.com/2013/05/alternatives-to-git-submodule-git-subtree/) from Atlassian gives a brief rundown of the procedures.  


Developing MOOSE and libmesh in MOON
------------------------------------
Modifying src/moose and src/moose/libmesh require additional Git commands, since they are included as Git submodules (rather than subtrees).  Modifying either of these libraries for MOON is intended to be unnecessary.  Should the situation arise, this [chapter](https://git-scm.com/book/en/v2/Git-Tools-Submodules) from _Pro Git_ describes the procedure for making modifications to submodules.