esys::lsm::GougeBlock3D Class Reference

Block consisting of regular padding, random layer and gouge. More...

#include <GougeBlock3D.h>

Inheritance diagram for esys::lsm::GougeBlock3D:

Collaboration diagram for esys::lsm::GougeBlock3D:

Public Types
typedef SimpleParticle	Particle
typedef CircularNeighbourTable< SimpleParticle >	NTable
typedef boost::shared_ptr< NTable >	NTablePtr
typedef boost::shared_ptr< BlockGenerator >	GeneratorPtr
typedef std::vector< GeneratorPtr >	GeneratorPtrVector
typedef NTable::ParticlePool	ParticlePool
typedef NTable::ParticlePoolPtr	ParticlePoolPtr
typedef std::set< BasicInteraction, BILess >	InteractionSet

Public Member Functions
	GougeBlock3D (const GougeBlockPrms &prms)
virtual	~GougeBlock3D ()
virtual void	generate ()
int	getNumParticles () const
const GeneratorPtrVector &	getGougeGeneratorVector () const
const GeneratorPtrVector &	getFaultGeneratorVector () const
bool	isGougeParticle (const SimpleParticle &particle) const
bool	areInDifferentFaultBlocks (const SimpleParticle &p1, const SimpleParticle &p2) const
virtual void	write (std::ostream &oStream) const
void	writeToFile (const std::string &fileName) const
void	tagGougeParticles (int tag)
void	tagFaultParticles (int tag)
void	tagDrivingPlateParticles (int minDrivingTag, int maxDrivingTag, double distanceFromBBoxEdge)
virtual void	createInteractionSet ()
const InteractionSet &	getInteractionSet () const
template<typename TmplVisitor >
void	visitParticles (TmplVisitor &visitor)
template<typename TmplVisitor >
void	visitParticles (const TmplVisitor &visitor) const
template<typename TmplVisitor >
void	visitInteractions (TmplVisitor &visitor) const
const GougeBlockPrms &	getPrms () const

Protected Member Functions
void	createRegularBlockGenerators ()
void	createFaultBlockGenerators ()
virtual void	createGougeBlockGenerators ()

Protected Attributes
NTablePtr	m_nTablePtr
GougeBlockPrms	m_prms
InteractionSet	m_interactionSet
GeneratorPtrVector	m_gougeGenPtrVector
GeneratorPtrVector	m_genPtrVector
ParticlePoolPtr	m_particlePoolPtr

Private Attributes
GeneratorPtrVector	m_regularGenPtrVector
GeneratorPtrVector	m_faultGenPtrVector

Detailed Description

Block consisting of regular padding, random layer and gouge.

Member Typedef Documentation

GeneratorPtr

typedef boost::shared_ptr<BlockGenerator> esys::lsm::GougeBlock3D::GeneratorPtr

GeneratorPtrVector

typedef std::vector<GeneratorPtr> esys::lsm::GougeBlock3D::GeneratorPtrVector

InteractionSet

typedef std::set<BasicInteraction,BILess> esys::lsm::GougeBlock3D::InteractionSet

NTable

typedef CircularNeighbourTable<SimpleParticle> esys::lsm::GougeBlock3D::NTable

NTablePtr

typedef boost::shared_ptr<NTable> esys::lsm::GougeBlock3D::NTablePtr

Particle

typedef SimpleParticle esys::lsm::GougeBlock3D::Particle

ParticlePool

typedef NTable::ParticlePool esys::lsm::GougeBlock3D::ParticlePool

ParticlePoolPtr

typedef NTable::ParticlePoolPtr esys::lsm::GougeBlock3D::ParticlePoolPtr

Constructor & Destructor Documentation

GougeBlock3D()

esys::lsm::GougeBlock3D::GougeBlock3D

(

const GougeBlockPrms &

prms

)

References esys::lsm::GougeBlockPrms::getBBox(), esys::lsm::BoundingBox::getMaxPt(), esys::lsm::GougeBlockPrms::getMaxRadius(), esys::lsm::BoundingBox::getMinPt(), esys::lsm::GougeBlockPrms::getMinRadius(), esys::lsm::GougeBlockPrms::getPeriodicDimensions(), esys::lsm::BoundingBox::getSizes(), m_nTablePtr, m_prms, and Vec3::Z().

