OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2024-07-04 11:33:06 -05:00
Code Issues Packages Projects Releases Wiki Activity
Simulator programs and utilities for automatic differentiation.
3,527 Commits 23 Branches 94 Tags 70 MiB
C++ 71.6%
ECL 24.4%
CMake 1.9%
Cuda 0.9%
C 0.5%
Other 0.7%
release/2016.04
Go to file
Arne Morten Kvarving 54668ce2d4 bump packaging versions for 2016.04 final2
2016-05-02 10:58:40 +02:00
debian bump packaging versions for 2016.04 final2 2016-05-02 10:58:40 +02:00
doc/doxygen Fix minor issues pointed out by bska. 2013-09-23 13:02:56 +02:00
examples Using getInputGrid API from Parser 2016-04-19 17:03:41 +02:00
jenkins Use shared copy of opm-data when possible 2016-04-11 12:18:54 +02:00
opm fixing flow_polymer running cases without polymer. 2016-04-21 12:59:11 +02:00
redhat bump packaging versions for 2016.04 final2 2016-05-02 10:58:40 +02:00
tests Using getInputGrid API from Parser 2016-04-19 17:03:41 +02:00
travis Rename opm-autodiff -> opm-simulators. 2016-04-08 14:58:07 +02:00
.gitignore Added ignore to emacs per directory configuration file. 2014-11-26 14:56:45 +01:00
.travis.yml Rename opm-autodiff -> opm-simulators. 2016-04-08 14:58:07 +02:00
CMakeLists_files.cmake removing blank lines in CMakeLists_files 2016-04-14 16:05:19 +02:00
CMakeLists.txt added: mark flow_mpi for installation 2016-05-02 10:58:22 +02:00
configure changed: sync with renaming to opm-common 2015-09-08 10:47:05 +02:00
CTestConfig.cmake cdash: update dropsite 2015-11-11 16:50:25 +01:00
dune.module Bumped version for release. 2016-04-21 14:13:14 +02:00
README.md Rename opm-autodiff -> opm-simulators. 2016-04-08 14:58:07 +02:00

README.md

Open Porous Media Simulators and Automatic Differentiation Library Build Status

CONTENT

opm-simulators contains simulator programs for porous media flow. It also contains a small library for automatic differentiation built on the Eigen linear algebra package which is used by many of the simulators to handle the building of Jacobians. The most important parts are:

  • flow.cpp (a fully implicit black-oil simulator)
  • AutoDiffBlock.hpp (class for AD on vectorized data with sparse jacobians)

LICENSE

The library is distributed under the GNU General Public License, version 3 or later (GPLv3+).

PLATFORMS

The opm-simulators module is designed to run on Linux platforms. It is also regularly run on Mac OS X. No efforts have been made to ensure that the code will compile and run on windows platforms.

REQUIREMENTS

opm-simulators requires opm-output, opm-core, and all their requirements (see opm-core/README). In addition, opm-simulators requires the Dune modue dune-istl and Eigen, version 3.1 (has not been tested with later versions).

DOWNLOADING

For a read-only download: git clone git://github.com/OPM/opm-simulators.git

If you want to contribute, fork OPM/opm-simulators on github.

BUILDING

See build instructions at http://opm-project.org/?page_id=36

DOCUMENTATION

Efforts have been made to document the code with Doxygen. In order to build the documentation, enter the command

make doc

in the topmost directory. The class AutoDiffBlock is the most important and most well-documented.

REPORTING ISSUES

Issues can be reported in the Git issue tracker online at:

https://github.com/OPM/opm-simulators/issues

To help diagnose build errors, please provide a link to a build log together with the issue description.

You can capture such a log from the build using the `script' utility, e.g.:

LOGFILE=$(date +%Y%m%d-%H%M-)build.log ;
cmake -E cmake_echo_color --cyan --bold "Log file: $LOGFILE" ;
script -q $LOGFILE -c 'cmake ../opm-core -DCMAKE_BUILD_TYPE=Debug' &&
script -q $LOGFILE -a -c 'ionice nice make -j 4 -l 3' ||
cat CMakeCache.txt CMakeFiles/CMake*.log >> $LOGFILE

The resulting file can be uploaded to for instance gist.github.com.