#include <SimpleParticleData.h>

Inheritance diagram for esys::lsm::SimpleParticleData:

Collaboration diagram for esys::lsm::SimpleParticleData:

Public Types
typedef int	Id

typedef int	Tag

Public Member Functions
	SimpleParticleData ()

	SimpleParticleData (Id id, Tag tag, const Vec3 &position, double radius)

	SimpleParticleData (const Vec3 &position, double radius, Id id, Tag tag)

	SimpleParticleData (const SimpleParticleData &p)

SimpleParticleData &	operator= (const SimpleParticleData &p)

bool	operator== (const SimpleParticleData &particleData) const

Id	getId () const

void	setId (const Id &id)

Id	getID () const

void	setID (const Id &id)

const Vec3 &	getPosition () const

void	setPosition (const Vec3 &pos)

Tag	getTag () const

void	setTag (const Tag &tag)

double	getRadius () const

void	setRadius (const double &r)

void	setMass (double mass)

double	getMass () const

double	get2dMass () const

double	get3dMass () const

void	read (std::istream &istream)

void	write (std::ostream &write) const

Private Attributes
Id	m_id

Tag	m_tag

Vec3	m_position

double	m_radius

double	m_mass

Detailed Description

Container class for particle Id, Tag, position, radius and mass.

Member Typedef Documentation

◆ Id

typedef int esys::lsm::SimpleParticleData::Id

◆ Tag

typedef int esys::lsm::SimpleParticleData::Tag

Constructor & Destructor Documentation

◆ SimpleParticleData() [1/4]

esys::lsm::SimpleParticleData::SimpleParticleData ( )

inline

References get3dMass(), and setMass().

Here is the call graph for this function:

◆ SimpleParticleData() [2/4]

esys::lsm::SimpleParticleData::SimpleParticleData	(	Id	id,
		Tag	tag,
		const Vec3 &	position,
		double	radius
	)

inline

References get3dMass(), and setMass().

Here is the call graph for this function:

◆ SimpleParticleData() [3/4]

esys::lsm::SimpleParticleData::SimpleParticleData	(	const Vec3 &	position,
		double	radius,
		Id	id,
		Tag	tag
	)

inline

References get3dMass(), and setMass().

Here is the call graph for this function:

◆ SimpleParticleData() [4/4]

esys::lsm::SimpleParticleData::SimpleParticleData ( const SimpleParticleData & p )

inline

Member Function Documentation

◆ get2dMass()

double esys::lsm::SimpleParticleData::get2dMass ( ) const

inline

References m_radius.

◆ get3dMass()

double esys::lsm::SimpleParticleData::get3dMass ( ) const

inline

References m_radius.

Referenced by SimpleParticleData().

Here is the caller graph for this function:

◆ getId()

SimpleParticleData::Id esys::lsm::SimpleParticleData::getId ( ) const

inline

References m_id.

Referenced by esys::lsm::DistConnections< SimpleSpherePy, TaggedIdConnectionPy >::createConnection(), getID(), esys::lsm::SimpleSpherePyPickleSuite::getinitargs(), esys::lsm::SphereNeighbours< SimpleSpherePy, ParticleIdPairVectorPy >::getNeighbours(), operator<<(), operator==(), and write().

Here is the caller graph for this function:

◆ getID()

SimpleParticleData::Id esys::lsm::SimpleParticleData::getID ( ) const

inline

References getId().

Referenced by esys::lsm::ParticleDataVisitor::Impl::append(), esys::lsm::BlockGenerator::contains(), esys::lsm::exportSimpleSphere(), ARandomAssembly3D::fillSpace(), esys::lsm::TwoDPlaneParticleFitter::findAFit(), esys::lsm::ThreeDPlaneParticleFitter::findAFit(), esys::lsm::ThreeDParticleFitter::findAFit(), esys::lsm::TwoDParticleFitter::findAFit(), esys::lsm::SphereBlockGenerator::findAFit(), ARandomAssembly3D::findAFit(), ARandomAssembly2D::findAFit(), esys::lsm::SphereBlockGenerator::findAFitWithSphere(), esys::lsm::SphereBlockGenerator::generateFillParticles(), esys::lsm::SphereBlockGenerator::insertParticle(), esys::lsm::BlockGenerator::insertParticle(), SimpleParticle::isValid(), esys::lsm::GranularInteractionValidator::isValid(), esys::lsm::SphAggInteractionValidator::isValid(), esys::lsm::InteractionValidator::isValid(), esys::lsm::IdCompare::operator()(), esys::lsm::SimpleSpherePy::operator==(), esys::lsm::GeoParticleWriter::visitSimpleParticle(), and esys::lsm::ParticleDataVisitor::writeIds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMass()

double esys::lsm::SimpleParticleData::getMass ( ) const

inline

References m_mass.

Referenced by CRotParticle::CRotParticle(), CRotParticleVi::CRotParticleVi(), esys::lsm::exportSimpleSphere(), and esys::lsm::SimpleSpherePyPickleSuite::getinitargs().

Here is the caller graph for this function:

◆ getPosition()

const Vec3 & esys::lsm::SimpleParticleData::getPosition ( ) const

inline

References m_position.

