multidomain/fvgridvariables.hh

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:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program 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.                                     *
 *                                                                           *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
#ifndef DUMUX_MULTIDOMAIN_FV_GRID_VARIABLES_HH
#define DUMUX_MULTIDOMAIN_FV_GRID_VARIABLES_HH
 
#include <tuple>
#include <memory>
#include <utility>
 
#include <dune/common/hybridutilities.hh>
#include <dune/common/indices.hh>
 
#include <dumux/multidomain/fvgridgeometry.hh>
#include <dumux/multidomain/fvproblem.hh>
 
namespace Dumux {
 
template<class MDTraits>
class MultiDomainFVGridVariables
{
    using SolutionVector = typename MDTraits::SolutionVector;
    static constexpr std::size_t numSubDomains = MDTraits::numSubDomains;
 
    template<std::size_t i>
    using GridGeometry = typename MDTraits::template SubDomain<i>::GridGeometry;
    using GridGeometries = typename MDTraits::template TupleOfSharedPtrConst<GridGeometry>;
 
    template<std::size_t i>
    using Problem = typename MDTraits::template SubDomain<i>::Problem;
    using Problems = typename MDTraits::template TupleOfSharedPtrConst<Problem>;
 
public:
    template<std::size_t i>
    using Type = typename MDTraits::template SubDomain<i>::GridVariables;
 
    template<std::size_t i>
    using PtrType = std::shared_ptr<Type<i>>;
 
    using TupleType = typename MDTraits::template Tuple<PtrType>;
 
    [[deprecated("Will be removed after release 3.5. Use one of the constructors instead.")]]
    MultiDomainFVGridVariables() = default;
 
    MultiDomainFVGridVariables(MultiDomainFVGridGeometry<MDTraits> gridGeometries, MultiDomainFVProblem<MDTraits> problems)
    {
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<numSubDomains>{}, [&](auto&& id)
        {
            constexpr auto i = std::decay_t<decltype(id)>::value;
            std::get<i>(gridVars_) = std::make_shared<Type<i>>(
                problems.template get<i>(), gridGeometries.template get<i>()
            );
        });
    }
 
    MultiDomainFVGridVariables(TupleType ggTuple)
    : gridVars_(std::move(ggTuple))
    {}
 
    void init(const SolutionVector& sol)
    {
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<numSubDomains>{}, [&](auto&& id)
        {
            elementAt(gridVars_, id)->init(sol[id]);
        });
    }
 
    void update(const SolutionVector& sol, bool forceFluxCacheUpdate = false)
    {
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<numSubDomains>{}, [&](auto&& id)
        {
            elementAt(gridVars_, id)->update(sol[id], forceFluxCacheUpdate);
        });
    }
 
    void updateAfterGridAdaption(const SolutionVector& sol)
    {
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<numSubDomains>{}, [&](auto&& id)
        {
            elementAt(gridVars_, id)->updateAfterGridAdaption(sol[id]);
        });
    }
 
    void advanceTimeStep()
    {
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<numSubDomains>{}, [&](auto&& id)
        {
            elementAt(gridVars_, id)->advanceTimeStep();
        });
    }
 
    void resetTimeStep(const SolutionVector& sol)
    {
        using namespace Dune::Hybrid;
        forEach(std::make_index_sequence<numSubDomains>{}, [&](auto&& id)
        {
            elementAt(gridVars_, id)->resetTimeStep(sol[id]);
        });
    }
 
    template<std::size_t i>
    const Type<i>& operator[] (Dune::index_constant<i> id) const
    { return *std::get<i>(gridVars_); }
 
    template<std::size_t i>
    Type<i>& operator[] (Dune::index_constant<i> id)
    { return *std::get<i>(gridVars_); }
 
    template<std::size_t i>
    const PtrType<i>& get(Dune::index_constant<i> id = Dune::index_constant<i>{}) const
    { return std::get<i>(gridVars_); }
 
    template<std::size_t i>
    PtrType<i>& get(Dune::index_constant<i> id = Dune::index_constant<i>{})
    { return std::get<i>(gridVars_); }
 
    template<std::size_t i>
    [[deprecated("Will be removed after release 3.5. Use one of the constructors instead.")]]
    void set(PtrType<i> p, Dune::index_constant<i> id = Dune::index_constant<i>{})
    { Dune::Hybrid::elementAt(gridVars_, id) = p; }
 
    [[deprecated("Use asTuple. Will be removed after release 3.5")]]
    TupleType getTuple()
    { return gridVars_; }
 
    TupleType& asTuple()
    { return gridVars_; }
 
    const TupleType& asTuple() const
    { return gridVars_; }
 
private:
 
    TupleType gridVars_;
};
 
} // end namespace Dumux
 
#endif