olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX > Struct Template Reference

#include <wallContact.h>

Inheritance diagram for olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >:

Collaboration diagram for olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >:

Public Member Functions
	WallContactArbitraryFromOverlapVolume ()
	Constructor.
	WallContactArbitraryFromOverlapVolume (std::size_t particleID, unsigned wallID)
	Constructor.
	WallContactArbitraryFromOverlapVolume (const WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &contact)
	Copy Constructor.
	WallContactArbitraryFromOverlapVolume (WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &&contact)
	Move Constructor.
constexpr const PhysR< T, D > &	getParticlePosition () const
	Return particle position.
constexpr const PhysR< T, D > &	getMin () const
	Read access to min.
constexpr const PhysR< T, D > &	getMax () const
	Read access to max.
constexpr const std::size_t &	getParticleID () const
	Read access to particle ID.
constexpr unsigned	getWallID () const
	Read access to wall matreial.
constexpr T	getDampingFactor () const
	Read access to damping factor.
constexpr const int &	getResponsibleRank () const
	Read access to the responsible rank.
constexpr void	setParticlePosition (const PhysR< T, D > &particlePosition)
	Set particle position.
constexpr void	setDampingFactor (const T dampingFactor)
	Set damping factor for contact.
constexpr void	setDampingFactorFromInitialVelocity (const T coefficientOfRestitution, const T initialRelativeVelocityMagnitude)
	Set damping factor from the magnitude of the initial relative impact velocity in direction of contact normal and the wanted coefficient of restitution.
constexpr void	setResponsibleRank (const int &rank)
	Set processor that is responsible for contact treatment.
constexpr void	resetMinMax ()
	Reset min and max to default values.
constexpr void	updateMinMax (const PhysR< T, D > &positionInsideTheContact)
	Update min and max with given position inside the contact.
constexpr void	increaseMinMax (const Vector< T, D > &increaseBy)
	Increase bounding box size.
constexpr void	combineWith (WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &contact)
	Combining two contacts, if the particle IDs are the same.
constexpr bool	isEmpty () const
	Returns if contact holds data.
constexpr bool	isNew () const
	Returns if the contact is a new contact.
constexpr void	isNew (const bool newContact)
	Sets 'isNew'.
constexpr bool	isParticlePositionUpdated () const
	Returns if the particle position is up-to-date.
constexpr void	setParticlePositionUpdated (bool updated)
WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &	operator= (const WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &contact)
	Copy assignment.
WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &	operator= (WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &&contact)
	Move assignment.
std::size_t	serialize (std::uint8_t *buffer)
	Serialize contact data.
std::size_t	deserialize (std::uint8_t *buffer)
	Deserialize contact data and save in object.
void	print ()
	Print relevant quantities.
Public Member Functions inherited from olb::particles::contact::WallContact< D >
const std::vector< unsigned int >	indicesDim ({0, 1})
const std::vector< unsigned int >	indicesDim ({0, 1, 2})

Static Public Member Functions
static constexpr std::size_t	getSerialSize ()
	Get serial size.

Additional Inherited Members
Static Public Attributes inherited from olb::particles::contact::WallContact< D >
static const std::vector< unsigned int >	indicesDim
static const std::vector< unsigned int >	indicesSingle

Detailed Description

template<typename T, unsigned D, bool CONVEX>
struct olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >

Definition at line 57 of file wallContact.h.

Constructor & Destructor Documentation

WallContactArbitraryFromOverlapVolume() [1/4]

template<typename T , unsigned D, bool CONVEX>

olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::WallContactArbitraryFromOverlapVolume

(

)

Constructor.

Definition at line 35 of file wallContact.hh.

    : WallContactArbitraryFromOverlapVolume<T, D, CONVEX>(std::size_t(),
                                                          unsigned())
{}

WallContactArbitraryFromOverlapVolume() [2/4]

template<typename T , unsigned D, bool CONVEX>

olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::WallContactArbitraryFromOverlapVolume	(	std::size_t	particleID,
		unsigned	wallID )

Constructor.

Definition at line 42 of file wallContact.hh.

    : particleID(std::array<std::size_t, 1>({particleID}))
    , wallID(std::array<unsigned, 1>({wallID}))
 
{
  resetMinMax();
}

WallContactArbitraryFromOverlapVolume() [3/4]

template<typename T , unsigned D, bool CONVEX>

olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::WallContactArbitraryFromOverlapVolume

(

const WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &

contact

)

Copy Constructor.

Definition at line 52 of file wallContact.hh.

{
  min                        = contact.min;
  max                        = contact.max;
  particleID[0]              = contact.particleID[0];
  wallID[0]                  = contact.wallID[0];
  particlePosition           = contact.particlePosition;
  particlePositionUpdated[0] = contact.isParticlePositionUpdated();
  dampingFactor[0]           = contact.getDampingFactor();
  newContact[0]              = contact.isNew();
  responsibleRank[0]         = contact.getResponsibleRank();
}

References olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getDampingFactor(), olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getResponsibleRank(), olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::isNew(), and olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::isParticlePositionUpdated().

Here is the call graph for this function:

WallContactArbitraryFromOverlapVolume() [4/4]

template<typename T , unsigned D, bool CONVEX>

olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::WallContactArbitraryFromOverlapVolume

(

WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &&

contact

)

Move Constructor.

Definition at line 68 of file wallContact.hh.

{
  min                     = std::move(contact.min);
  max                     = std::move(contact.max);
  particleID              = std::move(contact.particleID);
  wallID                  = std::move(contact.wallID);
  particlePosition        = std::move(contact.particlePosition);
  particlePositionUpdated = std::move(contact.particlePositionUpdated);
  dampingFactor           = std::move(contact.dampingFactor);
  newContact              = std::move(contact.newContact);
  responsibleRank         = std::move(contact.responsibleRank);
}

Member Function Documentation

combineWith()

template<typename T , unsigned D, bool CONVEX>

constexpr void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::combineWith ( WallContactArbitraryFromOverlapVolume< T, D, CONVEX > & contact )

constexpr

Combining two contacts, if the particle IDs are the same.

Definition at line 197 of file wallContact.hh.

{
  if (particleID[0] == contact.particleID[0] &&
      wallID[0] == contact.wallID[0]) {
    newContact[0] = newContact[0] && contact.isNew();
 
    // Determine bounding box of combined overlap area
    for (unsigned iD = 0; iD < D; ++iD) {
      min[iD] = util::min(min[iD], contact.min[iD]);
      max[iD] = util::max(max[iD], contact.max[iD]);
    }
    // The damping factors should be either the same or one is -1 and the other has the correct value which is > 0
    dampingFactor[0] = util::max(dampingFactor[0], contact.getDampingFactor());
    responsibleRank[0] =
        util::min(responsibleRank[0], contact.getResponsibleRank());
    particlePositionUpdated[0] =
        particlePositionUpdated[0] || contact.isParticlePositionUpdated();
    if (!particlePositionUpdated[0] && contact.isParticlePositionUpdated()) {
      particlePosition = contact.getParticlePosition();
    }
 
    // Ignore second contact by resetting it
    contact.resetMinMax();
  }
}

References olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getDampingFactor(), olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getParticlePosition(), olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getResponsibleRank(), olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::isNew(), olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::isParticlePositionUpdated(), olb::util::max(), olb::util::min(), and olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::resetMinMax().

Here is the call graph for this function:

deserialize()

template<typename T , unsigned D, bool CONVEX>

std::size_t olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::deserialize

(

std::uint8_t *

buffer

)

Deserialize contact data and save in object.

Definition at line 360 of file wallContact.hh.

