It is an abstract base class due to the purely virtual functions declared below. Even if the function is purely virtual, it does not imply that it cannot have a definition. Abstract classes are useful to define a interface. More...

#include <BaseObject.h>

Inheritance diagram for BaseObject:

Public Member Functions
	BaseObject ()=default
	Default constructor. More...

	BaseObject (const BaseObject &p)=default
	Copy constructor, copies all the objects BaseObject contains. More...

virtual	~BaseObject ()=default
	virtual destructor More...

virtual void	read (std::istream &is)=0

virtual void	write (std::ostream &os) const =0
	A purely virtual function which has an implementation which writes the name and the object id_ to the output stream. More...

virtual std::string	getName () const =0
	A purely virtual function. More...

virtual void	moveInHandler (unsigned int index)
	Except that it is virtual, it does the same thing as setIndex() does. More...

void	setIndex (unsigned int index)
	Allows one to assign an index to an object in the handler/container. More...

void	setId (unsigned long id)
	Assigns a unique identifier to each object in the handler (container) which remains constant even after the object is deleted from the container/handler. More...

unsigned int	getIndex () const
	Returns the index of the object in the handler. More...

unsigned int	getId () const
	Returns the unique identifier of any particular object. More...

void	setGroupId (unsigned groupId)

unsigned	getGroupId () const

Private Attributes
unsigned int	index_ = 0
	location in BaseHandler::objects_ More...

unsigned int	id_ = 0
	unique identifier within handler (remains constant even if particle is moved) More...

unsigned int	groupId_ = 0
	Identifier of a group within handler. More...

Friends
std::ostream &	operator<< (std::ostream &os, const BaseObject &o)
	A purely virtual method with an implementation which reads the index from the stream and assigns it to id_. More...

std::istream &	operator>> (std::istream &is, BaseObject &o)
	Operator overloading for reading the data from an input stream into the BAseObject "o" More...

Detailed Description

It is an abstract base class due to the purely virtual functions declared below. Even if the function is purely virtual, it does not imply that it cannot have a definition. Abstract classes are useful to define a interface.

Constructor & Destructor Documentation

◆ BaseObject() [1/2]

BaseObject::BaseObject ( )

default

Default constructor.

◆ BaseObject() [2/2]

BaseObject::BaseObject ( const BaseObject & p )

default

Copy constructor, copies all the objects BaseObject contains.

◆ ~BaseObject()

virtual BaseObject::~BaseObject ( )

virtualdefault

virtual destructor

Member Function Documentation

◆ getGroupId()

unsigned BaseObject::getGroupId ( ) const

inline

See also: groupId_.

138 { return groupId_; }

References groupId_.

Referenced by BaseWall::getInteractionWith(), and MeshTriangle::getInteractionWith().

◆ getId()

unsigned int BaseObject::getId ( ) const

inline

Returns the unique identifier of any particular object.

Returns: id number of the current object

126 { return id_; }

References id_.

◆ getIndex()

unsigned int BaseObject::getIndex ( ) const

inline

Returns the index of the object in the handler.

119 { return index_; };

References index_.

Referenced by Chutebelt::actionsAfterTimeStep(), T_protectiveWall::actionsAfterTimeStep(), BoundariesSelfTest::actionsAfterTimeStep(), protectiveWall::actionsAfterTimeStep(), PossibleContactList::add_PossibleContact(), SpeciesHandler::addObject(), BaseWall::addParticlesAtWall(), CircularPeriodicBoundary::checkBoundaryAfterParticleMoved(), ConstantMassFlowMaserBoundary::checkBoundaryAfterParticleMoved(), DeletionBoundary::checkBoundaryAfterParticleMoved(), ChuteWithPeriodicInflow::computeInternalForces(), LiquidMigrationWilletInteraction::form(), BaseInteraction::gatherContactStatistics(), AxisymmetricIntersectionOfWalls::getDistanceAndNormal(), HorizontalBaseScrew::getDistanceAndNormal(), ScrewsymmetricIntersectionOfWalls::getDistanceAndNormal(), RestrictedWall::getInteractionWith(), SuperQuadricParticle::getInteractionWithSuperQuad(), ParticleSpecies::getMixedSpecies(), PossibleContact::getNext(), PossibleContact::getOtherParticle(), PossibleContact::getPrevious(), HGrid::insertParticleToHgrid(), PossibleContactList::remove_ParticlePosibleContacts(), BaseInteraction::removeFromHandler(), InteractionHandler::removeObjectKeepingPeriodics(), ParticleSpecies::setDensity(), ParticleSpecies::setMaxInteractionDistance(), PossibleContact::setNextPosition(), PossibleContact::setPreviousPosition(), BaseInteractable::setSpecies(), SphericalIndenter::setupInitialConditions(), AngledPeriodicBoundary::shiftPosition(), MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::write(), BaseInteraction::writeToFStat(), BaseWall::writeVTK(), and BaseInteractable::~BaseInteractable().

