vectorcommdatahandle.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:
//
// SPDX-FileCopyrightText: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_VECTOR_COMM_DATA_HANDLE_HH
#define DUMUX_VECTOR_COMM_DATA_HANDLE_HH
 
#include <algorithm>
#include <bitset>
 
#include <dune/grid/common/datahandleif.hh>
 
#include <dumux/common/multimapperview.hh>
 
namespace Dumux {
 
namespace Detail {
 
    struct SetEqual
    {
        template<class A, class B>
        static void apply(A& a, const B& b)
        { a = b; }
    };
 
    struct Sum
    {
        template<class A, class B>
        static void apply(A& a, const B& b)
        { a += b; }
    };
 
    struct Max
    {
        template<class A, class B>
        static void apply(A& a, const B& b)
        {
            using std::max;
            a = max(a,b);
        }
    };
 
    struct Min
    {
        template<class A, class B>
        static void apply(A& a, const B& b)
        {
            using std::min;
            a = min(a,b);
        }
    };
} // end namespace Detail

template<class Mapper, class Vector, int entityCodim,
         class ScatterOperator, class DataT = typename Vector::value_type>
class VectorCommDataHandle
  : public Dune::CommDataHandleIF<VectorCommDataHandle<Mapper, Vector, entityCodim, ScatterOperator, DataT>, DataT>
{
public:
  using DataType = DataT;
 
  VectorCommDataHandle(const Mapper& mapper, Vector& vector)
  : mapper_(mapper), vector_(vector)
  {}

  bool contains(int, int codim) const
  { return (codim == entityCodim); }

  bool fixedSize(int /*gridDim*/, int codim) const
  {
      if (codim != entityCodim) return true;
      const auto& gtypes = mapper_.types(codim);
      if (gtypes.empty()) return true;
      const auto nDofs = mapper_.size(gtypes[0]);
      for (const auto& gt : gtypes)
          if (mapper_.size(gt) != nDofs) return false;
      return true;
  }

  template<class Entity>
  std::size_t size(Entity& entity) const
    { return asMultiMapper(mapper_).indices(entity).size(); }

  template<class MessageBuffer, class Entity>
  void gather(MessageBuffer& buff, const Entity& entity) const
  {
      for (auto i : asMultiMapper(mapper_).indices(entity))
          buff.write(vector_[i]);
  }

  template<class MessageBuffer, class Entity>
  void scatter(MessageBuffer& buff, const Entity& entity, std::size_t n)
  {
      for (auto i : asMultiMapper(mapper_).indices(entity)) {
          DataType x;
          buff.read(x);
          ScatterOperator::apply(vector_[i], x);
      }
  }
 
protected:
  const Mapper& mapper_;
  Vector& vector_;
};

template<class Mapper, class Vector, int dim,
         class ScatterOperator, class DataT = typename Vector::value_type>
class MultiCodimVectorCommDataHandle
  : public Dune::CommDataHandleIF<MultiCodimVectorCommDataHandle<Mapper, Vector, dim, ScatterOperator, DataT>, DataT>
{
public:
  using DataType = DataT;
  static_assert(dim >= 0, "Grid dimension must be non-negative");
 
  MultiCodimVectorCommDataHandle(const Mapper& mapper,
                                 Vector& vector,
                                 std::bitset<dim+1> activeCodims)
  : mapper_(mapper), vector_(vector), activeCodims_(std::move(activeCodims))
  {}

  bool contains(int, int codim) const
  {
      return codim >= 0
             && codim <= static_cast<int>(dim)
             && activeCodims_.test(codim);
  }

  bool fixedSize(int /*gridDim*/, int codim) const
  {
      if (codim < 0 || codim > dim || !activeCodims_.test(codim))
          return true;
      const auto& gtypes = mapper_.types(codim);
      if (gtypes.empty()) return true;
      const auto nDofs = mapper_.size(gtypes[0]);
      for (const auto& gt : gtypes)
          if (mapper_.size(gt) != nDofs) return false;
      return true;
  }

  template<class Entity>
  std::size_t size(Entity& entity) const
    { return asMultiMapper(mapper_).indices(entity).size(); }

  template<class MessageBuffer, class Entity>
  void gather(MessageBuffer& buff, const Entity& entity) const
  {
      for (auto i : asMultiMapper(mapper_).indices(entity))
          buff.write(vector_[i]);
  }

  template<class MessageBuffer, class Entity>
  void scatter(MessageBuffer& buff, const Entity& entity, std::size_t n)
  {
      for (auto i : asMultiMapper(mapper_).indices(entity)) {
          DataType x;
          buff.read(x);
          ScatterOperator::apply(vector_[i], x);
      }
  }
 
protected:
  const Mapper& mapper_;
  Vector& vector_;
  std::bitset<dim+1> activeCodims_;
};
 
template<class Mapper, class Vector, int codim, class DataType = typename Vector::value_type>
using VectorCommDataHandleEqual = VectorCommDataHandle<Mapper, Vector, codim, Detail::SetEqual, DataType>;
 
template<class Mapper, class Vector, int codim, class DataType = typename Vector::value_type>
using VectorCommDataHandleSum = VectorCommDataHandle<Mapper, Vector, codim, Detail::Sum, DataType>;
 
template<class Mapper, class Vector, int codim, class DataType = typename Vector::value_type>
using VectorCommDataHandleMin = VectorCommDataHandle<Mapper, Vector, codim, Detail::Min, DataType>;
 
template<class Mapper, class Vector, int codim, class DataType = typename Vector::value_type>
using VectorCommDataHandleMax = VectorCommDataHandle<Mapper, Vector, codim, Detail::Max, DataType>;
 
template<class Mapper, class Vector, int dim, class DataType = typename Vector::value_type>
using MultiCodimVectorCommDataHandleEqual = MultiCodimVectorCommDataHandle<Mapper, Vector, dim, Detail::SetEqual, DataType>;
 
template<class Mapper, class Vector, int dim, class DataType = typename Vector::value_type>
using MultiCodimVectorCommDataHandleSum = MultiCodimVectorCommDataHandle<Mapper, Vector, dim, Detail::Sum, DataType>;
 
template<class Mapper, class Vector, int dim, class DataType = typename Vector::value_type>
using MultiCodimVectorCommDataHandleMin = MultiCodimVectorCommDataHandle<Mapper, Vector, dim, Detail::Min, DataType>;
 
template<class Mapper, class Vector, int dim, class DataType = typename Vector::value_type>
using MultiCodimVectorCommDataHandleMax = MultiCodimVectorCommDataHandle<Mapper, Vector, dim, Detail::Max, DataType>;
 
} // end namespace Dumux
 
#endif