netdem::NeighPofW Class Reference

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

#include <neigh_tuple.hpp>

Public Member Functions
	NeighPofW ()
	Default constructor for the NeighPofW class.
	NeighPofW (Particle *const p, int id, ContactPW *const cnt)
	Constructor for the NeighPofW class that initializes the neighbor with a particle and its corresponding contact.
NeighWofP *	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
Particle *	particle {nullptr}
	A pointer to the neighboring particle.
int	lookup_id {-1}
	The index of this particle in the linked_wall_list of the neighboring particle.

Friends
class	Particle
class	Wall
class	NeighWofP

Detailed Description

A class representing a particle in contact with a wall.

Contains information about the neighboring particle and its corresponding contact.

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

Constructor & Destructor Documentation

NeighPofW() [1/2]

NeighPofW::NeighPofW

(

)

Default constructor for the NeighPofW class.

NeighPofW() [2/2]

NeighPofW::NeighPofW	(	Particle *const	p,
		int	id,
		ContactPW *const	cnt )

Constructor for the NeighPofW class that initializes the neighbor with a particle and its corresponding contact.

Parameters

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

Member Function Documentation

GetContact()

ContactPW * NeighPofW::GetContact

(

)

const

Get the contact.

GetNeighTuple()

NeighWofP * NeighPofW::GetNeighTuple

(

)

const

Get the neigh obj of the pair particle.

SetContact()

void NeighPofW::SetContact

(

ContactPW *const

cnt

)

Set the contact.

Friends And Related Symbol Documentation

NeighWofP

friend class NeighWofP

friend

Particle

friend class Particle

friend

Wall

friend class Wall

friend

Member Data Documentation

lookup_id

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

The index of this particle in the linked_wall_list of the neighboring particle.

particle

Particle* netdem::NeighPofW::particle {nullptr}

A pointer to the neighboring particle.

---

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