mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
in the python simulator we cannot make this decision up front since the schedule can be modified from python code so we have to do the safe thing
773 lines
27 KiB
C++
773 lines
27 KiB
C++
/*
|
|
Copyright 2013, 2014, 2015 SINTEF ICT, Applied Mathematics.
|
|
Copyright 2014 Dr. Blatt - HPC-Simulation-Software & Services
|
|
Copyright 2015 IRIS AS
|
|
Copyright 2014 STATOIL ASA.
|
|
Copyright 2023 Inria
|
|
|
|
This file is part of the Open Porous Media project (OPM).
|
|
|
|
OPM is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OPM is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OPM. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
#ifndef OPM_MAIN_HEADER_INCLUDED
|
|
#define OPM_MAIN_HEADER_INCLUDED
|
|
|
|
#include <flow/flow_blackoil.hpp>
|
|
#include <flow/flow_blackoil_legacyassembly.hpp>
|
|
|
|
#include <flow/flow_gasoil.hpp>
|
|
#include <flow/flow_gasoildiffuse.hpp>
|
|
#include <flow/flow_gasoil_energy.hpp>
|
|
#include <flow/flow_oilwater.hpp>
|
|
#include <flow/flow_gaswater.hpp>
|
|
#include <flow/flow_gaswater_solvent.hpp>
|
|
#include <flow/flow_solvent.hpp>
|
|
#include <flow/flow_solvent_foam.hpp>
|
|
#include <flow/flow_polymer.hpp>
|
|
#include <flow/flow_extbo.hpp>
|
|
#include <flow/flow_foam.hpp>
|
|
#include <flow/flow_brine.hpp>
|
|
#include <flow/flow_brine_saltprecipitation.hpp>
|
|
#include <flow/flow_gaswater_saltprec_vapwat.hpp>
|
|
#include <flow/flow_gaswater_saltprec_energy.hpp>
|
|
#include <flow/flow_brine_precsalt_vapwat.hpp>
|
|
#include <flow/flow_onephase.hpp>
|
|
#include <flow/flow_onephase_energy.hpp>
|
|
#include <flow/flow_oilwater_brine.hpp>
|
|
#include <flow/flow_gaswater_brine.hpp>
|
|
#include <flow/flow_gaswater_energy.hpp>
|
|
#include <flow/flow_gaswater_dissolution.hpp>
|
|
#include <flow/flow_gaswater_dissolution_diffuse.hpp>
|
|
#include <flow/flow_energy.hpp>
|
|
#include <flow/flow_oilwater_polymer.hpp>
|
|
#include <flow/flow_oilwater_polymer_injectivity.hpp>
|
|
#include <flow/flow_micp.hpp>
|
|
|
|
#include <opm/input/eclipse/EclipseState/EclipseState.hpp>
|
|
|
|
#include <opm/models/utils/propertysystem.hh>
|
|
#include <opm/models/utils/parametersystem.hpp>
|
|
|
|
#include <opm/simulators/flow/Banners.hpp>
|
|
#include <opm/simulators/flow/FlowMain.hpp>
|
|
|
|
#if HAVE_DUNE_FEM
|
|
#include <dune/fem/misc/mpimanager.hh>
|
|
#else
|
|
#include <dune/common/parallel/mpihelper.hh>
|
|
#endif
|
|
|
|
#if HAVE_MPI
|
|
#include <opm/simulators/utils/ParallelEclipseState.hpp>
|
|
#endif
|
|
|
|
#if HAVE_DAMARIS
|
|
#include <opm/simulators/utils/DamarisKeywords.hpp>
|
|
#endif
|
|
|
|
#include <cassert>
|
|
#include <charconv>
|
|
#include <cstdlib>
|
|
#include <filesystem>
|
|
#include <iostream>
|
|
#include <memory>
|
|
#include <stdexcept>
|
|
#include <string>
|
|
#include <string_view>
|
|
#include <type_traits>
|
|
#include <utility>
|
|
|
|
namespace Opm::Properties {
|
|
|
|
// this is a dummy type tag that is used to setup the parameters before the actual
|
|
// simulator.
|
|
namespace TTag {
|
|
struct FlowEarlyBird {
|
|
using InheritsFrom = std::tuple<FlowProblem>;
|
|
};
|
|
}
|
|
|
|
} // namespace Opm::Properties
|
|
|
|
namespace Opm {
|
|
|
|
namespace Action { class State; }
|
|
class UDQState;
|
|
class WellTestState;
|
|
|
|
// ----------------- Main program -----------------
|
|
template <class TypeTag>
|
|
int flowMain(int argc, char** argv, bool outputCout, bool outputFiles)
|
|
{
|
|
// we always want to use the default locale, and thus spare us the trouble
|
|
// with incorrect locale settings.
|
|
resetLocale();
|
|
|
|
FlowMain<TypeTag> mainfunc(argc, argv, outputCout, outputFiles);
|
|
return mainfunc.execute();
|
|
}
|
|
|
|
// ----------------- Main class -----------------
|
|
// For now, we will either be instantiated from main() in flow.cpp,
|
|
// or from a Python pybind11 module..
|
|
// NOTE (March 2020): When used from a pybind11 module, we do not neccessarily
|
|
// want to run the whole simulation by calling run(), it is also
|
|
// useful to just run one report step at a time. According to these different
|
|
// usage scenarios, we refactored the original run() in flow.cpp into this class.
|
|
class Main
|
|
{
|
|
public:
|
|
Main(int argc, char** argv, bool ownMPI = true);
|
|
|
|
// This constructor can be called from Python
|
|
Main(const std::string& filename, bool mpi_init = true, bool mpi_finalize = true);
|
|
|
|
// This constructor can be called from Python when Python has
|
|
// already parsed a deck
|
|
Main(const std::string& filename,
|
|
std::shared_ptr<EclipseState> eclipseState,
|
|
std::shared_ptr<Schedule> schedule,
|
|
std::shared_ptr<SummaryConfig> summaryConfig,
|
|
bool mpi_init = true,
|
|
bool mpi_finalize = true);
|
|
|
|
~Main();
|
|
|
|
void setArgvArgc_(const std::string& filename);
|
|
|
|
void initMPI();
|
|
|
|
int runDynamic()
|
|
{
|
|
int exitCode = EXIT_SUCCESS;
|
|
if (initialize_<Properties::TTag::FlowEarlyBird>(exitCode)) {
|
|
Parameters::reset();
|
|
if (isSimulationRank_) {
|
|
return this->dispatchDynamic_();
|
|
}
|
|
}
|
|
|
|
return exitCode;
|
|
}
|
|
|
|
template <class TypeTag>
|
|
int runStatic()
|
|
{
|
|
int exitCode = EXIT_SUCCESS;
|
|
if (initialize_<TypeTag>(exitCode)) {
|
|
if (isSimulationRank_) {
|
|
return this->dispatchStatic_<TypeTag>();
|
|
}
|
|
}
|
|
|
|
return exitCode;
|
|
}
|
|
|
|
//! \brief Used for test_outputdir.
|
|
int justInitialize()
|
|
{
|
|
int exitCode = EXIT_SUCCESS;
|
|
initialize_<Properties::TTag::FlowEarlyBird>(exitCode);
|
|
return exitCode;
|
|
}
|
|
|
|
private:
|
|
int dispatchDynamic_()
|
|
{
|
|
const auto& rspec = this->eclipseState_->runspec();
|
|
const auto& phases = rspec.phases();
|
|
|
|
this->setupVanguard();
|
|
|
|
// run the actual simulator
|
|
//
|
|
// TODO: make sure that no illegal combinations like thermal and
|
|
// twophase are requested.
|
|
const bool thermal = eclipseState_->getSimulationConfig().isThermal();
|
|
|
|
// Single-phase case
|
|
if (rspec.micp()) {
|
|
return this->runMICP(phases);
|
|
}
|
|
|
|
// water-only case
|
|
else if (phases.size() == 1 && phases.active(Phase::WATER) && !thermal) {
|
|
return this->runWaterOnly(phases);
|
|
}
|
|
|
|
// water-only case with energy
|
|
else if (phases.size() == 2 && phases.active(Phase::WATER) && thermal) {
|
|
return this->runWaterOnlyEnergy(phases);
|
|
}
|
|
|
|
// Twophase cases
|
|
else if (phases.size() == 2 && !thermal) {
|
|
return this->runTwoPhase(phases);
|
|
}
|
|
|
|
// Polymer case
|
|
else if (phases.active(Phase::POLYMER)) {
|
|
return this->runPolymer(phases);
|
|
}
|
|
|
|
// Foam case
|
|
else if (phases.active(Phase::FOAM) && !phases.active(Phase::SOLVENT)) {
|
|
return this->runFoam();
|
|
}
|
|
|
|
// Solvent case
|
|
else if (phases.active(Phase::SOLVENT)) {
|
|
return this->runSolvent(phases);
|
|
}
|
|
|
|
// Brine case
|
|
else if (phases.active(Phase::BRINE) && !thermal) {
|
|
return this->runBrine(phases);
|
|
}
|
|
|
|
// Extended BO case
|
|
else if (phases.active(Phase::ZFRACTION)) {
|
|
return this->runExtendedBlackOil();
|
|
}
|
|
|
|
// Energy case
|
|
else if (thermal) {
|
|
return this->runThermal(phases);
|
|
}
|
|
|
|
// Blackoil case
|
|
else if (phases.size() == 3) {
|
|
return this->runBlackOil();
|
|
}
|
|
|
|
else {
|
|
if (outputCout_) {
|
|
std::cerr << "No suitable configuration found, valid are "
|
|
<< "Twophase, polymer, foam, brine, solvent, "
|
|
<< "energy, and blackoil.\n";
|
|
}
|
|
|
|
return EXIT_FAILURE;
|
|
}
|
|
}
|
|
|
|
template <class TypeTag>
|
|
int dispatchStatic_()
|
|
{
|
|
this->setupVanguard();
|
|
return flowMain<TypeTag>(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
protected:
|
|
/// \brief Initialize
|
|
/// \param exitCode The exitCode of the program.
|
|
/// \param keepKeywords Keep Schedule keywords even if there are no actions
|
|
///
|
|
/// \return Whether to actually run the simulator. I.e. true if
|
|
/// parsing of command line was successful and no --help,
|
|
/// --print-properties, or --print-parameters have been found.
|
|
template <class TypeTagEarlyBird>
|
|
bool initialize_(int& exitCode, bool keepKeywords = false)
|
|
{
|
|
Dune::Timer externalSetupTimer;
|
|
externalSetupTimer.start();
|
|
|
|
handleVersionCmdLine_(argc_, argv_, Opm::moduleVersionName());
|
|
|
|
// we always want to use the default locale, and thus spare us the trouble
|
|
// with incorrect locale settings.
|
|
resetLocale();
|
|
|
|
// this is a work-around for a catch 22: we do not know what code path to use without
|
|
// parsing the deck, but we don't know the deck without having access to the
|
|
// parameters and this requires to know the type tag to be used. To solve this, we
|
|
// use a type tag just for parsing the parameters before we instantiate the actual
|
|
// simulator object. (Which parses the parameters again, but since this is done in an
|
|
// identical manner it does not matter.)
|
|
typedef TypeTagEarlyBird PreTypeTag;
|
|
using PreProblem = GetPropType<PreTypeTag, Properties::Problem>;
|
|
|
|
PreProblem::setBriefDescription("Flow, an advanced reservoir simulator for ECL-decks provided by the Open Porous Media project.");
|
|
int status = FlowMain<PreTypeTag>::setupParameters_(argc_, argv_, FlowGenericVanguard::comm());
|
|
if (status != 0) {
|
|
// if setupParameters_ returns a value smaller than 0, there was no error, but
|
|
// the program should abort. This is the case e.g. for the --help and the
|
|
// --print-properties parameters.
|
|
#if HAVE_MPI
|
|
if (status >= 0)
|
|
MPI_Abort(MPI_COMM_WORLD, status);
|
|
#endif
|
|
exitCode = (status > 0) ? status : EXIT_SUCCESS;
|
|
return false; // Whether to run the simulator
|
|
}
|
|
|
|
std::string deckFilename;
|
|
std::string outputDir;
|
|
if ( eclipseState_ ) {
|
|
deckFilename = eclipseState_->getIOConfig().fullBasePath();
|
|
outputDir = eclipseState_->getIOConfig().getOutputDir();
|
|
}
|
|
else {
|
|
deckFilename = Parameters::Get<Parameters::EclDeckFileName>();
|
|
outputDir = Parameters::Get<Parameters::OutputDir>();
|
|
}
|
|
|
|
#if HAVE_DAMARIS
|
|
enableDamarisOutput_ = Parameters::Get<Parameters::EnableDamarisOutput>();
|
|
|
|
// Reset to false as we cannot use Damaris if there is only one rank.
|
|
if ((enableDamarisOutput_ == true) && (FlowGenericVanguard::comm().size() == 1)) {
|
|
std::string msg ;
|
|
msg = "\nUse of Damaris (command line argument --enable-damaris-output=true) has been disabled for run with only one rank.\n" ;
|
|
OpmLog::warning(msg);
|
|
enableDamarisOutput_ = false ;
|
|
}
|
|
|
|
if (enableDamarisOutput_) {
|
|
// Deal with empty (defaulted) output dir, should be deck dir
|
|
auto damarisOutputDir = outputDir;
|
|
if (outputDir.empty()) {
|
|
auto odir = std::filesystem::path{deckFilename}.parent_path();
|
|
if (odir.empty()) {
|
|
damarisOutputDir = ".";
|
|
} else {
|
|
damarisOutputDir = odir.generic_string();
|
|
}
|
|
}
|
|
// Damaris server ranks will block here until damaris_stop() is called by client ranks
|
|
this->setupDamaris(damarisOutputDir);
|
|
}
|
|
#endif // HAVE_DAMARIS
|
|
|
|
// Guard for when the Damaris core(s) return from damaris_start()
|
|
// which happens when damaris_stop() is called in main simulation
|
|
if (!isSimulationRank_) {
|
|
exitCode = EXIT_SUCCESS;
|
|
return true;
|
|
}
|
|
|
|
int mpiRank = FlowGenericVanguard::comm().rank();
|
|
outputCout_ = false;
|
|
if (mpiRank == 0)
|
|
outputCout_ = Parameters::Get<Parameters::EnableTerminalOutput>();
|
|
|
|
if (deckFilename.empty()) {
|
|
if (mpiRank == 0) {
|
|
std::cerr << "No input case given. Try '--help' for a usage description.\n";
|
|
}
|
|
exitCode = EXIT_FAILURE;
|
|
return false;
|
|
}
|
|
|
|
using PreVanguard = GetPropType<PreTypeTag, Properties::Vanguard>;
|
|
try {
|
|
deckFilename = PreVanguard::canonicalDeckPath(deckFilename);
|
|
}
|
|
catch (const std::exception& e) {
|
|
if ( mpiRank == 0 ) {
|
|
std::cerr << "Exception received: " << e.what() << ". Try '--help' for a usage description.\n";
|
|
}
|
|
#if HAVE_MPI
|
|
MPI_Abort(MPI_COMM_WORLD, EXIT_FAILURE);
|
|
#endif
|
|
exitCode = EXIT_FAILURE;
|
|
return false;
|
|
}
|
|
|
|
std::string cmdline_params;
|
|
if (outputCout_) {
|
|
printFlowBanner(FlowGenericVanguard::comm().size(),
|
|
getNumThreads(),
|
|
Opm::moduleVersionName());
|
|
std::ostringstream str;
|
|
Parameters::printValues(str);
|
|
cmdline_params = str.str();
|
|
}
|
|
|
|
// Create Deck and EclipseState.
|
|
try {
|
|
this->readDeck(deckFilename,
|
|
outputDir,
|
|
Parameters::Get<Parameters::OutputMode>(),
|
|
!Parameters::Get<Parameters::SchedRestart>(),
|
|
Parameters::Get<Parameters::EnableLoggingFalloutWarning>(),
|
|
Parameters::Get<Parameters::ParsingStrictness>(),
|
|
Parameters::Get<Parameters::ActionParsingStrictness>(),
|
|
Parameters::Get<Parameters::InputSkipMode>(),
|
|
keepKeywords,
|
|
getNumThreads(),
|
|
Parameters::Get<Parameters::EclOutputInterval>(),
|
|
cmdline_params,
|
|
Opm::moduleVersion(),
|
|
Opm::compileTimestamp());
|
|
setupTime_ = externalSetupTimer.elapsed();
|
|
}
|
|
catch (const std::invalid_argument& e)
|
|
{
|
|
if (outputCout_) {
|
|
std::cerr << "Failed to create valid EclipseState object." << std::endl;
|
|
std::cerr << "Exception caught: " << e.what() << std::endl;
|
|
}
|
|
#if HAVE_MPI
|
|
MPI_Abort(MPI_COMM_WORLD, EXIT_FAILURE);
|
|
#endif
|
|
exitCode = EXIT_FAILURE;
|
|
return false;
|
|
}
|
|
|
|
exitCode = EXIT_SUCCESS;
|
|
return true;
|
|
}
|
|
|
|
void setupVanguard();
|
|
|
|
private:
|
|
// This function is an extreme special case, if the program has been invoked
|
|
// *exactly* as:
|
|
//
|
|
// flow --version
|
|
//
|
|
// the call is intercepted by this function which will print "flow $version"
|
|
// on stdout and exit(0).
|
|
void handleVersionCmdLine_(int argc, char** argv,
|
|
std::string_view moduleVersionName);
|
|
|
|
// This function is a special case, if the program has been invoked
|
|
// with the argument "--test-split-communicator=true" as the FIRST
|
|
// argument, it will be removed from the argument list and we set the
|
|
// test_split_comm_ flag to true.
|
|
// Note: initializing the parameter system before MPI could make this
|
|
// use the parameter system instead.
|
|
void handleTestSplitCommunicatorCmdLine_();
|
|
|
|
int runMICP(const Phases& phases)
|
|
{
|
|
if (!phases.active(Phase::WATER) || (phases.size() > 2)) {
|
|
if (outputCout_) {
|
|
std::cerr << "No valid configuration is found for MICP simulation, "
|
|
<< "the only valid option is water + MICP\n";
|
|
}
|
|
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
return flowMICPMain(this->argc_,
|
|
this->argv_,
|
|
this->outputCout_,
|
|
this->outputFiles_);
|
|
}
|
|
|
|
int runTwoPhase(const Phases& phases)
|
|
{
|
|
const bool diffusive = eclipseState_->getSimulationConfig().isDiffusive();
|
|
const bool disgasw = eclipseState_->getSimulationConfig().hasDISGASW();
|
|
const bool vapwat = eclipseState_->getSimulationConfig().hasVAPWAT();
|
|
|
|
// oil-gas
|
|
if (phases.active( Phase::OIL ) && phases.active( Phase::GAS )) {
|
|
if (diffusive) {
|
|
return flowGasOilDiffuseMain(argc_, argv_, outputCout_, outputFiles_);
|
|
} else {
|
|
return flowGasOilMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
}
|
|
|
|
// oil-water
|
|
else if ( phases.active( Phase::OIL ) && phases.active( Phase::WATER ) ) {
|
|
if (diffusive) {
|
|
if (outputCout_) {
|
|
std::cerr << "The DIFFUSE option is not available for the two-phase water/oil model." << std::endl;
|
|
}
|
|
return EXIT_FAILURE;
|
|
}
|
|
return flowOilWaterMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
// gas-water
|
|
else if ( phases.active( Phase::GAS ) && phases.active( Phase::WATER ) ) {
|
|
if (disgasw || vapwat) {
|
|
if (diffusive) {
|
|
return flowGasWaterDissolutionDiffuseMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
return flowGasWaterDissolutionMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
if (diffusive) {
|
|
if (outputCout_) {
|
|
std::cerr << "The DIFFUSE option is not available for the two-phase gas/water model without disgasw or vapwat." << std::endl;
|
|
}
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
return flowGasWaterMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
else {
|
|
if (outputCout_) {
|
|
std::cerr << "No suitable configuration found, valid are Twophase (oilwater, oilgas and gaswater), polymer, solvent, or blackoil" << std::endl;
|
|
}
|
|
|
|
return EXIT_FAILURE;
|
|
}
|
|
}
|
|
|
|
int runPolymer(const Phases& phases)
|
|
{
|
|
if (! phases.active(Phase::WATER)) {
|
|
if (outputCout_)
|
|
std::cerr << "No valid configuration is found for polymer simulation, valid options include "
|
|
<< "oilwater + polymer and blackoil + polymer" << std::endl;
|
|
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
// Need to track the polymer molecular weight
|
|
// for the injectivity study
|
|
if (phases.active(Phase::POLYMW)) {
|
|
// only oil water two phase for now
|
|
assert (phases.size() == 4);
|
|
return flowOilWaterPolymerInjectivityMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
if (phases.size() == 3) { // oil water polymer case
|
|
return flowOilWaterPolymerMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
else {
|
|
return flowPolymerMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
}
|
|
|
|
int runFoam()
|
|
{
|
|
return flowFoamMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
int runWaterOnly(const Phases& phases)
|
|
{
|
|
if (!phases.active(Phase::WATER) || phases.size() != 1) {
|
|
if (outputCout_)
|
|
std::cerr << "No valid configuration is found for water-only simulation, valid options include "
|
|
<< "water, water + thermal" << std::endl;
|
|
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
return flowWaterOnlyMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
int runWaterOnlyEnergy(const Phases& phases)
|
|
{
|
|
if (!phases.active(Phase::WATER) || phases.size() != 2) {
|
|
if (outputCout_)
|
|
std::cerr << "No valid configuration is found for water-only simulation, valid options include "
|
|
<< "water, water + thermal" << std::endl;
|
|
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
return flowWaterOnlyEnergyMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
int runBrine(const Phases& phases)
|
|
{
|
|
if (! phases.active(Phase::WATER) || phases.size() == 2) {
|
|
if (outputCout_)
|
|
std::cerr << "No valid configuration is found for brine simulation, valid options include "
|
|
<< "oilwater + brine, gaswater + brine and blackoil + brine" << std::endl;
|
|
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
if (phases.size() == 3) {
|
|
|
|
if (phases.active(Phase::OIL)){ // oil water brine case
|
|
return flowOilWaterBrineMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
if (phases.active(Phase::GAS)){ // gas water brine case
|
|
if (eclipseState_->getSimulationConfig().hasPRECSALT() &&
|
|
eclipseState_->getSimulationConfig().hasVAPWAT()) {
|
|
//case with water vaporization into gas phase and salt precipitation
|
|
return flowGasWaterSaltprecVapwatMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
else {
|
|
return flowGasWaterBrineMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
}
|
|
}
|
|
else if (eclipseState_->getSimulationConfig().hasPRECSALT()) {
|
|
if (eclipseState_->getSimulationConfig().hasVAPWAT()) {
|
|
//case with water vaporization into gas phase and salt precipitation
|
|
return flowBrinePrecsaltVapwatMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
else {
|
|
return flowBrineSaltPrecipitationMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
}
|
|
else {
|
|
return flowBrineMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
int runSolvent(const Phases& phases)
|
|
{
|
|
if (phases.active(Phase::FOAM)) {
|
|
return flowSolventFoamMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
// solvent + gas + water
|
|
if (!phases.active( Phase::OIL ) && phases.active( Phase::WATER ) && phases.active( Phase::GAS )) {
|
|
return flowGasWaterSolventMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
// solvent + gas + water + oil
|
|
if (phases.active( Phase::OIL ) && phases.active( Phase::WATER ) && phases.active( Phase::GAS )) {
|
|
return flowSolventMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
if (outputCout_)
|
|
std::cerr << "No valid configuration is found for solvent simulation, valid options include "
|
|
<< "gas + water + solvent and gas + oil + water + solvent" << std::endl;
|
|
|
|
return EXIT_FAILURE;
|
|
}
|
|
|
|
int runExtendedBlackOil()
|
|
{
|
|
return flowExtboMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
int runThermal(const Phases& phases)
|
|
{
|
|
// oil-gas-thermal
|
|
if (!phases.active( Phase::WATER ) && phases.active( Phase::OIL ) && phases.active( Phase::GAS )) {
|
|
return flowGasOilEnergyMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
// water-gas-thermal
|
|
if (!phases.active( Phase::OIL ) && phases.active( Phase::WATER ) && phases.active( Phase::GAS )) {
|
|
|
|
if (phases.active(Phase::BRINE)){
|
|
return flowGasWaterSaltprecEnergyMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
return flowGasWaterEnergyMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
return flowEnergyMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
|
|
int runBlackOil()
|
|
{
|
|
const bool diffusive = eclipseState_->getSimulationConfig().isDiffusive();
|
|
if (diffusive) {
|
|
// Use the traditional linearizer, as the TpfaLinearizer does not
|
|
// support the diffusion module yet.
|
|
return flowBlackoilMain(argc_, argv_, outputCout_, outputFiles_);
|
|
} else {
|
|
return flowBlackoilTpfaMain(argc_, argv_, outputCout_, outputFiles_);
|
|
}
|
|
}
|
|
|
|
void readDeck(const std::string& deckFilename,
|
|
const std::string& outputDir,
|
|
const std::string& outputMode,
|
|
const bool init_from_restart_file,
|
|
const bool allRanksDbgPrtLog,
|
|
const std::string& parsingStrictness,
|
|
const std::string& actionParsingStrictness,
|
|
const std::string& inputSkipMode,
|
|
const bool keepKeywords,
|
|
const std::size_t numThreads,
|
|
const int output_param,
|
|
const std::string& parameters,
|
|
std::string_view moduleVersion,
|
|
std::string_view compileTimestamp);
|
|
|
|
static int getNumThreads()
|
|
{
|
|
|
|
int threads;
|
|
|
|
#ifdef _OPENMP
|
|
// This function is called before the parallel OpenMP stuff gets initialized.
|
|
// That initialization happens after the deck is read and we want this message.
|
|
// Hence we duplicate the code of setupParallelism to get the number of threads.
|
|
static bool first_time = true;
|
|
constexpr int default_threads = 2;
|
|
const int requested_threads = Parameters::Get<Parameters::ThreadsPerProcess>();
|
|
threads = requested_threads > 0 ? requested_threads : default_threads;
|
|
|
|
const char* env_var = getenv("OMP_NUM_THREADS");
|
|
if (env_var) {
|
|
int omp_num_threads = -1;
|
|
auto result = std::from_chars(env_var, env_var + std::strlen(env_var), omp_num_threads);
|
|
const bool can_output = first_time && FlowGenericVanguard::comm().rank() == 0;
|
|
if (result.ec == std::errc() && omp_num_threads > 0) {
|
|
// Set threads to omp_num_threads if it was successfully parsed and is positive
|
|
threads = omp_num_threads;
|
|
if (can_output && requested_threads > 0) {
|
|
std::cout << "Warning: Environment variable OMP_NUM_THREADS takes precedence over the --threads-per-process cmdline argument."
|
|
<< std::endl;
|
|
}
|
|
} else {
|
|
if (can_output) {
|
|
std::cout << ("Warning: Invalid value for OMP_NUM_THREADS environment variable.") << std::endl;
|
|
}
|
|
}
|
|
}
|
|
|
|
first_time = false;
|
|
#else
|
|
threads = 1;
|
|
#endif
|
|
return threads;
|
|
}
|
|
|
|
#if HAVE_DAMARIS
|
|
void setupDamaris(const std::string& outputDir);
|
|
#endif
|
|
|
|
protected:
|
|
int argc_{0};
|
|
char** argv_{nullptr};
|
|
bool outputCout_{false};
|
|
bool outputFiles_{false};
|
|
|
|
private:
|
|
bool ownMPI_{true}; //!< True if we "own" MPI and should init / finalize
|
|
double setupTime_{0.0};
|
|
std::string deckFilename_{};
|
|
std::string flowProgName_{};
|
|
char *saveArgs_[3]{nullptr};
|
|
std::unique_ptr<UDQState> udqState_{};
|
|
std::unique_ptr<Action::State> actionState_{};
|
|
std::unique_ptr<WellTestState> wtestState_{};
|
|
|
|
// These variables may be owned by both Python and the simulator
|
|
std::shared_ptr<EclipseState> eclipseState_{};
|
|
std::shared_ptr<Schedule> schedule_{};
|
|
std::shared_ptr<SummaryConfig> summaryConfig_{};
|
|
bool mpi_init_{true}; //!< True if MPI_Init should be called
|
|
bool mpi_finalize_{true}; //!< True if MPI_Finalize should be called
|
|
|
|
// To demonstrate run with non_world_comm
|
|
bool test_split_comm_ = false;
|
|
bool isSimulationRank_ = true;
|
|
#if HAVE_DAMARIS
|
|
bool enableDamarisOutput_ = false;
|
|
#endif
|
|
};
|
|
|
|
} // namespace Opm
|
|
|
|
#endif // OPM_MAIN_HEADER_INCLUDED
|