Class for managing the simulation domain and particles that belong to it. More...

#include <domain.hpp>

Public Member Functions
	Domain ()
	Constructs a new `Domain` object with default settings.

	Domain (Vec3d const &bmin, Vec3d const &bmax)
	Constructs a new `Domain` object with the given bounds.

int	GetSelfRank () const
	Get the rank id of the domain.

int	GetTotalRank () const
	Get the total ranks of the simulation.

std::tuple< Vec3d, Vec3d >	GetBound () const
	Get the bounds of the current domain.

void	Init ()
	Initializes the domain.

void	InitScene (Scene *const scene)
	Initializes the domain with the given scene.

void	InitScene ()
	Initializes the domain with a default scene.

Scene *	GetScene ()
	Gets the pointer to the scene used by this domain.

void	SetBound (double bmin_x, double bmin_y, double bmin_z, double bmax_x, double bmax_y, double bmax_z)
	Sets the size of the domain.

void	SetCellSpacing (double s_x, double s_y, double s_z)
	Sets the cell spacing for the `CellManager`.

bool	IsJudgeDomain (Particle const &p, Particle const &q)
	Checks if a particle needs to be checked for contact detection in this domain.

bool	IsJudgeDomain (Particle const &p, Wall const &w)
	Checks if a particle needs to be checked for contact with a wall in this domain.

bool	IsBelongToDomain (Particle const &p)
	Checks if a particle belongs to this domain.

bool	IsBelongToDomain (ParticleData const &p)
	Checks if a particle data belongs to this domain.

bool	IsBelongToDomain (Vec3d const &pos)
	Checks if a position belongs to this domain.

bool	IsParticleProxyToSend (Particle const &p)
	Checks if a particle needs to be sent to other domains for contact detection.

bool	IsParticleProxyToRecv (Particle const &p)
	Checks if a particle needs to be received from other domains for contact detection.

bool	IsParticleProxyToRecv (ParticleData const &p)
	Checks if a particle data needs to be received from other domains for contact detection.

void	Print ()
	Prints information about this domain to the screen.

VecXT< std::pair< Particle *, int > > const &	GetLinkedOuterParticles ()
	Get the particles that belong to other domains but may potentially overlap with this domain.

void	ClearLinkedLists ()
	Clears linked lists.

STLModel	GetSTLModel ()
	Returns an `STLModel` object for visualization purposes.

	~Domain ()
	Destructor for the `Domain` object.

Public Attributes
CellManager	cell_manager
	Manages the cells, which are used in the borad-phase contact detection.

Protected Member Functions
void	RemoveLinkedParticle (int lookup_id)
	Remove a linked particle by look-up id.

Friends
class	Particle

class	Wall

class	MPIManager

class	DomainManager

Detailed Description

Class for managing the simulation domain and particles that belong to it.

The Domain class includes a CellManager object for broad-phase contact detection. It stores information about the rank id and total number of processes, the lower and upper bounds of the domain, and a list of particles that are outside of the domain but need to be transferred to it for contact detection.

Constructor & Destructor Documentation

◆ Domain() [1/2]

Domain::Domain ( )

Constructs a new Domain object with default settings.

◆ Domain() [2/2]

Domain::Domain	(	Vec3d const &	bmin,
		Vec3d const &	bmax )

Constructs a new Domain object with the given bounds.

Parameters

bmin	Lower bound of the domain.
bmax	Upper bound of the domain.

◆ ~Domain()

Domain::~Domain ( )

Destructor for the Domain object.

Member Function Documentation

◆ ClearLinkedLists()

void Domain::ClearLinkedLists ( )

Clears linked lists.

◆ GetBound()

tuple< Vec3d, Vec3d > Domain::GetBound ( ) const

Get the bounds of the current domain.

◆ GetLinkedOuterParticles()

VecXT< std::pair< Particle *, int > > const & Domain::GetLinkedOuterParticles ( )

Get the particles that belong to other domains but may potentially overlap with this domain.

◆ GetScene()

Scene * Domain::GetScene ( )

Gets the pointer to the scene used by this domain.

Returns: Pointer to the scene used by this domain.

◆ GetSelfRank()

int Domain::GetSelfRank ( ) const

Get the rank id of the domain.

◆ GetSTLModel()

STLModel Domain::GetSTLModel ( )

Returns an STLModel object for visualization purposes.

Returns: An STLModel object for visualization.

◆ GetTotalRank()

int Domain::GetTotalRank ( ) const

Get the total ranks of the simulation.

◆ Init()

void Domain::Init ( )

Initializes the domain.

◆ InitScene() [1/2]

void Domain::InitScene ( )

Initializes the domain with a default scene.

◆ InitScene() [2/2]

void Domain::InitScene ( Scene *const scene )

Initializes the domain with the given scene.

Parameters

scene Pointer to the scene to use for initialization.

◆ IsBelongToDomain() [1/3]

bool Domain::IsBelongToDomain ( Particle const & p )

Checks if a particle belongs to this domain.

A particle is assumed to belong to this domain if its centroid is inside this domain.

Parameters

p	The particle to check.

Returns: True if the particle belongs to this domain, false otherwise.

◆ IsBelongToDomain() [2/3]