Here is the call graph for this function:

~GougeBlock3D()

esys::lsm::GougeBlock3D::~GougeBlock3D ( )

virtual

Member Function Documentation

areInDifferentFaultBlocks()

bool esys::lsm::GougeBlock3D::areInDifferentFaultBlocks	(	const SimpleParticle &	p1,
		const SimpleParticle &	p2
	)		const

References getFaultGeneratorVector().

Referenced by esys::lsm::GranularInteractionValidator::isValid(), and esys::lsm::InteractionValidator::isValid().

Here is the call graph for this function:

Here is the caller graph for this function:

createFaultBlockGenerators()

void esys::lsm::GougeBlock3D::createFaultBlockGenerators ( )

protected

References esys::lsm::GougeBlockPrms::getFaultPackingInfoVector(), esys::lsm::GougeBlockPrms::getMaxInsertionFailures(), esys::lsm::GougeBlockPrms::getTolerance(), m_faultGenPtrVector, m_genPtrVector, m_nTablePtr, m_particlePoolPtr, and m_prms.

Referenced by generate(), and esys::lsm::SphAggGougeBlock::generate().

Here is the call graph for this function:

Here is the caller graph for this function:

createGougeBlockGenerators()

void esys::lsm::GougeBlock3D::createGougeBlockGenerators ( )

protectedvirtual

Reimplemented in esys::lsm::SphAggGougeBlock.

References esys::lsm::GougeBlockPrms::getGougePackingInfoVector(), esys::lsm::GougeBlockPrms::getMaxInsertionFailures(), esys::lsm::GougeBlockPrms::getTolerance(), m_genPtrVector, m_gougeGenPtrVector, m_nTablePtr, m_particlePoolPtr, and m_prms.

Referenced by generate().

Here is the call graph for this function:

Here is the caller graph for this function:

createInteractionSet()

void esys::lsm::GougeBlock3D::createInteractionSet ( )

virtual

Reimplemented in esys::lsm::SphAggGougeBlock, and esys::lsm::GranularGougeBlock3D.

References esys::lsm::GougeBlockPrms::getConnectionTolerance(), esys::lsm::ForwardIterator< TmplIteratable >::hasNext(), esys::lsm::InteractionValidator::isValid(), m_interactionSet, m_nTablePtr, m_prms, and esys::lsm::ForwardIterator< TmplIteratable >::next().

Referenced by generate().

Here is the call graph for this function:

Here is the caller graph for this function:

createRegularBlockGenerators()

void esys::lsm::GougeBlock3D::createRegularBlockGenerators ( )

protected

References esys::lsm::GougeBlockPrms::getPeriodicDimensions(), esys::lsm::GougeBlockPrms::getRegularBBoxVector(), esys::lsm::GougeBlockPrms::getRegularBlockRadius(), esys::lsm::GougeBlockPrms::getTolerance(), m_genPtrVector, m_nTablePtr, m_particlePoolPtr, m_prms, and m_regularGenPtrVector.

Referenced by generate(), and esys::lsm::SphAggGougeBlock::generate().

Here is the call graph for this function:

Here is the caller graph for this function:

generate()

void esys::lsm::GougeBlock3D::generate ( )

virtual

Reimplemented in esys::lsm::SphAggGougeBlock, and esys::lsm::GranularGougeBlock3D.

References console, createFaultBlockGenerators(), createGougeBlockGenerators(), createInteractionSet(), createRegularBlockGenerators(), esys::lsm::GougeBlockPrms::getBBox(), esys::lsm::BoundingBox::getMaxPt(), esys::lsm::BoundingBox::getMinPt(), Console::Info(), m_genPtrVector, and m_prms.

Here is the call graph for this function:

getFaultGeneratorVector()

const GougeBlock3D::GeneratorPtrVector & esys::lsm::GougeBlock3D::getFaultGeneratorVector