◆ getName()

virtual std::string BaseObject::getName ( ) const

pure virtual

A purely virtual function.

Implemented in VChute, TriangulatedWall, TriangleWall, SphericalWall, SineWall, RestrictedWall, ParabolaChute, MeshTriangle, Membrane, LevelSetWall, IntersectionOfWalls, InfiniteWallWithHole, InfiniteWall, CylindricalWall, Combtooth, Coil, BasicUnionOfWalls, BasicIntersectionOfWalls, ArcWall, ThermalParticle, SuperQuadricParticle, SphericalParticle, LiquidFilmParticle, HeatFluidCoupledParticle, BaseParticle, BaseInteraction, Domain, TimeSmoothedCG< Coordinates, BaseFunction, Fields >, TimeAveragedCG< Coordinates, BaseFunction, Fields >, CG< Coordinates, BaseFunction, Fields >, TimeDependentPeriodicBoundary, SubcriticalMaserBoundaryTEST, SubcriticalMaserBoundary, StressStrainControlBoundary, ShearBoxBoundary, RandomClusterInsertionBoundary, PolydisperseInsertionBoundary, PeriodicBoundary, LeesEdwardsBoundary, HopperInsertionBoundary, HeaterBoundary, FluxBoundary, FixedClusterInsertionBoundary, DropletBoundary, DeletionBoundary, CubeInsertionBoundary, CubeDeletionBoundary, ConstantMassFlowMaserBoundary, CircularPeriodicBoundary, ChuteInsertionBoundary, BidisperseCubeInsertionBoundary, BaseClusterInsertionBoundary, AngledPeriodicBoundary, SimpleDrumSuperquadrics, ScrewsymmetricIntersectionOfWalls, Screw, NurbsWall, HorizontalScrew, HorizontalBaseScrew, AxisymmetricIntersectionOfWalls, MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >, and Interaction< NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction >.

Referenced by commandLineCG(), MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::mixAll(), write(), BaseCG::write(), and BaseWall::writeVTK().

◆ moveInHandler()

void BaseObject::moveInHandler ( unsigned int index )

virtual

Except that it is virtual, it does the same thing as setIndex() does.

Parameters

[in] index

 {
     index_ = index;
 }

References index_.

◆ read()

void BaseObject::read ( std::istream & is )

pure virtual

Parameters

[in]