{
  return processWithCommunicatables(
      [&](auto& communicatablePosition, auto& communicatableMin,
          auto& communicatableMax, auto& communicatableID,
          auto& communicatableMaterial, auto& communicatableDamping,
          auto& communicatableParticlePositionUpdated,
          auto& communicatableIsNew, auto& communicatableRank) {
        std::size_t serialIdx =
            communicatablePosition.deserialize(this->indicesDim, buffer);
        serialIdx +=
            communicatableMin.deserialize(this->indicesDim, &buffer[serialIdx]);
        serialIdx +=
            communicatableMax.deserialize(this->indicesDim, &buffer[serialIdx]);
        serialIdx += communicatableID.deserialize(this->indicesSingle,
                                                  &buffer[serialIdx]);
        serialIdx += communicatableMaterial.deserialize(this->indicesSingle,
                                                        &buffer[serialIdx]);
        serialIdx += communicatableDamping.deserialize(this->indicesSingle,
                                                       &buffer[serialIdx]);
        serialIdx += communicatableParticlePositionUpdated.deserialize(
            this->indicesSingle, &buffer[serialIdx]);
        serialIdx += communicatableIsNew.deserialize(this->indicesSingle,
                                                     &buffer[serialIdx]);
        serialIdx += communicatableRank.deserialize(this->indicesSingle,
                                                    &buffer[serialIdx]);
 
        return serialIdx;
      });
}

getDampingFactor()

template<typename T , unsigned D, bool CONVEX>

constexpr T olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getDampingFactor ( ) const

constexpr

Read access to damping factor.

Definition at line 144 of file wallContact.hh.

{
  return dampingFactor[0];
}

Here is the caller graph for this function:

getMax()

template<typename T , unsigned D, bool CONVEX>

constexpr const PhysR< T, D > & olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getMax ( ) const

constexpr

Read access to max.

Definition at line 137 of file wallContact.hh.

{
  return this->max;
}

Here is the caller graph for this function:

getMin()

template<typename T , unsigned D, bool CONVEX>

constexpr const PhysR< T, D > & olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getMin ( ) const

constexpr

Read access to min.

Definition at line 130 of file wallContact.hh.

{
  return this->min;
}

Here is the caller graph for this function:

getParticleID()

template<typename T , unsigned D, bool CONVEX>

constexpr const std::size_t & olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getParticleID ( ) const

constexpr

Read access to particle ID.

Definition at line 85 of file wallContact.hh.

{
  return this->particleID[0];
}

Here is the caller graph for this function:

getParticlePosition()

template<typename T , unsigned D, bool CONVEX>

constexpr const PhysR< T, D > & olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getParticlePosition ( ) const

constexpr

Return particle position.

Definition at line 99 of file wallContact.hh.

{
  return particlePosition;
}

Here is the caller graph for this function:

getResponsibleRank()

template<typename T , unsigned D, bool CONVEX>

constexpr const int & olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getResponsibleRank ( ) const

constexpr

Read access to the responsible rank.

Definition at line 123 of file wallContact.hh.

{
  return responsibleRank[0];
}

Here is the caller graph for this function:

getSerialSize()

template<typename T , unsigned D, bool CONVEX>

static constexpr std::size_t olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getSerialSize ( )

inlinestaticconstexpr

Get serial size.

Definition at line 160 of file wallContact.h.

{ return serialSize; };

getWallID()

template<typename T , unsigned D, bool CONVEX>

constexpr unsigned olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getWallID ( ) const

constexpr

Read access to wall matreial.

Definition at line 92 of file wallContact.hh.

{
  return this->wallID[0];
}

Here is the caller graph for this function:

increaseMinMax()

template<typename T , unsigned D, bool CONVEX>

constexpr void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::increaseMinMax ( const Vector< T, D > & increaseBy )

constexpr

Increase bounding box size.

Definition at line 189 of file wallContact.hh.

{
  this->max += increaseBy;
  this->min -= increaseBy;
}

Here is the caller graph for this function:

isEmpty()

template<typename T , unsigned D, bool CONVEX>

constexpr bool olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::isEmpty ( ) const

constexpr

Returns if contact holds data.

Definition at line 226 of file wallContact.hh.

{
  for (unsigned iD = 0; iD < D; ++iD) {
    if (min[iD] > max[iD]) {
      return true;
    }
  }
  return false;
}

Here is the caller graph for this function:

isNew() [1/2]

template<typename T , unsigned D, bool CONVEX>