bool Domain::IsBelongToDomain ( ParticleData const & p )

Checks if a particle data belongs to this domain.

A particle is assumed to belong to this domain if its centroid is inside this domain.

Parameters

p	ParticleData struct containing the particle data to check.

Returns: True if the particle data belongs to this domain, false otherwise.

◆ IsBelongToDomain() [3/3]

bool Domain::IsBelongToDomain ( Vec3d const & pos )

Checks if a position belongs to this domain.

Parameters

pos	The position to check.

Returns: True if the position belongs to this domain, false otherwise.

◆ IsJudgeDomain() [1/2]

bool Domain::IsJudgeDomain	(	Particle const &	p,
		Particle const &	q )

Checks if a particle needs to be checked for contact detection in this domain.

Parameters

p	The first particle involved in the potential contact.
q	The second particle involved in the potential contact.

Returns: True if the contact should be checked in this domain, false otherwise.

◆ IsJudgeDomain() [2/2]

bool Domain::IsJudgeDomain	(	Particle const &	p,
		Wall const &	w )

Checks if a particle needs to be checked for contact with a wall in this domain.

Parameters

p	The particle involved in the potential contact.
w	The wall involved in the potential contact.

Returns: True if the contact should be checked in this domain, false otherwise.

◆ IsParticleProxyToRecv() [1/2]

bool Domain::IsParticleProxyToRecv ( Particle const & p )

Checks if a particle needs to be received from other domains for contact detection.

Parameters

p	The particle to check.

Returns: True if the particle should be received from other domains, false otherwise.

◆ IsParticleProxyToRecv() [2/2]

bool Domain::IsParticleProxyToRecv ( ParticleData const & p )

Checks if a particle data needs to be received from other domains for contact detection.

Parameters

p	ParticleData struct containing the particle data to check.

Returns: True if the particle data should be received from other domains, false otherwise.

◆ IsParticleProxyToSend()

bool Domain::IsParticleProxyToSend ( Particle const & p )

Checks if a particle needs to be sent to other domains for contact detection.

Parameters

p	The particle to check.

Returns: True if the particle should be sent to other domains, false otherwise.

◆ Print()

void Domain::Print ( )

Prints information about this domain to the screen.

◆ RemoveLinkedParticle()

void Domain::RemoveLinkedParticle ( int lookup_id )

protected

Remove a linked particle by look-up id.

◆ SetBound()

void Domain::SetBound	(	double	bmin_x,
		double	bmin_y,
		double	bmin_z,
		double	bmax_x,
		double	bmax_y,
		double	bmax_z )

Sets the size of the domain.

Parameters

bmin_x	Lower bound in the x direction.
bmin_y	Lower bound in the y direction.
bmin_z	Lower bound in the z direction.
bmax_x	Upper bound in the x direction.
bmax_y	Upper bound in the y direction.
bmax_z	Upper bound in the z direction.

◆ SetCellSpacing()

void Domain::SetCellSpacing	(	double	s_x,
		double	s_y,
		double	s_z )

Sets the cell spacing for the CellManager.

Parameters

s_x	Cell spacing in the x direction.
s_y	Cell spacing in the y direction.
s_z	Cell spacing in the z direction.

Friends And Related Symbol Documentation

◆ DomainManager

friend class DomainManager

friend

◆ MPIManager

friend class MPIManager

friend

◆ Particle

friend class Particle

friend

◆ Wall

friend class Wall

friend

Member Data Documentation

◆ cell_manager

CellManager netdem::Domain::cell_manager

Manages the cells, which are used in the borad-phase contact detection.

Examples: 1_test_triaxial_comp.cpp, 91_triaixal_comp.cpp, 91_triaixal_comp_trimesh.cpp, 92_angle_of_repose.cpp, 92_angle_repose_trimesh.cpp, 93_triaixal_comp_trimesh.cpp, 94_angle_repose_trimesh.cpp, and 97_triaixal_comp_sphere_geom.cpp.

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

/Users/lzhshou/Documents/Research/myProjects/apaam/repo/netdem/src/domain/domain.hpp
/Users/lzhshou/Documents/Research/myProjects/apaam/repo/netdem/src/domain/domain.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Domain() [1/2]

◆ Domain() [2/2]

◆ ~Domain()

Member Function Documentation

◆ ClearLinkedLists()

◆ GetBound()

◆ GetLinkedOuterParticles()

◆ GetScene()

◆ GetSelfRank()

◆ GetSTLModel()

◆ GetTotalRank()

◆ Init()

◆ InitScene() [1/2]

◆ InitScene() [2/2]

◆ IsBelongToDomain() [1/3]

◆ IsBelongToDomain() [2/3]

◆ IsBelongToDomain() [3/3]

◆ IsJudgeDomain() [1/2]

◆ IsJudgeDomain() [2/2]

◆ IsParticleProxyToRecv() [1/2]

◆ IsParticleProxyToRecv() [2/2]

◆ IsParticleProxyToSend()

◆ Print()

◆ RemoveLinkedParticle()

◆ SetBound()

◆ SetCellSpacing()

Friends And Related Symbol Documentation

◆ DomainManager

◆ MPIManager

◆ Particle

◆ Wall

Member Data Documentation

◆ cell_manager