Loading...
Searching...
No Matches
ActionHandler.hpp
// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
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 2 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/>.
Consult the COPYING file in the top-level source directory of this
module for the precise wording of the license and the list of
copyright holders.
*/
#ifndef OPM_ACTION_HANDLER_HPP
#define OPM_ACTION_HANDLER_HPP
#include <opm/simulators/utils/ParallelCommunication.hpp>
#include <functional>
#include <string>
#include <unordered_map>
#include <vector>
namespace Opm::Action {
class State;
} // namespace Opm::Action
namespace Opm {
template<typename Scalar, typename IndexTraits> class BlackoilWellModelGeneric;
class EclipseState;
class Schedule;
struct SimulatorUpdate;
class SummaryState;
class UDQState;
} // namespace Opm
namespace Opm {
template<typename Scalar, typename IndexTraits>
class ActionHandler
{
public:
using TransFunc = std::function<void(bool)>;
ActionHandler(EclipseState& ecl_state,
Schedule& schedule,
Action::State& actionState,
SummaryState& summaryState,
BlackoilWellModelGeneric<Scalar, IndexTraits>& wellModel,
Parallel::Communication comm);
void applyActions(int reportStep,
double sim_time,
const TransFunc& updateTrans);
void evalUDQAssignments(const unsigned episodeIdx,
UDQState& udq_state);
void applySimulatorUpdate(int report_step,
const SimulatorUpdate& sim_update,
const TransFunc& updateTrans,
bool& commit_wellstate);
private:
EclipseState& ecl_state_;
Schedule& schedule_;
Action::State& actionState_;
SummaryState& summaryState_;
BlackoilWellModelGeneric<Scalar, IndexTraits>& wellModel_;
Parallel::Communication comm_;
};
} // namespace Opm
#endif // OPM_ACTION_HANDLER_HPP
Opm::ActionHandler::ActionHandler
ActionHandler(EclipseState &ecl_state, Schedule &schedule, Action::State &actionState, SummaryState &summaryState, BlackoilWellModelGeneric< Scalar, IndexTraits > &wellModel, Parallel::Communication comm)
Constructor.
Definition ActionHandler.cpp:173
Opm::ActionHandler::TransFunc
std::function< void(bool)> TransFunc
Function handle to update transmissiblities.
Definition ActionHandler.hpp:55
Opm::ActionHandler::applyActions
void applyActions(int reportStep, double sim_time, const TransFunc &updateTrans)
Run all pending actions.
Definition ActionHandler.cpp:189
Opm::ActionHandler::evalUDQAssignments
void evalUDQAssignments(const unsigned episodeIdx, UDQState &udq_state)
Evaluates UDQ assign statements.
Definition ActionHandler.cpp:297
Opm::ActionHandler::applySimulatorUpdate
void applySimulatorUpdate(int report_step, const SimulatorUpdate &sim_update, const TransFunc &updateTrans, bool &commit_wellstate)
Convey dynamic updates triggered by an action block back to the running simulator.
Definition ActionHandler.cpp:272
Opm::BlackoilWellModelGeneric
Class for handling the blackoil well model.
Definition BlackoilWellModelGeneric.hpp:95
Opm
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilbioeffectsmodules.hh:43