d1d22668ea
The initial use case is calculating the phase-filled pore-volume weighted average of the fluid mass densities per PVT region. This value goes into calculating depth-corrected per-cell phase pressure values such as the BPPO and BPPG summary vectors. This class manages a single linear array which separately tracks the averages' numerators and denominators as running sums per region and region set. We pick this data structure to simplify the cross-rank reduction needed in MPI parallel runs. Client code is expected to add individual per-cell and per-phase contributions using the addCell() member function and then call the accumulateParallel() member to affect the cross-rank reduction. The averages will then be available through the fieldValue() and value() member functions. As a further view towards the initial use case, we track two different types of average per phase--one for the phase-filled volume and one for the pore-volume filled volume. The latter is the average we would get for the case of the phase saturation being one throughout the region. This alternative value is the fallback option for the case of the phase saturation being identically zero throughout the region. |
||
|---|---|---|
| doc | ||
| ebos | ||
| examples | ||
| flow | ||
| jenkins | ||
| opm | ||
| python | ||
| tests | ||
| .clang-format | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CMakeLists_files.cmake | ||
| CMakeLists.txt | ||
| compareECLFiles.cmake | ||
| CTestConfig.cmake | ||
| dune.module | ||
| LICENSE | ||
| opencl-source-provider.cmake | ||
| opm-simulators-prereqs.cmake | ||
| parallelRestartTests.cmake | ||
| parallelTests.cmake | ||
| README.md | ||
| regressionTests.cmake | ||
| restartTests.cmake | ||
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.