ESyS-Particle  2.3.4
Public Types | Public Member Functions | Private Attributes | List of all members
esys::lsm::GougeConfigPrms< TmplParticleGrainGen > Class Template Reference

#include <GougeConfig.h>

Inheritance diagram for esys::lsm::GougeConfigPrms< TmplParticleGrainGen >:
Inheritance graph
[legend]
Collaboration diagram for esys::lsm::GougeConfigPrms< TmplParticleGrainGen >:
Collaboration graph
[legend]

Public Types

typedef TmplParticleGrainGen ParticleGrainGen
 
typedef GrainRndPackPrms< ParticleGrainGen > GrainRPackPrms
 
typedef GrainRPackPrms::Inherited ParticleRndPackPrms
 
typedef GougePackingInfo< ParticleGrainGen > GougePackInfo
 
typedef std::vector< GougePackInfo > GougePackingInfoVector
 

Public Member Functions

 GougeConfigPrms ()
 
 GougeConfigPrms (const BoundingBox &bBox, double padRadius, Orientation orientation, const ParticleRndPackPrms &faultRegionPrms, const GrainRPackPrms &gougeRegionPrms, const BoolVector &peridicDimensions=BoolVector(3, false), int maxInsertionFailures=100, double tolerance=DBL_EPSILON *128, double connectionTolerance=DBL_EPSILON *128 *10, int blockConnectionTag=0)
 
 ~GougeConfigPrms ()
 
double getTolerance () const
 
double getConnectionTolerance () const
 
const BoundingBox & getBBox () const
 
int getMaxInsertionFailures () const
 
double getRegularBlockRadius () const
 
double getFaultMinRadius () const
 
double getFaultMaxRadius () const
 
double getGougeMinRadius () const
 
double getGougeMaxRadius () const
 
int getGougeConnectionTag () const
 
int getBlockConnectionTag () const
 
const BoolVector & getPeriodicDimensions () const
 
BoundingBoxVector getRegularBBoxVector () const
 
GougePackingInfoVector getGougePackingInfoVector () const
 
PackingInfoVector getFaultPackingInfoVector () const
 
BoundingBox cutFromCentre (double d1, double d2) const
 
Orientation getOrientation () const
 
int getOrientationIndex () const
 
double getOrientationSize () const
 
double getMaxRadius () const
 
double getMinRadius () const
 
bool is2d () const
 

Private Attributes

BoundingBox m_bBox
 
double m_padRadius
 
Orientation m_orientation
 
ParticleRndPackPrms m_faultPrms
 
GrainRPackPrms m_gougePrms
 
BoolVector m_periodicDimensions
 
int m_maxInsertionFailures
 
double m_tolerance
 
double m_connectionTolerance
 
int m_blockConnectionTag
 

Member Typedef Documentation

◆ GougePackInfo

template<typename TmplParticleGrainGen >
typedef GougePackingInfo<ParticleGrainGen> esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::GougePackInfo

◆ GougePackingInfoVector

template<typename TmplParticleGrainGen >
typedef std::vector<GougePackInfo> esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::GougePackingInfoVector

◆ GrainRPackPrms

template<typename TmplParticleGrainGen >
typedef GrainRndPackPrms<ParticleGrainGen> esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::GrainRPackPrms

◆ ParticleGrainGen

template<typename TmplParticleGrainGen >
typedef TmplParticleGrainGen esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::ParticleGrainGen

◆ ParticleRndPackPrms

template<typename TmplParticleGrainGen >
typedef GrainRPackPrms::Inherited esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::ParticleRndPackPrms

Constructor & Destructor Documentation

◆ GougeConfigPrms() [1/2]

template<typename TPGrainGen >
esys::lsm::GougeConfigPrms< TPGrainGen >::GougeConfigPrms

◆ GougeConfigPrms() [2/2]

template<typename TPGrainGen >
esys::lsm::GougeConfigPrms< TPGrainGen >::GougeConfigPrms ( const BoundingBox &  bBox,
double  padRadius,
Orientation  orientation,
const ParticleRndPackPrms &  faultRegionPrms,
const GrainRPackPrms &  gougeRegionPrms,
const BoolVector &  peridicDimensions = BoolVector(3, false),
int  maxInsertionFailures = 100,
double  tolerance = DBL_EPSILON*128,
double  connectionTolerance = DBL_EPSILON*128*10,
int  blockConnectionTag = 0 
)

References esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::getMaxRadius(), esys::lsm::GridIterator::getSphereBBox(), and esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_bBox.

Here is the call graph for this function:

◆ ~GougeConfigPrms()

template<typename TPGrainGen >
esys::lsm::GougeConfigPrms< TPGrainGen >::~GougeConfigPrms

Member Function Documentation

◆ cutFromCentre()

template<typename TPGrainGen >
BoundingBox esys::lsm::GougeConfigPrms< TPGrainGen >::cutFromCentre ( double  d1,
double  d2 
) const

References getBBox(), esys::lsm::BoundingBox::getMaxPt(), esys::lsm::BoundingBox::getMinPt(), and esys::lsm::GridIterator::getSphereBBox().

Here is the call graph for this function:

◆ getBBox()

template<typename TPGrainGen >
const BoundingBox & esys::lsm::GougeConfigPrms< TPGrainGen >::getBBox

Referenced by esys::lsm::GougeConfig< TmplGrainRandomBoxPacker, TmplParticleRandomBoxPacker, TmplConnection >::GougeConfig().

Here is the caller graph for this function:

◆ getBlockConnectionTag()

