Loading...
Searching...
No Matches
PyBaseSimulator.hpp
/*
Copyright 2020 Equinor ASA.
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_PY_BASE_SIMULATOR_HEADER_INCLUDED
#define OPM_PY_BASE_SIMULATOR_HEADER_INCLUDED
#include <opm/models/utils/parametersystem.hpp>
#include <opm/models/utils/propertysystem.hh>
#include <opm/simulators/flow/FlowMain.hpp>
#include <opm/simulators/flow/python/PyMain.hpp>
#include <opm/simulators/flow/python/PyFluidState.hpp>
#include <opm/simulators/flow/python/PyMaterialState.hpp>
#include <opm/simulators/flow/python/Pybind11Exporter.hpp>
#include <opm/input/eclipse/EclipseState/EclipseState.hpp>
#include <opm/input/eclipse/EclipseState/SummaryConfig/SummaryConfig.hpp>
#include <opm/input/eclipse/Schedule/Schedule.hpp>
#include <opm/input/eclipse/Deck/Deck.hpp>
#include <map>
#include <memory>
#include <string>
#include <vector>
namespace Opm::Pybind {
template<class TypeTag>
class PyBaseSimulator
{
private:
using Simulator = GetPropType<TypeTag, Properties::Simulator>;
public:
PyBaseSimulator(const std::string& deckFilename,
const std::vector<std::string>& args);
PyBaseSimulator(std::shared_ptr<Deck> deck,
std::shared_ptr<EclipseState> state,
std::shared_ptr<Schedule> schedule,
std::shared_ptr<SummaryConfig> summary_config,
const std::vector<std::string>& args);
void advance(int report_step);
bool checkSimulationFinished();
int currentStep();
py::array_t<double>
getFluidStateVariable(const std::string& name) const;
py::array_t<double> getCellVolumes();
double getDT();
py::array_t<double> getPorosity();
py::array_t<double> getPrimaryVariable(const std::string& variable) const;
py::array_t<int> getPrimaryVarMeaning(const std::string& variable) const;
std::map<std::string, int>
getPrimaryVarMeaningMap(const std::string& variable) const;
int run();
using PyCArray = py::array_t<double, py::array::c_style | py::array::forcecast>;
void setPorosity(PyCArray array);
void setPrimaryVariable(const std::string& idx_name,
PyCArray array);
void setupMpi(bool init_mpi, bool finalize_mpi);
int step();
int stepCleanup();
int stepInit();
protected:
FlowMain<TypeTag>& getFlowMain() const;
PyFluidState<TypeTag>& getFluidState() const;
PyMaterialState<TypeTag>& getMaterialState() const;
const std::string deck_filename_{};
bool has_run_init_{false};
bool has_run_cleanup_{false};
bool mpi_init_{true};
bool mpi_finalize_{true};
// NOTE: the main_ pointer *must* be declared before the flow_main_ pointer
// to ensure that it is destroyed before the main object since the main object
// destructor will call MPI_Finalize() and flow_main_ object destructor will call
// MPI_Comm_free().
std::unique_ptr<PyMain<TypeTag>> main_{};
std::unique_ptr<FlowMain<TypeTag>> flow_main_{};
Simulator* simulator_{nullptr};
std::unique_ptr<PyFluidState<TypeTag>> fluid_state_{};
std::unique_ptr<PyMaterialState<TypeTag>> material_state_{};
std::shared_ptr<Deck> deck_{};
std::shared_ptr<EclipseState> eclipse_state_{};
std::shared_ptr<Schedule> schedule_{};
std::shared_ptr<SummaryConfig> summary_config_{};
std::vector<std::string> args_{};
}; // class PyBaseSimulator
} // namespace Opm::Pybind
#include <opm/simulators/flow/python/PyBaseSimulator_impl.hpp>
#endif // OPM_PY_BASE_SIMULATOR_HEADER_INCLUDED
Opm::Pybind::PyFluidState
Definition PyFluidState.hpp:36
Opm::Pybind::PyMaterialState
Definition PyMaterialState.hpp:33
Opm::GetPropType
typename Properties::Detail::GetPropImpl< TypeTag, Property >::type::type GetPropType
get the type alias defined in the property (equivalent to old macro GET_PROP_TYPE(....
Definition propertysystem.hh:233
parametersystem.hpp
This file provides the infrastructure to retrieve run-time parameters.
propertysystem.hh
The Opm property system, traits with inheritance.