BaseBoundary Class Reference

#include <BaseBoundary.h>

Inheritance diagram for BaseBoundary:

Public Member Functions
virtual BaseBoundary *	copy () const =0
	BaseBoundary copy method. More...
virtual	~BaseBoundary ()
virtual int	createPeriodicParticles (BaseParticle *P UNUSED, ParticleHandler &pH UNUSED)
virtual bool	checkBoundaryAfterParticleMoved (BaseParticle *P UNUSED, ParticleHandler &pH UNUSED)
virtual void	checkBoundaryActionsBeforeTimeStep (ParticleHandler &pH UNUSED, WallHandler &wH UNUSED, RNG &random UNUSED)
void	set_Index (int index)
void	set_Id (int id)
void	setHandler (BoundaryHandler *handler)
virtual void	read (std::istream &is UNUSED)=0
	reads boundary More...
virtual void	print (std::ostream &os UNUSED) const =0
	outputs boundary More...
virtual void	moveInHandler (int newPos)

Private Attributes
BoundaryHandler *	_handler
int	_index
int	_id

Friends
std::ostream &	operator<< (std::ostream &os, const BaseBoundary &b)
	writes wall More...
std::istream &	operator>> (std::istream &is, BaseBoundary &b)
	reads wall More...

Detailed Description

Definition at line 34 of file BaseBoundary.h.

Constructor & Destructor Documentation

virtual BaseBoundary::~BaseBoundary ( )

inlinevirtual

Definition at line 40 of file BaseBoundary.h.

{};

Member Function Documentation

virtual void BaseBoundary::checkBoundaryActionsBeforeTimeStep ( ParticleHandler &pH  UNUSED, WallHandler &wH  UNUSED, RNG &random  UNUSED  )

inlinevirtual

Definition at line 47 of file BaseBoundary.h.

{};

virtual bool BaseBoundary::checkBoundaryAfterParticleMoved ( BaseParticle *P  UNUSED, ParticleHandler &pH  UNUSED  )

inlinevirtual

Definition at line 45 of file BaseBoundary.h.

{return false;};

virtual BaseBoundary* BaseBoundary::copy ( ) const

pure virtual

BaseBoundary copy method.

It calls the copy constructor of this BaseBoundary, useful for polymorphism todo{Does this work correctly?}

Implemented in CircularPeriodicBoundary, AngledPeriodicBoundary, DeletionBoundary, PeriodicBoundary, and InsertionBoundary.

virtual int BaseBoundary::createPeriodicParticles ( BaseParticle *P  UNUSED, ParticleHandler &pH  UNUSED  )

inlinevirtual

Definition at line 43 of file BaseBoundary.h.

Referenced by MD::Check_and_Duplicate_Periodic_Particles().

{return 0;};

virtual void BaseBoundary::moveInHandler ( int  newPos )

inlinevirtual

Definition at line 65 of file BaseBoundary.h.

References _index.

{_index=newPos;}

virtual void BaseBoundary::print ( std::ostream &os  UNUSED ) const

pure virtual

outputs boundary

Referenced by operator<<(), and MD::print().

virtual void BaseBoundary::read ( std::istream &is  UNUSED )

pure virtual

reads boundary

Referenced by operator>>().

void BaseBoundary::set_Id ( int  id )

inline

Definition at line 50 of file BaseBoundary.h.

References _id.

{_id=id;}

void BaseBoundary::set_Index ( int  index )

inline

Definition at line 49 of file BaseBoundary.h.

References _index.

{_index=index;}

void BaseBoundary::setHandler ( BoundaryHandler *  handler )

inline

Definition at line 51 of file BaseBoundary.h.

References _handler.

Referenced by BoundaryHandler::addObject().

{_handler=handler;}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const BaseBoundary &  b  )

friend

writes wall

Definition at line 73 of file BaseBoundary.h.

{
    b.print(os);
    return os;
}

std::istream& operator>> ( std::istream &  is, BaseBoundary &  b  )

friend

reads wall

Definition at line 79 of file BaseBoundary.h.

{
    b.read(is);
    return(is);
}

Member Data Documentation

BoundaryHandler* BaseBoundary::_handler

private

Definition at line 68 of file BaseBoundary.h.

Referenced by setHandler().

int BaseBoundary::_id

private

Definition at line 70 of file BaseBoundary.h.

Referenced by set_Id().

int BaseBoundary::_index

private

Definition at line 69 of file BaseBoundary.h.

Referenced by moveInHandler(), and set_Index().

---

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

• BaseBoundary.h