template<typename TPGrainGen >
int esys::lsm::GougeConfigPrms< TPGrainGen >::getBlockConnectionTag

◆ getConnectionTolerance()

template<typename TPGrainGen >
double esys::lsm::GougeConfigPrms< TPGrainGen >::getConnectionTolerance

◆ getFaultMaxRadius()

template<typename TPGrainGen >
double esys::lsm::GougeConfigPrms< TPGrainGen >::getFaultMaxRadius

◆ getFaultMinRadius()

template<typename TPGrainGen >
double esys::lsm::GougeConfigPrms< TPGrainGen >::getFaultMinRadius

◆ getFaultPackingInfoVector()

template<typename TPGrainGen >
PackingInfoVector esys::lsm::GougeConfigPrms< TPGrainGen >::getFaultPackingInfoVector

◆ getGougeConnectionTag()

template<typename TPGrainGen >
int esys::lsm::GougeConfigPrms< TPGrainGen >::getGougeConnectionTag

◆ getGougeMaxRadius()

template<typename TPGrainGen >
double esys::lsm::GougeConfigPrms< TPGrainGen >::getGougeMaxRadius

◆ getGougeMinRadius()

template<typename TPGrainGen >
double esys::lsm::GougeConfigPrms< TPGrainGen >::getGougeMinRadius

◆ getGougePackingInfoVector()

template<typename TPGrainGen >
GougeConfigPrms< TPGrainGen >::GougePackingInfoVector esys::lsm::GougeConfigPrms< TPGrainGen >::getGougePackingInfoVector

References esys::lsm::BoundingBox::getMaxPt(), esys::lsm::BoundingBox::getMinPt(), and Vec3::ZERO.

Here is the call graph for this function:

◆ getMaxInsertionFailures()

template<typename TPGrainGen >
int esys::lsm::GougeConfigPrms< TPGrainGen >::getMaxInsertionFailures

◆ getMaxRadius()

template<typename TPGrainGen >
double esys::lsm::GougeConfigPrms< TPGrainGen >::getMaxRadius

Referenced by esys::lsm::GougeConfig< TmplGrainRandomBoxPacker, TmplParticleRandomBoxPacker, TmplConnection >::GougeConfig(), and esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::GougeConfigPrms().

Here is the caller graph for this function:

◆ getMinRadius()

template<typename TPGrainGen >
double esys::lsm::GougeConfigPrms< TPGrainGen >::getMinRadius

Referenced by esys::lsm::GougeConfig< TmplGrainRandomBoxPacker, TmplParticleRandomBoxPacker, TmplConnection >::GougeConfig().

Here is the caller graph for this function:

◆ getOrientation()

template<typename TPGrainGen >
Orientation esys::lsm::GougeConfigPrms< TPGrainGen >::getOrientation

◆ getOrientationIndex()

template<typename TPGrainGen >
int esys::lsm::GougeConfigPrms< TPGrainGen >::getOrientationIndex

References esys::lsm::XZ.

◆ getOrientationSize()

template<typename TPGrainGen >
double esys::lsm::GougeConfigPrms< TPGrainGen >::getOrientationSize

References getBBox().

Here is the call graph for this function:

◆ getPeriodicDimensions()

template<typename TPGrainGen >
const BoolVector & esys::lsm::GougeConfigPrms< TPGrainGen >::getPeriodicDimensions

Referenced by esys::lsm::GougeConfig< TmplGrainRandomBoxPacker, TmplParticleRandomBoxPacker, TmplConnection >::GougeConfig().

Here is the caller graph for this function:

◆ getRegularBBoxVector()

template<typename TPGrainGen >
BoundingBoxVector esys::lsm::GougeConfigPrms< TPGrainGen >::getRegularBBoxVector

◆ getRegularBlockRadius()

template<typename TPGrainGen >
double esys::lsm::GougeConfigPrms< TPGrainGen >::getRegularBlockRadius

◆ getTolerance()

template<typename TPGrainGen >
double esys::lsm::GougeConfigPrms< TPGrainGen >::getTolerance

◆ is2d()

template<typename TPGrainGen >
bool esys::lsm::GougeConfigPrms< TPGrainGen >::is2d

References getBBox().

Here is the call graph for this function:

Member Data Documentation

◆ m_bBox

template<typename TmplParticleGrainGen >
BoundingBox esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_bBox
private

Referenced by esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::GougeConfigPrms().

◆ m_blockConnectionTag

template<typename TmplParticleGrainGen >
int esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_blockConnectionTag
private

◆ m_connectionTolerance

template<typename TmplParticleGrainGen >
double esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_connectionTolerance
private

◆ m_faultPrms

template<typename TmplParticleGrainGen >
ParticleRndPackPrms esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_faultPrms
private

◆ m_gougePrms

template<typename TmplParticleGrainGen >
GrainRPackPrms esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_gougePrms
private

◆ m_maxInsertionFailures

template<typename TmplParticleGrainGen >
int esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_maxInsertionFailures
private

◆ m_orientation

template<typename TmplParticleGrainGen >
Orientation esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_orientation
private

◆ m_padRadius

template<typename TmplParticleGrainGen >
double esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_padRadius
private

◆ m_periodicDimensions

template<typename TmplParticleGrainGen >
BoolVector esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_periodicDimensions
private

◆ m_tolerance

template<typename TmplParticleGrainGen >
double esys::lsm::GougeConfigPrms< TmplParticleGrainGen >::m_tolerance
private
The documentation for this class was generated from the following files: