netdem::NeighWofP Class Reference

A class representing a wall in contact with a particle. More...

#include <neigh_tuple.hpp>

Public Member Functions
	NeighWofP ()
	Default constructor for the NeighWofP class.
	NeighWofP (Wall *const w, int id, ContactPW *const cnt)
	Constructor for the NeighWofP class that initializes the neighbor with a wall and its corresponding contact.
NeighPofW *	GetNeighTuple () const
	Get the neigh obj of the pair particle.
ContactPW *	GetContact () const
	Get the contact.
void	SetContact (ContactPW *const cnt)
	Set the contact.

Public Attributes
Wall *	wall {nullptr}
	A pointer to the neighboring wall.
int	lookup_id {-1}
	The index of this particle in the linked_particle_list of the neighboring wall.

Friends
class	Particle
class	Wall
class	NeighPofW

Detailed Description

A class representing a wall in contact with a particle.

Contains information about the neighboring particle and the corresponding contact.

• stores pair info wall: pointer of the neighboring wall lookup_id: index of self in the linked_particle_list of wall contact: pointer of the contact, if is in contact with wall

Constructor & Destructor Documentation

NeighWofP() [1/2]

NeighWofP::NeighWofP

(

)

Default constructor for the NeighWofP class.

NeighWofP() [2/2]

NeighWofP::NeighWofP	(	Wall *const	w,
		int	id,
		ContactPW *const	cnt )

Constructor for the NeighWofP class that initializes the neighbor with a wall and its corresponding contact.

Parameters

w	A pointer to the neighboring wall.
id	The index of this particle in the linked_particle_list of the neighboring wall.
cnt	A pointer to the contact between this particle and the neighboring wall, if it exists.

Member Function Documentation

GetContact()

ContactPW * NeighWofP::GetContact

(

)

const

Get the contact.

GetNeighTuple()

NeighPofW * NeighWofP::GetNeighTuple

(

)

const

Get the neigh obj of the pair particle.

SetContact()

void NeighWofP::SetContact

(

ContactPW *const

cnt

)

Set the contact.

Friends And Related Symbol Documentation

NeighPofW

friend class NeighPofW

friend

Particle

friend class Particle

friend

Wall

friend class Wall

friend

Member Data Documentation

lookup_id

int netdem::NeighWofP::lookup_id {-1}

The index of this particle in the linked_particle_list of the neighboring wall.

wall

Wall* netdem::NeighWofP::wall {nullptr}

A pointer to the neighboring wall.

---

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

• /Users/lzhshou/Documents/Research/myProjects/apaam/repo/netdem/src/scene/neigh_tuple.hpp
• /Users/lzhshou/Documents/Research/myProjects/apaam/repo/netdem/src/scene/neigh_tuple.cpp