BaseAquiferModel.hpp

Go to the documentation of this file.

// -*- 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_BASE_AQUIFER_MODEL_HPP
#define OPM_BASE_AQUIFER_MODEL_HPP

#include <opm/models/discretization/common/fvbaseproperties.hh>
#include <opm/models/utils/basicproperties.hh>
#include <opm/models/utils/propertysystem.hh>

#include <opm/output/data/Aquifer.hpp>

#include <stdexcept>

namespace Opm {

template <class TypeTag>
class BaseAquiferModel
{
    using Simulator = GetPropType<TypeTag, Properties::Simulator>;
    using RateVector = GetPropType<TypeTag, Properties::RateVector>;

public:
    explicit BaseAquiferModel(Simulator& simulator)
        : simulator_(simulator)
    {}

    void initialSolutionApplied()
    { }

    void initFromRestart(const data::Aquifers&)
    {
        throw std::logic_error {
            "Initialization from restart data not supported "
            "for base aquifer model"
        };
    }

    void beginEpisode()
    { }

    void beginTimeStep()
    { }

    void beginIteration()
    { }

    template <class Context>
    void addToSource(RateVector&,
                     const Context&,
                     unsigned,
                     unsigned) const
    { }


    void addToSource(RateVector&,
                     unsigned,
                     unsigned) const
    { }


    void endIteration()
    { }

    void endTimeStep()
    { }

    void endEpisode()
    { }

    template <class Restarter>
    void serialize(Restarter&)
    { }

    template <class Restarter>
    void deserialize(Restarter&)
    { }

    data::Aquifers aquiferData() const
    { return data::Aquifers{}; }

protected:
    Simulator& simulator_;
};

} // namespace Opm

#endif // OPM_BASE_AQUIFER_MODEL_HPP