OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2024-11-26 03:00:17 -06:00
Code Issues Packages Projects Releases Wiki Activity
Simulator programs and utilities for automatic differentiation.
534 Commits 24 Branches 101 Tags 97 MiB
C++ 78.3%
ECL 17.9%
CMake 1.7%
Cuda 1.1%
Shell 0.5%
Other 0.5%
615b88b345
Go to file
Roland Kaufmann 615b88b345 Install header-only pkgconfig file to generic lib/ 
The previous version assumed that we had libraries, and thus always
installs the .pc file in the multi-arch library directory. However,
we now have modules which does not have a library, but whose header
files still need to be located. Since the lib/ directory is usually
in the pkgconfig search path, it is natural to put them there.
2013-10-21 15:25:22 +02:00
cmake Install header-only pkgconfig file to generic lib/ 2013-10-21 15:25:22 +02:00
doc/doxygen Fix minor issues pointed out by bska. 2013-09-23 13:02:56 +02:00
examples Fix minor issues pointed out by bska. 2013-09-23 13:02:56 +02:00
m4 Compatibility module for dunecontrol-driven clients 2013-08-14 22:47:24 +02:00
opm/autodiff Minimal fix for Eigen versions lacking pow(Eigen::Array). 2013-10-20 22:02:32 +02:00
tests changed: run test for a x different than pi 2013-10-16 11:35:47 +02:00
.gitignore Ignore autosave files from Vim. 2013-05-14 17:45:20 +02:00
CMakeLists_files.cmake Renamed misleading adfi -> fi. 2013-09-19 14:52:39 +02:00
CMakeLists.txt Add a small bootstrapper to locate build system 2013-08-16 23:55:45 +02:00
configure Search for directory containing build scripts 2013-08-16 23:55:44 +02:00
CTestConfig.cmake Import CMake support from OPM-Core 2013-05-15 10:24:52 +02:00
dune.module Bump version number and label. 2013-10-21 14:44:52 +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.