OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-01-24 17:26:25 -06:00
Code Issues Packages Projects Releases Wiki Activity
Simulator programs and utilities for automatic differentiation.
11,297 Commits 24 Branches 102 Tags 90 MiB
C++ 78.3%
ECL 17.7%
CMake 1.8%
Cuda 1.2%
Shell 0.5%
Other 0.5%
2734445bf5
Go to file
Håkon Hægland 2734445bf5 Refactor runSimulator(). 
A resubmission of commit b25f489 in PR #2403 and PR #2441 to work with
the current master.

Continues the work in PR #2619 to refactor FlowMainEbos.hpp to work with
the Python bindings.

We need to refactor runSimulator() to avoid code duplication when
executeStepInit() is implemented (see later commit). Here, runSimulator()
is refactored into a runSimulatorInitOrRun() that takes a callback
function. When runSimulatorInit() is implemented it will pass a different
callback that only initializes the simulator. Currently, runSimulator()
passes the callback runSimulatorRunCallback_() which runs the whole
simulation. The code outputting the simulation summary in runSimulator()
is also refactored into a runSimulatorAfterSim_() method.
2020-05-19 16:52:46 +02:00
debian changed: remove multiarch-support predepends 2020-04-30 09:16:12 +02:00
doc/doxygen Fix minor issues pointed out by bska. 2013-09-23 13:02:56 +02:00
ebos increasing the max iteration number for statFromPc 2020-04-30 12:12:58 +02:00
examples/mrst remove files 2018-11-16 14:53:37 +01:00
flow remove unused variables 2020-05-14 11:03:03 +02:00
jenkins fixed: do not make root dir 2020-02-28 14:42:16 +01:00
opm Refactor runSimulator(). 2020-05-19 16:52:46 +02:00
python mark the pybind11 headers SYSTEM to avoid (shadowing) warnings 2020-05-14 11:12:15 +02:00
redhat use devtoolset-8 and boost 1.48 on rhel 6 and rhel 7 2020-02-17 15:58:02 +01:00
tests Merge pull request #2589 from alfbr/group-tests5 2020-05-05 19:58:13 +02:00
.clang-format Add flexible solver and preconditioner infrastructure. 2019-06-03 11:42:30 +02:00
.gitignore Add build/ to .gitignore 2020-04-22 13:22:54 +02:00
CHANGELOG.md Added entries to changelog concerning 2019.10 release 2019-10-29 13:27:07 +01:00
CMakeLists_files.cmake Split file to ensure correct authorship and license is applied. 2020-05-13 13:53:45 +02:00
CMakeLists.txt Need to set ENV{CUDAHOSTCXX}, too. 2020-04-29 13:58:48 +02:00
compareECLFiles.cmake Fix typo 2020-05-05 18:15:19 +02:00
CTestConfig.cmake cdash: update dropsite 2015-11-11 16:50:25 +01:00
dune.module bump required dune version to 2.6 2020-02-06 16:24:39 +01:00
opm-simulators-prereqs.cmake remove boost::filesystem as dependency 2020-02-12 15:03:18 +01:00
README.md Remove obsolete information from the README 2020-03-13 11:23:35 +01:00

README.md

Open Porous Media Simulators and Automatic Differentiation Library

CONTENT

opm-simulators contains simulator programs for porous media flow. The most important (and tested) part is the Flow reservoir simulator, which is a fully implicit black-oil simulator that also supports solvent and polymer options. It is built using automatic differentiation, using the local AD class Evaluation from opm-material.

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 several other OPM modules, see http://opm-project.org/?page_id=274. In addition, opm-simulators requires Dune and some other software to be available, for details see https://opm-project.org/?page_id=239.

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.

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.