Implemented in BaseBoundary, VChute, TriangulatedWall, TriangleWall, SphericalWall, SineWall, Screw, RestrictedWall, ParabolaChute, NurbsWall, MeshTriangle, Membrane, LevelSetWall, IntersectionOfWalls, InfiniteWallWithHole, InfiniteWall, HorizontalScrew, CylindricalWall, Combtooth, Coil, BasicUnionOfWalls, BasicIntersectionOfWalls, BaseWall, ArcWall, ParticleSpecies, BaseSpecies, ThermalParticle, SuperQuadricParticle, LiquidFilmParticle, HeatFluidCoupledParticle, BaseParticle, SinterLinInteraction, SinterInteraction, LinearViscoelasticInteraction, LinearPlasticViscoelasticInteraction, HertzianViscoelasticInteraction, HertzianSinterInteraction, SlidingFrictionInteraction, MindlinRollingTorsionInteraction, MindlinInteraction, FrictionInteraction, EmptyFrictionInteraction, BaseInteraction, ReversibleAdhesiveInteraction, RegimeSinterInteraction, ParhamiMcMeekingSinterInteraction, LiquidMigrationWilletInteraction, LiquidBridgeWilletInteraction, IrreversibleAdhesiveInteraction, EmptyAdhesiveInteraction, ChargedBondedInteraction, BondedInteraction, Domain, BaseCG, TimeDependentPeriodicBoundary, SubcriticalMaserBoundaryTEST, SubcriticalMaserBoundary, StressStrainControlBoundary, ShearBoxBoundary, PolydisperseInsertionBoundary, PeriodicBoundary, LeesEdwardsBoundary, InsertionBoundary, HopperInsertionBoundary, HeaterBoundary, FluxBoundary, DropletBoundary, DeletionBoundary, CubeInsertionBoundary, CubeDeletionBoundary, ConstantMassFlowMaserBoundary, CircularPeriodicBoundary, ChuteInsertionBoundary, BidisperseCubeInsertionBoundary, BasePeriodicBoundary, BaseClusterInsertionBoundary, AngledPeriodicBoundary, BaseInteractable, SimpleDrumSuperquadrics, ScrewsymmetricIntersectionOfWalls, HorizontalBaseScrew, AxisymmetricIntersectionOfWalls, MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >, and Interaction< NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction >.

 {
     std::string dummy;
     is >> dummy >> id_;
     helpers::readOptionalVariable(is, "groupID", groupId_);
 }

References groupId_, id_, and helpers::readOptionalVariable().

Referenced by operator>>(), BaseInteractable::read(), ParticleSpecies::read(), and BaseBoundary::read().

◆ setGroupId()

void BaseObject::setGroupId ( unsigned groupId )

inline

See also: groupId_.

132 { groupId_ = groupId; }

References groupId_.

Referenced by MercuryProblem::createWalls(), BaseCluster::particleInsertionSuccessful(), WallHandler::readTriangleWall(), GetDistanceAndNormalForTriangleWalls::setupInitialConditions(), and RollingOverTriangleWalls::setupInitialConditions().

◆ setId()

void BaseObject::setId ( unsigned long id )

Assigns a unique identifier to each object in the handler (container) which remains constant even after the object is deleted from the container/handler.

Parameters

[in] id id number of the current object

Todo:: TW: here we should update BaseHandler::nextId_

 {
     id_ = id;
 }

Referenced by ConstantMassFlowMaserBoundary::addParticleToMaser(), SubcriticalMaserBoundary::addParticleToMaser(), MPISphericalParticle::copyDataFromMPIParticleToParticle(), BaseParticle::oldRead(), MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::read(), WallHandler::readAndAddObject(), SphericalIndenter::setupInitialConditions(), and PeriodicBoundaryHandler::updateMaserParticle().

◆ setIndex()

void BaseObject::setIndex ( unsigned int index )

Allows one to assign an index to an object in the handler/container.

Parameters

[in] index index number of the current object

 {
     index_ = index;
 }

References index_.

Referenced by ConstantMassFlowMaserBoundary::addParticleToMaser(), SubcriticalMaserBoundary::addParticleToMaser(), RestrictedWall::getInteractionWith(), BaseParticle::oldRead(), MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >::read(), and SphericalIndenter::setupInitialConditions().

◆ write()

void BaseObject::write ( std::ostream & os ) const

pure virtual

A purely virtual function which has an implementation which writes the name and the object id_ to the output stream.

Parameters

[in] os stream object to which data is written