constexpr bool olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::isNew ( ) const

constexpr

Returns if the contact is a new contact.

Definition at line 238 of file wallContact.hh.

{
  return newContact[0];
}

Here is the caller graph for this function:

isNew() [2/2]

template<typename T , unsigned D, bool CONVEX>

constexpr void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::isNew ( const bool newContact )

constexpr

Sets 'isNew'.

Definition at line 244 of file wallContact.hh.

{
  this->newContact[0] = newContact;
}

isParticlePositionUpdated()

template<typename T , unsigned D, bool CONVEX>

constexpr bool olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::isParticlePositionUpdated ( ) const

constexpr

Returns if the particle position is up-to-date.

Definition at line 252 of file wallContact.hh.

{
  return particlePositionUpdated[0];
}

Here is the caller graph for this function:

operator=() [1/2]

template<typename T , unsigned D, bool CONVEX>

WallContactArbitraryFromOverlapVolume< T, D, CONVEX > & olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::operator=

(

const WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &

contact

)

Copy assignment.

Definition at line 268 of file wallContact.hh.

{
  min                        = contact.min;
  max                        = contact.max;
  particleID[0]              = contact.particleID[0];
  wallID[0]                  = contact.wallID[0];
  particlePosition           = contact.particlePosition;
  particlePositionUpdated[0] = contact.isParticlePositionUpdated();
  dampingFactor[0]           = contact.getDampingFactor();
  newContact[0]              = contact.isNew();
  responsibleRank[0]         = contact.getResponsibleRank();
 
  return *this;
}

References olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getDampingFactor(), olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::getResponsibleRank(), olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::isNew(), and olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::isParticlePositionUpdated().

Here is the call graph for this function:

operator=() [2/2]

template<typename T , unsigned D, bool CONVEX>

WallContactArbitraryFromOverlapVolume< T, D, CONVEX > & olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::operator=

(

WallContactArbitraryFromOverlapVolume< T, D, CONVEX > &&

contact

)

Move assignment.

Definition at line 286 of file wallContact.hh.

{
  min                     = std::move(contact.min);
  max                     = std::move(contact.max);
  particleID              = std::move(contact.particleID);
  wallID                  = std::move(contact.wallID);
  particlePosition        = std::move(contact.particlePosition);
  particlePositionUpdated = std::move(contact.particlePositionUpdated);
  dampingFactor           = std::move(contact.dampingFactor);
  newContact              = std::move(contact.newContact);
  responsibleRank         = std::move(contact.responsibleRank);
 
  return *this;
}

print()

template<typename T , unsigned D, bool CONVEX>

void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::print

(

)

Print relevant quantities.

Definition at line 393 of file wallContact.hh.

{
  OstreamManager clout(std::cout, "WallContact");
  clout.setMultiOutput(true);
#ifdef PARALLEL_MODE_MPI
  int rank = singleton::mpi().getRank();
  if (rank == responsibleRank[0]) {
#endif
    clout << "Min=" << this->min << ", Max=" << this->max << std::endl;
    clout << "particle ID=" << this->particleID[0]
          << ", wall ID=" << this->wallID[0]
          << ", DampingFactor=" << dampingFactor[0] << std::endl;
    clout << "Position=" << particlePosition << std::endl;
#ifdef PARALLEL_MODE_MPI
  }
#endif
  clout.setMultiOutput(false);
}

References olb::singleton::MpiManager::getRank(), olb::singleton::mpi(), and olb::OstreamManager::setMultiOutput().

Here is the call graph for this function:

resetMinMax()

template<typename T , unsigned D, bool CONVEX>

constexpr void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::resetMinMax ( )

constexpr

Reset min and max to default values.

Definition at line 169 of file wallContact.hh.

{
  for (unsigned iD = 0; iD < D; ++iD) {
    min[iD] = std::numeric_limits<olb::BaseType<T>>::max();
    max[iD] = -std::numeric_limits<olb::BaseType<T>>::max();
  }
  particlePositionUpdated[0] = false;
}

Here is the caller graph for this function:

serialize()

template<typename T , unsigned D, bool CONVEX>

std::size_t olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::serialize

(

std::uint8_t *

buffer

)

Serialize contact data.

Definition at line 327 of file wallContact.hh.

{
  return processWithCommunicatables(
      [&](auto& communicatablePosition, auto& communicatableMin,
          auto& communicatableMax, auto& communicatableID,
          auto& communicatableMaterial, auto& communicatableDamping,
          auto& communicatableParticlePositionUpdated,
          auto& communicatableIsNew, auto& communicatableRank) {
        std::size_t serialIdx =
            communicatablePosition.serialize(this->indicesDim, buffer);
        serialIdx +=
            communicatableMin.serialize(this->indicesDim, &buffer[serialIdx]);
        serialIdx +=
            communicatableMax.serialize(this->indicesDim, &buffer[serialIdx]);
        serialIdx +=
            communicatableID.serialize(this->indicesSingle, &buffer[serialIdx]);
        serialIdx += communicatableMaterial.serialize(this->indicesSingle,
                                                      &buffer[serialIdx]);
        serialIdx += communicatableDamping.serialize(this->indicesSingle,
                                                     &buffer[serialIdx]);
        serialIdx += communicatableParticlePositionUpdated.serialize(
            this->indicesSingle, &buffer[serialIdx]);
        serialIdx += communicatableIsNew.serialize(this->indicesSingle,
                                                   &buffer[serialIdx]);
        serialIdx += communicatableRank.serialize(this->indicesSingle,
                                                  &buffer[serialIdx]);
 
        return serialIdx;
      });
}

setDampingFactor()

template<typename T , unsigned D, bool CONVEX>

constexpr void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::setDampingFactor ( const T dampingFactor )

constexpr

Set damping factor for contact.

Definition at line 151 of file wallContact.hh.

{
  dampingFactor[0] = newDampingFactor;
}

setDampingFactorFromInitialVelocity()

template<typename T , unsigned D, bool CONVEX>

constexpr void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::setDampingFactorFromInitialVelocity ( const T coefficientOfRestitution, const T initialRelativeVelocityMagnitude )

constexpr

Set damping factor from the magnitude of the initial relative impact velocity in direction of contact normal and the wanted coefficient of restitution.

Definition at line 158 of file wallContact.hh.

{
  setDampingFactor(particles::contact::evalDampingFactor(
      coefficientOfRestitution, initialRelativeVelocityMagnitude));
}

References olb::particles::contact::evalDampingFactor().

Here is the call graph for this function:

setParticlePosition()

template<typename T , unsigned D, bool CONVEX>

constexpr void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::setParticlePosition ( const PhysR< T, D > & particlePosition )

constexpr

Set particle position.

Definition at line 106 of file wallContact.hh.

{
  particlePosition           = position;
  particlePositionUpdated[0] = true;
}

setParticlePositionUpdated()

template<typename T , unsigned D, bool CONVEX>

constexpr void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::setParticlePositionUpdated ( bool updated )

constexpr

Definition at line 260 of file wallContact.hh.

{
  particlePositionUpdated[0] = updated;
}

setResponsibleRank()

template<typename T , unsigned D, bool CONVEX>

constexpr void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::setResponsibleRank ( const int & rank )

constexpr

Set processor that is responsible for contact treatment.

Definition at line 115 of file wallContact.hh.

{
  responsibleRank[0] = rank;
}

Here is the caller graph for this function:

updateMinMax()

template<typename T , unsigned D, bool CONVEX>

constexpr void olb::particles::contact::WallContactArbitraryFromOverlapVolume< T, D, CONVEX >::updateMinMax ( const PhysR< T, D > & positionInsideTheContact )

constexpr

Update min and max with given position inside the contact.

Definition at line 180 of file wallContact.hh.

{
  particles::contact::updateMinMax(this->min, this->max,
                                   positionInsideTheContact);
}

References olb::particles::contact::updateMinMax().

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this struct was generated from the following files:

• src/particles/contact/wallContact.h
• src/particles/contact/wallContact.hh