https://github.com/ajacquey/lynx

Lithosphere dYnamics Numerical toolboX - a MOOSE-based application
https://github.com/ajacquey/lynx

geodynamics lithosphere lynx moose-framework

Last synced: about 1 year ago
JSON representation

Lithosphere dYnamics Numerical toolboX - a MOOSE-based application

• Host: GitHub
• URL: https://github.com/ajacquey/lynx
• Owner: ajacquey
• License: gpl-3.0
• Created: 2020-02-18T08:41:30.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2021-07-22T15:44:04.000Z (almost 5 years ago)
• Last Synced: 2025-03-23T18:12:23.128Z (about 1 year ago)
• Topics: geodynamics, lithosphere, lynx, moose-framework
• Language: C++
• Homepage:
• Size: 6.95 MB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Citation: CITATION

Awesome Lists containing this project

README

          


  


  LYNX

  


  Lithosphere dYnamic Numerical toolboX

  


  A MOOSE-based application

  




A numerical simulator for modelling deformation of the lithosphere, based on MOOSE.




  

    

  

  

    

  



## About

LYNX (Lithosphere dYnamic Numerical toolboX) is a numerical simulator for modelling coupled Thermo-Hydro-Mechanical processes in the porous rocks of the lithosphere.

The simulator is developed by [Antoine Jacquey](http://www.gfz-potsdam.de/en/staff/antoine-jacquey/)  and [Mauro Cacace](http://www.gfz-potsdam.de/en/section/basin-modeling/staff/profil/mauro-cacace/)  at the [GFZ Potsdam, German Research Centre for Geosciences](http://www.gfz-potsdam.de/en/home/) from the section [Basin Modelling](http://www.gfz-potsdam.de/en/section/basin-modeling/).

LYNX is a MOOSE-based application. Visit the [MOOSE framework](http://mooseframework.org) page for more information.

## Licence

LYNX is distributed under the [GNU GENERAL PUBLIC LICENSE v3](https://gitext.gfz-potsdam.de/ajacquey/lynx/blob/master/LICENSE).

## Getting Started

#### Minimum System Requirements

The following system requirements are from the MOOSE framework (see [Getting Started](http://mooseframework.org/getting-started/) for more information):

* Compiler: C++11 Compliant GCC 4.8.4, Clang 3.4.0, Intel20130607

* Python 2.7+

* Memory: 16 GBs (debug builds)

* Processor: 64-bit x86

* Disk: 30 GBs

* OS: UNIX compatible (OS X, most flavors of Linux)

#### 1. Setting Up a MOOSE Installation

To install LYNX, you need first to have a working and up-to-date installation of the MOOSE framework.  

To do so, please visit the [Getting Started](http://mooseframework.org/getting-started/) page of the MOOSE framework and follow the instructions. If you encounter difficulties at this step, you can ask for help on the [MOOSE-users Google group](https://groups.google.com/forum/#!forum/moose-users).

#### 2. Clone LYNX

LYNX can be cloned directly from [GitLab](https://gitext.gfz-potsdam.de/ajacquey/lynx) using [Git](https://git-scm.com/). In the following, we refer to the directory `projects` which you created during the MOOSE installation (by default `~/projects`):  

    cd ~/projects

    git clone https://gitext.gfz-potsdam.de/ajacquey/lynx.git

    cd ~/projects/lynx

    git checkout master

*Note: the "master" branch of LYNX is the "stable" branch which is updated only if all tests are passing.*

#### 3. Compile LYNX

You can compile LYNX by following these instructions:

    cd ~/projects/lynx

    make -j4

#### 4. Test LYNX

To make sure that everything was installed properly, you can run the tests suite of LYNX:

    cd ~/projects/lynx

    ./run_tests -j2

If all the tests passed, then your installation is working properly. You can now use the LYNX simulator!

## Usage

To run LYNX from the command line with multiple processors, use the following command:

    mpiexec -n  ~/projects/lynx/lynx-opt -i 

Where `` is the number of processors you want to use and `` is the path to your input file (extension `.i`).  

Information about the structure of the LYNX input files can be found in the documentation (link to follow).

## Cite

If you use LYNX for your work please cite:

* This repository:  

Jacquey, Antoine B., & Cacace, Mauro. (2019, July 30). LYNX: Lithosphere dYnamic Numerical toolboX, a MOOSE-based application (Version 1.0). Zenodo. http://doi.org/10.5281/zenodo.3355376

* The following research articles:

Jacquey, Antoine B., & Cacace, Mauro. (2020). Multiphysics Modeling of a Brittle‐Ductile Lithosphere: 1. Explicit Visco‐Elasto‐Plastic Formulation and Its Numerical Implementation. Journal of Geophysical Research: Solid Earth. http://doi.org/10.1029/2019jb018474

Jacquey, Antoine B., & Cacace, Mauro. (2020). Multiphysics Modeling of a Brittle‐Ductile Lithosphere: 2. Semi‐brittle, Semi‐ductile Deformation and Damage Rheology. Journal of Geophysical Research: Solid Earth. http://doi.org/10.1029/2019jb018475

Please read the [CITATION](https://gitext.gfz-potsdam.de/ajacquey/lynx//blob/master/CITATION) file for more information.

## Publications using LYNX

* Jacquey, Antoine B., & Cacace, Mauro. (2020). Multiphysics Modeling of a Brittle‐Ductile Lithosphere: 1. Explicit Visco‐Elasto‐Plastic Formulation and Its Numerical Implementation. Journal of Geophysical Research: Solid Earth. http://doi.org/10.1029/2019jb018474

* Jacquey, Antoine B., & Cacace, Mauro. (2020). Multiphysics Modeling of a Brittle‐Ductile Lithosphere: 2. Semi‐brittle, Semi‐ductile Deformation and Damage Rheology. Journal of Geophysical Research: Solid Earth. http://doi.org/10.1029/2019jb018475