Simulator programs and utilities for automatic differentiation.
Go to file
Arne Morten Kvarving 3607ba9127 changed: drop usage of python based comparison script in spe integration tests
use compareECL from opm-output instead
2016-11-03 09:10:26 +01:00
debian changed: bundle eigen3 in the original tarball for debian 2016-10-12 15:48:13 +02:00
doc/doxygen Fix minor issues pointed out by bska. 2013-09-23 13:02:56 +02:00
examples Update to shared_ptr-less parser interface. 2016-10-20 14:08:04 +02:00
jenkins changed: drop usage of python based comparison script in spe integration tests 2016-11-03 09:10:26 +01:00
opm Merge pull request #883 from jokva/relax-opm-phase-enum-constexpr 2016-11-01 14:52:22 +01:00
redhat update redhat6 packaging 2016-10-12 14:18:19 +02:00
tests Update to shared_ptr-less parser interface. 2016-10-20 14:08:04 +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 Using build-all travis configuration. 2016-06-10 13:52:16 +02:00
CMakeLists_files.cmake Moved ParallelFileMerger to its own file. 2016-10-05 11:39:06 +02:00
CMakeLists.txt Added more cases/models to ctest 2016-09-14 13:12:58 +02:00
compareECLFiles.cmake Added more cases/models to ctest 2016-09-14 13:12:58 +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 dune.module: change version to 2016.10-pre 2016-05-03 14:31:32 +02:00
README.md Rename opm-autodiff -> opm-simulators. 2016-04-08 14:58:07 +02:00

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.