particleContact.h

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2021 Jan E. Marquardt, Mathias J. Krause
 *  E-mail contact: info@openlb.net
 *  The most recent release of OpenLB can be downloaded at
 *  <http://www.openlb.net/>
 *
 *  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 2
 *  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, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA  02110-1301, USA.
*/
 
#ifndef PARTICLE_CONTACT_H
#define PARTICLE_CONTACT_H
 
#include "contactFunctions.h"
#include "contactHelpers.h"
#include "core/blockStructure.h"
#include "core/util.h"
#include <array>
#include <limits>
#include <utility>
 
namespace olb {
namespace particles {
namespace contact {
 
template <unsigned D>
struct ParticleContact {
  static_assert(D == 2 || D == 3, "Only D=2 and D=3 are supported");
  static const std::vector<unsigned int> indicesDim;
  static const std::vector<unsigned int> indicesPart;
  static const std::vector<unsigned int> indicesSingle;
};
 
template <>
const std::vector<unsigned int> ParticleContact<2>::indicesDim({0, 1});
template <>
const std::vector<unsigned int> ParticleContact<3>::indicesDim({0, 1, 2});
template <unsigned D>
const std::vector<unsigned int> ParticleContact<D>::indicesPart({0, 1});
template <unsigned D>
const std::vector<unsigned int> ParticleContact<D>::indicesSingle({0});
 
// Contact type to be used, if particle contact should be ignored (e.g., if only wall contact is of interest)
// TODO: struct IgnoreParticleContact : ParticleContact {};
 
template <typename T, unsigned D, bool CONVEX>
struct ParticleContactArbitraryFromOverlapVolume : ParticleContact<D> {
private:
  std::array<PhysR<T, D>, 2> particlePositions;
  PhysR<T, D> min;
  PhysR<T, D> max;
  std::array<std::size_t, 2> ids;
  std::array<T, 1> dampingFactor = {-1};
  std::array<bool, 1> particlePositionUpdated = {false};
  std::array<bool, 1> newContact = {true};
  std::array<int, 1> responsibleRank = {std::numeric_limits<int>::max()};
 
  static const std::size_t serialSize =
      sizeof(particlePositionUpdated) + sizeof(newContact) +
      sizeof(particlePositions) + sizeof(min) + sizeof(max) + sizeof(ids) +
      sizeof(responsibleRank) + sizeof(dampingFactor);
 
  template <typename F>
  std::size_t processWithCommunicatables(F f);
 
public:
  static_assert(D == 2 || D == 3, "Only D=2 and D=3 are supported");
  ParticleContactArbitraryFromOverlapVolume();
  ParticleContactArbitraryFromOverlapVolume(
      const std::array<std::size_t, 2>& particleIDs);
  ParticleContactArbitraryFromOverlapVolume(
      const ParticleContactArbitraryFromOverlapVolume<T, D, CONVEX>& pc);
  ParticleContactArbitraryFromOverlapVolume(
      ParticleContactArbitraryFromOverlapVolume<T, D, CONVEX>&& pc);
 
  constexpr const std::array<PhysR<T, D>, 2>& getParticlePositions() const;
  constexpr const PhysR<T, D>& getParticlePosition(const std::size_t& id) const;
  constexpr const PhysR<T, D>& getMin() const;
  constexpr const PhysR<T, D>& getMax() const;
  constexpr const std::array<std::size_t, 2>& getIDs() const;
  constexpr const T getDampingFactor() const;
  constexpr const int& getResponsibleRank() const;
 
  constexpr void
  setParticlePositions(const std::array<PhysR<T, D>, 2>& positions);
  constexpr void setParticlePosition(const PhysR<T, D>& position,
                                     const std::size_t& id);
  constexpr void setDampingFactor(const T dampingFactor);
  constexpr void
  setDampingFactorFromInitialVelocity(const T coefficientOfRestitution,
                                      const T initialRelativeVelocityMagnitude);
  constexpr void setResponsibleRank(const int& rank);
 
  constexpr void resetMinMax();
  constexpr void updateMinMax(const PhysR<T, D>& positionInsideTheContact);
  constexpr void increaseMinMax(const Vector<T, D>& increaseBy);
 
  constexpr void
  combineWith(ParticleContactArbitraryFromOverlapVolume<T, D, CONVEX>& pc);
  constexpr bool isEmpty() const;
  constexpr bool isNew() const;
  constexpr void isNew(const bool newContact);
  constexpr bool isParticlePositionUpdated() const;
  // Set if the particle position is up-to-date
  constexpr void setParticlePositionUpdated(bool updated);
  ParticleContactArbitraryFromOverlapVolume<T, D, CONVEX>&
  operator=(const ParticleContactArbitraryFromOverlapVolume<T, D, CONVEX>& pc);
  ParticleContactArbitraryFromOverlapVolume<T, D, CONVEX>&
  operator=(ParticleContactArbitraryFromOverlapVolume<T, D, CONVEX>&& pc);
 
  std::size_t serialize(std::uint8_t* buffer);
  std::size_t deserialize(std::uint8_t* buffer);
  constexpr static std::size_t getSerialSize() { return serialSize; };
 
  void print();
};
 
} // namespace contact
} // namespace particles
} // namespace olb
#endif