From 07e0d71906b8e1790a6a08142697a0335290abce Mon Sep 17 00:00:00 2001 From: Robert Kloefkorn Date: Wed, 23 Aug 2017 15:58:55 +0200 Subject: [PATCH] [feature][flow] Add a common executable for all flow variants, i.e. flow_ebos, flow_ebos_polymer, flow_ebos_solvent, flow_ebos_2p. --- CMakeLists.txt | 6 -- CMakeLists_files.cmake | 3 + examples/flow.cpp | 194 ++++++++++++++++++++++++++++++++++ opm/autodiff/FlowMainEbos.hpp | 38 ++++--- 4 files changed, 218 insertions(+), 23 deletions(-) create mode 100644 examples/flow.cpp diff --git a/CMakeLists.txt b/CMakeLists.txt index e93044d47..4a9250e82 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -130,9 +130,3 @@ endif (NOT EIGEN3_FOUND) if (HAVE_OPM_DATA) include (${CMAKE_CURRENT_SOURCE_DIR}/compareECLFiles.cmake) endif() - -# create a symbolic link from flow to flow_legacy -ADD_CUSTOM_TARGET(flow ALL - DEPENDS flow_ebos - COMMAND ${CMAKE_COMMAND} -E create_symlink "flow_ebos" "${CMAKE_BINARY_DIR}/bin/flow") -install(FILES ${CMAKE_BINARY_DIR}/bin/flow DESTINATION bin) diff --git a/CMakeLists_files.cmake b/CMakeLists_files.cmake index bb119f3ad..222edb60e 100644 --- a/CMakeLists_files.cmake +++ b/CMakeLists_files.cmake @@ -112,6 +112,7 @@ list (APPEND EXAMPLE_SOURCE_FILES examples/flow_legacy.cpp examples/flow_reorder.cpp examples/flow_sequential.cpp + examples/flow.cpp examples/flow_ebos.cpp examples/flow_ebos_2p.cpp examples/flow_ebos_solvent.cpp @@ -135,7 +136,9 @@ list (APPEND PROGRAM_SOURCE_FILES examples/sim_2p_incomp.cpp examples/sim_2p_incomp_ad.cpp examples/sim_2p_comp_reorder.cpp + examples/flow.cpp examples/flow_ebos.cpp + examples/flow_ebos_2p.cpp examples/flow_ebos_solvent.cpp examples/flow_ebos_polymer.cpp examples/flow_legacy.cpp diff --git a/examples/flow.cpp b/examples/flow.cpp new file mode 100644 index 000000000..24e3bc351 --- /dev/null +++ b/examples/flow.cpp @@ -0,0 +1,194 @@ +/* + Copyright 2013, 2014, 2015 SINTEF ICT, Applied Mathematics. + Copyright 2014 Dr. Blatt - HPC-Simulation-Software & Services + Copyright 2015, 2017 IRIS AS + + 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 . +*/ + +#if HAVE_CONFIG_H +#include "config.h" +#endif // HAVE_CONFIG_H + +#include + +#include + +#include +#include +#include +#include +#include +#include +#include + +// Define making clear that the simulator supports AMG +#define FLOW_SUPPORT_AMG 1 + +#include +#include + +#include +#include +#include + +namespace Ewoms { +namespace Properties { + + /////////////////////////////////// + // Twophase case + /////////////////////////////////// + + NEW_TYPE_TAG(EclFlowTwoPhaseProblem, INHERITS_FROM(EclFlowProblem)); + //! The indices required by the model + SET_TYPE_PROP(EclFlowTwoPhaseProblem, Indices, + Ewoms::BlackOilTwoPhaseIndices); + + + /////////////////////////////////// + // Polymer case + /////////////////////////////////// + + NEW_TYPE_TAG(EclFlowPolymerProblem, INHERITS_FROM(EclFlowProblem)); + SET_BOOL_PROP(EclFlowPolymerProblem, EnablePolymer, true); + + + /////////////////////////////////// + // Solvent case + /////////////////////////////////// + + NEW_TYPE_TAG(EclFlowSolventProblem, INHERITS_FROM(EclFlowProblem)); + SET_BOOL_PROP(EclFlowSolventProblem, EnableSolvent, true); + +}} // end namespaces + + +namespace detail +{ + boost::filesystem::path simulationCaseName( const std::string& casename ) { + namespace fs = boost::filesystem; + + const auto exists = []( const fs::path& f ) -> bool { + if( !fs::exists( f ) ) return false; + + if( fs::is_regular_file( f ) ) return true; + + return fs::is_symlink( f ) + && fs::is_regular_file( fs::read_symlink( f ) ); + }; + + auto simcase = fs::path( casename ); + + if( exists( simcase ) ) { + return simcase; + } + + for( const auto& ext : { std::string("data"), std::string("DATA") } ) { + if( exists( simcase.replace_extension( ext ) ) ) { + return simcase; + } + } + + throw std::invalid_argument( "Cannot find input case " + casename ); + } +} + + +// ----------------- Main program ----------------- +int main(int argc, char** argv) +{ + // MPI setup. + // Must ensure an instance of the helper is created to initialise MPI. + // For a build without MPI the Dune::FakeMPIHelper is used, so rank will + // be 0 and size 1. + const Dune::MPIHelper& mpi_helper = Dune::MPIHelper::instance(argc, argv); + const bool outputCout = mpi_helper.rank() == 0; + + Opm::ParameterGroup param(argc, argv, false, outputCout); + // See if a deck was specified on the command line. + if (!param.unhandledArguments().empty()) { + if (param.unhandledArguments().size() != 1) { + std::cerr << "You can only specify a single input deck on the command line.\n"; + return false; + } else { + const auto casename = detail::simulationCaseName( param.unhandledArguments()[ 0 ] ); + param.insertParameter("deck_filename", casename.string() ); + } + } + + std::string deckFilename = param.get("deck_filename"); + + // Create Deck and EclipseState. + try { + Opm::Parser parser; + typedef std::pair ParseModePair; + typedef std::vector ParseModePairs; + ParseModePairs tmp; + tmp.push_back(ParseModePair(Opm::ParseContext::PARSE_RANDOM_SLASH, Opm::InputError::IGNORE)); + tmp.push_back(ParseModePair(Opm::ParseContext::PARSE_MISSING_DIMS_KEYWORD, Opm::InputError::WARN)); + tmp.push_back(ParseModePair(Opm::ParseContext::SUMMARY_UNKNOWN_WELL, Opm::InputError::WARN)); + tmp.push_back(ParseModePair(Opm::ParseContext::SUMMARY_UNKNOWN_GROUP, Opm::InputError::WARN)); + Opm::ParseContext parseContext(tmp); + + std::shared_ptr deck = std::make_shared< Opm::Deck >( parser.parseFile(deckFilename , parseContext) ); + Opm::checkDeck(*deck, parser); + if ( outputCout ) { + Opm::MissingFeatures::checkKeywords(*deck); + } + + std::shared_ptr eclipseState = + std::make_shared< Opm::EclipseState > ( *deck, parseContext ); + + Opm::Runspec runspec( *deck ); + const auto& phases = runspec.phases(); + + // Twophase case + if( phases.size() == 2 ) { + Opm::FlowMainEbos mainfunc; + return mainfunc.execute(argc, argv, deck, eclipseState ); + } + // Polymer case + else if ( phases.active( Opm::Phase::POLYMER ) ) { + Opm::FlowMainEbos mainfunc; + return mainfunc.execute(argc, argv, deck, eclipseState ); + + } + // Solvent case + else if ( phases.active( Opm::Phase::SOLVENT ) ) { + Opm::FlowMainEbos mainfunc; + return mainfunc.execute(argc, argv, deck, eclipseState ); + + } + // Blackoil case + else if( phases.size() == 3 ) { + Opm::FlowMainEbos mainfunc; + return mainfunc.execute(argc, argv, deck, eclipseState ); + } + else + { + std::cerr << "No suitable configuration found, valid are Twophase, polymer, solvent, or blackoil" << std::endl; + return EXIT_FAILURE; + } + } + catch (const std::invalid_argument& e) + { + std::cerr << "Failed to create valid EclipseState object. See logfile: " << std::endl; + std::cerr << "Exception caught: " << e.what() << std::endl; + throw; + } + + return EXIT_SUCCESS; +} diff --git a/opm/autodiff/FlowMainEbos.hpp b/opm/autodiff/FlowMainEbos.hpp index 8b2ef145f..4334d988e 100755 --- a/opm/autodiff/FlowMainEbos.hpp +++ b/opm/autodiff/FlowMainEbos.hpp @@ -75,6 +75,7 @@ namespace Opm public: typedef typename GET_PROP(TypeTag, MaterialLaw)::EclMaterialLawManager MaterialLawManager; typedef typename GET_PROP_TYPE(TypeTag, Simulator) EbosSimulator; + typedef typename GET_PROP_TYPE(TypeTag, SimulatorParameter) EbosSimulatorParameter; typedef typename GET_PROP_TYPE(TypeTag, ElementMapper) ElementMapper; typedef typename GET_PROP_TYPE(TypeTag, Grid) Grid; typedef typename GET_PROP_TYPE(TypeTag, Problem) Problem; @@ -90,7 +91,9 @@ namespace Opm /// simulator classes, based on user command-line input. The /// content of this function used to be in the main() function of /// flow.cpp. - int execute(int argc, char** argv) + int execute(int argc, char** argv, + std::shared_ptr deck = std::shared_ptr(), + std::shared_ptr eclipseState = std::shared_ptr() ) { try { // we always want to use the default locale, and thus spare us the trouble @@ -104,7 +107,7 @@ namespace Opm return EXIT_FAILURE; } - setupEbosSimulator(); + setupEbosSimulator( deck, eclipseState ); setupOutput(); setupLogging(); printPRTHeader(); @@ -180,8 +183,8 @@ namespace Opm // Print startup message if on output rank. void printStartupMessage() - { - + { + if (output_cout_) { const int lineLen = 70; const std::string version = moduleVersionName(); @@ -338,29 +341,29 @@ namespace Opm streamLog->setMessageFormatter(std::make_shared(true)); if ( output_cout_ ) - { + { // Read Parameters. OpmLog::debug("\n--------------- Reading parameters ---------------\n"); } } - + void printPRTHeader() { - // Print header for PRT file. + // Print header for PRT file. if ( output_cout_ ) { const std::string version = moduleVersionName(); const double megabyte = 1024 * 1024; - unsigned num_cpu = std::thread::hardware_concurrency(); + unsigned num_cpu = std::thread::hardware_concurrency(); struct utsname arch; - const char* user = getlogin(); + const char* user = getlogin(); time_t now = std::time(0); struct tm tstruct; char tmstr[80]; tstruct = *localtime(&now); strftime(tmstr, sizeof(tmstr), "%d-%m-%Y at %X", &tstruct); - const double mem_size = getTotalSystemMemory() / megabyte; + const double mem_size = getTotalSystemMemory() / megabyte; std::ostringstream ss; - ss << "\n\n\n ######## # ###### # #\n"; + ss << "\n\n\n ######## # ###### # #\n"; ss << " # # # # # # \n"; ss << " ##### # # # # # # \n"; ss << " # # # # # # # # \n"; @@ -377,11 +380,11 @@ namespace Opm if (user) { ss << "User = " << user << std::endl; } - ss << "Simulation started on " << tmstr << " hrs\n"; + ss << "Simulation started on " << tmstr << " hrs\n"; OpmLog::note(ss.str()); } } - + void mergeParallelLogFiles() { // force closing of all log files. @@ -406,7 +409,7 @@ namespace Opm detail::ParallelFileMerger(output_path, deck_filename.stem().string())); } - void setupEbosSimulator() + void setupEbosSimulator( std::shared_ptr& dck, std::shared_ptr& eclipseState) { std::string progName("flow_ebos"); std::string deckFile("--ecl-deck-file-name="); @@ -414,9 +417,10 @@ namespace Opm char* ptr[2]; ptr[ 0 ] = const_cast< char * > (progName.c_str()); ptr[ 1 ] = const_cast< char * > (deckFile.c_str()); + EbosSimulatorParameter simParam( dck, eclipseState ); EbosSimulator::registerParameters(); Ewoms::setupParameters_< TypeTag > ( 2, ptr ); - ebosSimulator_.reset(new EbosSimulator(/*verbose=*/false)); + ebosSimulator_.reset(new EbosSimulator(simParam, /*verbose=*/false)); ebosSimulator_->model().applyInitialSolution(); // Create a grid with a global view. @@ -737,7 +741,7 @@ namespace Opm throw std::invalid_argument( "Cannot find input case " + casename ); } - + unsigned long long getTotalSystemMemory() { long pages = sysconf(_SC_PHYS_PAGES); @@ -955,4 +959,4 @@ namespace Opm }; } // namespace Opm -#endif // OPM_FLOW_MAIN_EBOS_HEADER_INCLUDED +#endif // OPM_FLOW_MAIN_EBOS_HEADER_INCLUDED