Andreas Lauser ac4dcba7e0 BlackoilModelEnums: don't use high-level classes
I consider the blackoil model enums to be pretty low level while the
"FluidProperties" code is IMO quite high level. this, using the latter
to define the former constitutes a layering violation IMO. note that
the fix is to simply use the enums from opm-core directly.
2016-12-29 18:03:05 +01:00
2016-10-12 14:18:19 +02:00
2016-11-23 12:54:21 +01:00
2015-11-11 16:50:25 +01: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.

Description
Simulator programs and utilities for automatic differentiation.
Readme 70 MiB
Languages
C++ 78.3%
ECL 17.7%
CMake 1.8%
Cuda 1.2%
Shell 0.5%
Other 0.5%