(

)

const

References m_faultGenPtrVector.

Referenced by areInDifferentFaultBlocks().

Here is the caller graph for this function:

getGougeGeneratorVector()

const GougeBlock3D::GeneratorPtrVector & esys::lsm::GougeBlock3D::getGougeGeneratorVector

(

)

const

References m_gougeGenPtrVector.

Referenced by isGougeParticle().

Here is the caller graph for this function:

getInteractionSet()

const GougeBlock3D::InteractionSet & esys::lsm::GougeBlock3D::getInteractionSet

(

)

const

References m_interactionSet.

Referenced by visitInteractions(), and write().

Here is the caller graph for this function:

getNumParticles()

int esys::lsm::GougeBlock3D::getNumParticles

(

)

const

References m_genPtrVector.

getPrms()

const GougeBlockPrms& esys::lsm::GougeBlock3D::getPrms ( ) const

inline

References m_prms.

isGougeParticle()

bool esys::lsm::GougeBlock3D::isGougeParticle

(

const SimpleParticle &

particle

)

const

References getGougeGeneratorVector().

Referenced by esys::lsm::GranularInteractionValidator::isValid(), and esys::lsm::InteractionValidator::isValid().

Here is the call graph for this function:

Here is the caller graph for this function:

tagDrivingPlateParticles()

void esys::lsm::GougeBlock3D::tagDrivingPlateParticles	(	int	minDrivingTag,
		int	maxDrivingTag,
		double	distanceFromBBoxEdge
	)

References console, esys::lsm::GougeBlockPrms::getBBox(), esys::lsm::BoundingBox::getMaxPt(), esys::lsm::BoundingBox::getMinPt(), esys::lsm::GougeBlockPrms::getOrientationIndex(), SimpleParticle::getPos(), SimpleParticle::getRad(), esys::lsm::ForwardIterator< TmplIteratable >::hasNext(), Console::Info(), m_prms, m_regularGenPtrVector, esys::lsm::ForwardIterator< TmplIteratable >::next(), and esys::lsm::SimpleParticleData::setTag().

Here is the call graph for this function:

tagFaultParticles()

void esys::lsm::GougeBlock3D::tagFaultParticles

(

int

tag

)

References esys::lsm::ForwardIterator< TmplIteratable >::hasNext(), m_faultGenPtrVector, and esys::lsm::ForwardIterator< TmplIteratable >::next().

Here is the call graph for this function:

tagGougeParticles()

void esys::lsm::GougeBlock3D::tagGougeParticles

(

int

tag

)

References esys::lsm::ForwardIterator< TmplIteratable >::hasNext(), m_gougeGenPtrVector, and esys::lsm::ForwardIterator< TmplIteratable >::next().

Here is the call graph for this function:

visitInteractions()

template<typename TmplVisitor >

void esys::lsm::GougeBlock3D::visitInteractions ( TmplVisitor &  visitor ) const

inline

References getInteractionSet().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

visitParticles() [1/2]

template<typename TmplVisitor >

void esys::lsm::GougeBlock3D::visitParticles ( const TmplVisitor &  visitor ) const

inline

References esys::lsm::ForwardIterator< TmplIteratable >::hasNext(), m_genPtrVector, and esys::lsm::ForwardIterator< TmplIteratable >::next().

Here is the call graph for this function:

visitParticles() [2/2]

template<typename TmplVisitor >

void esys::lsm::GougeBlock3D::visitParticles ( TmplVisitor &  visitor )

inline

References esys::lsm::ForwardIterator< TmplIteratable >::hasNext(), m_genPtrVector, and esys::lsm::ForwardIterator< TmplIteratable >::next().

Referenced by esys::lsm::SphAggGougeBlock::visitParticles().

Here is the call graph for this function:

Here is the caller graph for this function:

write()

void esys::lsm::GougeBlock3D::write ( std::ostream &  oStream ) const

virtual

