63eaecf246
this is required to implement pore volume and permeability multipliers as discussed with [at]bska and [at]joakim-hove. Note that this implies that the DerivedGeology class can't be instantiated anymore if there is no EclipseState object. Thus all code paths and tests that don't load a deck are removed by this patch. If this is undesireable, there are two options: First, don't require EclipseState for DerivedGeology which would imply to make the about 10 required multiplier functions part of the BlackoilPropertiesAdInterface, or second, one can copy-and-paste the DerivedGeology class as it was before this patch, derive from a newly introduced DerivedGeologyInterface and pass DerivedGeologyInterface objects to the simulator. IMHO, the second solution would be a bit better but it would involve substantial overhead to implement and to maintain it. Anyway, in the mean time simulators cannot be instantiated without decks. |
||
|---|---|---|
| cmake | ||
| debian | ||
| doc/doxygen | ||
| examples | ||
| m4 | ||
| opm/autodiff | ||
| redhat | ||
| tests | ||
| .gitignore | ||
| CMakeLists_files.cmake | ||
| CMakeLists.txt | ||
| configure | ||
| CTestConfig.cmake | ||
| dune.module | ||
| 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.