mirror of https://github.com/OPM/opm-simulators.git synced 2025-01-15 22:21:55 -06:00

Simulator programs and utilities for automatic differentiation.

Go to file

Markus Blatt ba9f227a5b Cater for wells null pointer In the rare occasion that there are no wells int the model the wells_ pointer in BlackoilModelBase class is a null pointer. Therefore we need to test whether it is null and only process well information if it is not. This problem was reintroduced with PR #460 and gets fixed by this one. No we can run the equilibrium examples without wells again. Sorry for the inconvenience.		2015-10-22 16:28:18 +02:00
debian	update debian packaging	2015-10-20 09:47:26 +02:00
doc/doxygen	Fix minor issues pointed out by bska.	2013-09-23 13:02:56 +02:00
examples	Changes to solver approach configuration:	2015-10-21 13:01:44 +02:00
m4	remove the obsolete 'm4' subdirectory	2015-04-10 15:09:16 +02:00
opm/autodiff	Cater for wells null pointer	2015-10-22 16:28:18 +02:00
redhat	update redhat packaging	2015-10-20 15:55:39 +02:00
tests	Add "allow crossflow" argument to add_well() calls.	2015-10-15 09:54:53 +02:00
.gitignore	Added ignore to emacs per directory configuration file.	2014-11-26 14:56:45 +01:00
CMakeLists_files.cmake	Try to find opm-data and run flow on SPE1 case.	2015-10-21 18:43:08 +02:00
CMakeLists.txt	Try to find opm-data and run flow on SPE1 case.	2015-10-21 18:43:08 +02:00
configure	changed: sync with renaming to opm-common	2015-09-08 10:47:05 +02:00
CTestConfig.cmake	Import CMake support from OPM-Core	2013-05-15 10:24:52 +02:00
dune.module	changed: sync with renaming to opm-common	2015-09-08 10:47:05 +02:00
README.md	Updated to address points raised by bska.	2013-09-24 13:44:32 +02:00

README.md

Open Porous Media Automatic Differentiation Library

CONTENT

opm-autodiff contains a small library for automatic differentiation built on the Eigen linear algebra package. It also contains some experimental solver and simulator prototypes demonstrating how it can be used. The most important parts are:

AutoDiffBlock.hpp (class for AD on vectorized data with sparse jacobians)
AutoDiffHelpers.hpp (various utilities to simplify writing solvers)
sim_fibo_ad.cpp (prototype fully implicit black-oil simulator)

LICENSE

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

PLATFORMS

The opm-autodiff 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-autodiff requires opm-core, and all its requirements (see opm-core/README). In addition, opm-autodiff requires Eigen, version 3.1 (has not been tested with later versions).

DOWNLOADING

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

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

BUILDING

See build instructions in opm-core/README, or at http://opm-project.org/download.php.

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-autodiff/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.