References esys::lsm::BoundingBox::contains(), esys::lsm::GougeBlockPrms::getBBox(), getInteractionSet(), esys::lsm::BoundingBox::getMaxPt(), esys::lsm::GougeBlockPrms::getMaxRadius(), esys::lsm::BoundingBox::getMinPt(), esys::lsm::GougeBlockPrms::getPeriodicDimensions(), SimpleParticle::getPos(), esys::lsm::BoundingBox::getSizes(), esys::lsm::GougeBlockPrms::getTolerance(), esys::lsm::ForwardIterator< TmplIteratable >::hasNext(), m_nTablePtr, m_prms, esys::lsm::ForwardIterator< TmplIteratable >::next(), esys::lsm::SimpleParticleData::setTag(), visitInteractions(), esys::lsm::GeoParticleWriter::visitSimpleParticle(), esys::lsm::GeometryInfo::write(), and Vec3::Z().

Referenced by writeToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

writeToFile()

void esys::lsm::GougeBlock3D::writeToFile

(

const std::string &

fileName

)

const

References write().

Here is the call graph for this function:

Member Data Documentation

m_faultGenPtrVector

GeneratorPtrVector esys::lsm::GougeBlock3D::m_faultGenPtrVector

private

Referenced by createFaultBlockGenerators(), getFaultGeneratorVector(), and tagFaultParticles().

m_genPtrVector

GeneratorPtrVector esys::lsm::GougeBlock3D::m_genPtrVector

protected

Referenced by createFaultBlockGenerators(), createGougeBlockGenerators(), createRegularBlockGenerators(), generate(), esys::lsm::GranularGougeBlock3D::generate(), esys::lsm::SphAggGougeBlock::generate(), getNumParticles(), and visitParticles().

m_gougeGenPtrVector

GeneratorPtrVector esys::lsm::GougeBlock3D::m_gougeGenPtrVector

protected

Referenced by createGougeBlockGenerators(), esys::lsm::GranularGougeBlock3D::generateGrains(), getGougeGeneratorVector(), and tagGougeParticles().

m_interactionSet

InteractionSet esys::lsm::GougeBlock3D::m_interactionSet

protected

Referenced by createInteractionSet(), esys::lsm::GranularGougeBlock3D::createInteractionSet(), esys::lsm::SphAggGougeBlock::createInteractionSet(), and getInteractionSet().

m_nTablePtr

NTablePtr esys::lsm::GougeBlock3D::m_nTablePtr

protected

Referenced by createFaultBlockGenerators(), createGougeBlockGenerators(), createInteractionSet(), esys::lsm::GranularGougeBlock3D::createInteractionSet(), esys::lsm::SphAggGougeBlock::createInteractionSet(), createRegularBlockGenerators(), esys::lsm::SphAggGougeBlock::fillMacroGrains(), GougeBlock3D(), and write().

m_particlePoolPtr

ParticlePoolPtr esys::lsm::GougeBlock3D::m_particlePoolPtr

protected

Referenced by createFaultBlockGenerators(), createGougeBlockGenerators(), createRegularBlockGenerators(), and esys::lsm::SphAggGougeBlock::fillMacroGrains().

m_prms

GougeBlockPrms esys::lsm::GougeBlock3D::m_prms

protected

Referenced by createFaultBlockGenerators(), createGougeBlockGenerators(), createInteractionSet(), esys::lsm::GranularGougeBlock3D::createInteractionSet(), esys::lsm::SphAggGougeBlock::createInteractionSet(), createRegularBlockGenerators(), esys::lsm::SphAggGougeBlock::fillMacroGrains(), generate(), esys::lsm::SphAggGougeBlock::generate(), esys::lsm::SphAggGougeBlock::generateMacroGrains(), esys::lsm::GranularGougeBlock3D::generateSeeds(), getPrms(), GougeBlock3D(), esys::lsm::SphAggGougeBlock::setupNT2(), tagDrivingPlateParticles(), and write().

m_regularGenPtrVector

GeneratorPtrVector esys::lsm::GougeBlock3D::m_regularGenPtrVector

private

Referenced by createRegularBlockGenerators(), and tagDrivingPlateParticles().

---

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

• Geometry/GougeBlock3D.h
• Geometry/GougeBlock3D.cpp