Referenced by SimpleParticle::getPos(), operator<<(), operator==(), SimpleParticle::rotate(), SimpleParticle::translateBy(), and write().

Here is the caller graph for this function:

◆ getRadius()

double esys::lsm::SimpleParticleData::getRadius ( ) const

inline

References m_radius.

Referenced by CRotParticle::CRotParticle(), CRotParticleVi::CRotParticleVi(), esys::lsm::SimpleSpherePyPickleSuite::getinitargs(), SimpleParticle::getRad(), operator<<(), operator==(), esys::lsm::ParticleIterator::readDataFromStream(), and write().

Here is the caller graph for this function:

◆ getTag()

SimpleParticleData::Tag esys::lsm::SimpleParticleData::getTag ( ) const

inline

References m_tag.

Referenced by esys::lsm::exportSimpleSphere(), esys::lsm::SimpleSpherePyPickleSuite::getinitargs(), esys::lsm::GranularInteractionValidator::isValid(), esys::lsm::SphAggInteractionValidator::isValid(), operator<<(), operator==(), esys::lsm::GeoParticleWriter::visitSimpleParticle(), write(), and esys::lsm::ParticleDataVisitor::writeTags().

Here is the caller graph for this function:

◆ operator=()

SimpleParticleData & esys::lsm::SimpleParticleData::operator= ( const SimpleParticleData & p )

inline

References m_id, m_mass, m_position, m_radius, and m_tag.

◆ operator==()

bool esys::lsm::SimpleParticleData::operator== ( const SimpleParticleData & particleData ) const

inline

References getId(), getPosition(), getRadius(), and getTag().

Here is the call graph for this function:

◆ read()

void esys::lsm::SimpleParticleData::read ( std::istream & istream )

inline

References m_id, m_position, m_radius, and m_tag.

Referenced by esys::lsm::operator>>().

Here is the caller graph for this function:

◆ setId()

void esys::lsm::SimpleParticleData::setId ( const Id & id )

inline

References m_id.

Referenced by setID().

Here is the caller graph for this function:

◆ setID()

void esys::lsm::SimpleParticleData::setID ( const Id & id )

inline

References setId().

Referenced by esys::lsm::exportSimpleSphere().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMass()

void esys::lsm::SimpleParticleData::setMass ( double mass )

inline

References m_mass.

Referenced by esys::lsm::exportSimpleSphere(), esys::lsm::ParticleIterator::readDataFromStream(), SimpleParticleData(), and esys::lsm::SimpleSpherePy::SimpleSpherePy().

Here is the caller graph for this function:

◆ setPosition()

void esys::lsm::SimpleParticleData::setPosition ( const Vec3 & pos )

inline

References m_position.

Referenced by SimpleParticle::moveTo(), SimpleParticle::rotate(), SimpleParticle::setPos(), and SimpleParticle::translateBy().

Here is the caller graph for this function:

◆ setRadius()

void esys::lsm::SimpleParticleData::setRadius ( const double & r )

inline

References m_radius.

Referenced by SimpleParticle::setRad().

Here is the caller graph for this function:

◆ setTag()

void esys::lsm::SimpleParticleData::setTag ( const Tag & tag )

inline

References m_tag.

Referenced by esys::lsm::exportSimpleSphere(), esys::lsm::GranularGougeBlock3D::generateGrains(), esys::lsm::SphereBlockGenerator::insertParticle(), esys::lsm::GougeBlock3D::tagDrivingPlateParticles(), and esys::lsm::GougeBlock3D::write().

Here is the caller graph for this function:

◆ write()

void esys::lsm::SimpleParticleData::write ( std::ostream & write ) const

inline

References getId(), getPosition(), getRadius(), and getTag().

Referenced by esys::lsm::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ m_id

Id esys::lsm::SimpleParticleData::m_id

private

Referenced by getId(), operator=(), read(), and setId().

◆ m_mass

double esys::lsm::SimpleParticleData::m_mass

private

Referenced by getMass(), operator=(), and setMass().

◆ m_position

Vec3 esys::lsm::SimpleParticleData::m_position

private

Referenced by getPosition(), operator=(), read(), and setPosition().

◆ m_radius

double esys::lsm::SimpleParticleData::m_radius

private

Referenced by get2dMass(), get3dMass(), getRadius(), operator=(), read(), and setRadius().

◆ m_tag

Tag esys::lsm::SimpleParticleData::m_tag

private

Referenced by getTag(), operator=(), read(), and setTag().

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

Geometry/SimpleParticleData.h
Geometry/SimpleParticleData.hpp

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Id

◆ Tag

Constructor & Destructor Documentation

◆ SimpleParticleData() [1/4]

◆ SimpleParticleData() [2/4]

◆ SimpleParticleData() [3/4]

◆ SimpleParticleData() [4/4]

Member Function Documentation

◆ get2dMass()

◆ get3dMass()

◆ getId()

◆ getID()

◆ getMass()

◆ getPosition()

◆ getRadius()

◆ getTag()

◆ operator=()

◆ operator==()

◆ read()

◆ setId()

◆ setID()

◆ setMass()

◆ setPosition()

◆ setRadius()

◆ setTag()

◆ write()

Member Data Documentation

◆ m_id

◆ m_mass

◆ m_position

◆ m_radius

◆ m_tag