Implemented in BaseBoundary, VChute, TriangulatedWall, TriangleWall, SphericalWall, SineWall, Screw, RestrictedWall, ParabolaChute, NurbsWall, MeshTriangle, Membrane, IntersectionOfWalls, InfiniteWallWithHole, HorizontalScrew, CylindricalWall, Combtooth, Coil, BasicUnionOfWalls, BasicIntersectionOfWalls, BaseWall, ArcWall, ParticleSpecies, BaseSpecies, ThermalParticle, SuperQuadricParticle, LiquidFilmParticle, HeatFluidCoupledParticle, BaseParticle, SinterLinInteraction, SinterInteraction, LinearViscoelasticInteraction, LinearPlasticViscoelasticInteraction, HertzianViscoelasticInteraction, HertzianSinterInteraction, SlidingFrictionInteraction, MindlinRollingTorsionInteraction, MindlinInteraction, FrictionInteraction, EmptyFrictionInteraction, BaseInteraction, ReversibleAdhesiveInteraction, RegimeSinterInteraction, ParhamiMcMeekingSinterInteraction, LiquidMigrationWilletInteraction, LiquidBridgeWilletInteraction, IrreversibleAdhesiveInteraction, EmptyAdhesiveInteraction, ChargedBondedInteraction, BondedInteraction, Domain, TimeSmoothedCG< Coordinates, BaseFunction, Fields >, TimeAveragedCG< Coordinates, BaseFunction, Fields >, TimeAveragedCG< CGCoordinates::XYZ, BaseFunction, CGFields::StandardFields >, CG< Coordinates, BaseFunction, Fields >, CG< CGCoordinates::XYZ, BaseFunction, CGFields::StandardFields >, CG< Coordinates, CGFunctions::Lucy, CGFields::StandardFields >, CG< CGCoordinates::O, CGFunctions::Lucy, CGFields::StandardFields >, BaseCG, TimeDependentPeriodicBoundary, SubcriticalMaserBoundaryTEST, SubcriticalMaserBoundary, StressStrainControlBoundary, ShearBoxBoundary, PolydisperseInsertionBoundary, PeriodicBoundary, LeesEdwardsBoundary, InsertionBoundary, HopperInsertionBoundary, HeaterBoundary, FluxBoundary, DropletBoundary, DeletionBoundary, CubeInsertionBoundary, CubeDeletionBoundary, ConstantMassFlowMaserBoundary, CircularPeriodicBoundary, ChuteInsertionBoundary, BidisperseCubeInsertionBoundary, BasePeriodicBoundary, BaseClusterInsertionBoundary, AngledPeriodicBoundary, BaseInteractable, SimpleDrumSuperquadrics, ScrewsymmetricIntersectionOfWalls, HorizontalBaseScrew, AxisymmetricIntersectionOfWalls, MixedSpecies< NormalForceSpecies, FrictionForceSpecies, AdhesiveForceSpecies >, and Interaction< NormalForceInteraction, FrictionForceInteraction, AdhesiveForceInteraction >.

 {
     os << getName();
     os << " id " << id_;
     if (groupId_) os << " groupID " << groupId_;
 }

References getName(), groupId_, and id_.

Referenced by operator<<(), BaseInteractable::write(), ParticleSpecies::write(), and BaseBoundary::write().

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const BaseObject &	o
	)

friend

A purely virtual method with an implementation which reads the index from the stream and assigns it to id_.

Parameters

[in]	is
[in,out]	os
[in]	o

Returns: std::ostream &

 {
     o.write(os);
     return os;
 }

◆ operator>>

std::istream& operator>>	(	std::istream &	is,
		BaseObject &	o
	)

friend

Operator overloading for reading the data from an input stream into the BAseObject "o"

Parameters

[in]	o
[in,out]	is

Returns: std::istream&

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

Member Data Documentation

◆ groupId_

unsigned int BaseObject::groupId_ = 0

private

Identifier of a group within handler.

Useful to define properties to particle or wall clusters, etc. E.g. one can apply an action to a specific group, visualise a specific group, coarse-grain a specific group, etc.

See also: BaseHandler::nextGroupId_

Referenced by getGroupId(), read(), setGroupId(), and write().

◆ id_

unsigned int BaseObject::id_ = 0

private

unique identifier within handler (remains constant even if particle is moved)

Referenced by getId(), read(), and write().

◆ index_

unsigned int BaseObject::index_ = 0

private

location in BaseHandler::objects_

Referenced by getIndex(), moveInHandler(), and setIndex().

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

Public Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ BaseObject() [1/2]

◆ BaseObject() [2/2]

◆ ~BaseObject()

Member Function Documentation

◆ getGroupId()

◆ getId()

◆ getIndex()

◆ getName()

◆ moveInHandler()

◆ read()

◆ setGroupId()

◆ setId()

◆ setIndex()

◆ write()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ groupId_

◆ id_

◆ index_