chrono::utils::HCPSampler< T > Class Template Reference

Description

template<typename T = double>
class chrono::utils::HCPSampler< T >

Sampler for 3D volumes using a Hexagonally Close Packed structure.

#include <ChUtilsSamplers.h>

Inheritance diagram for chrono::utils::HCPSampler< T >:
Collaboration diagram for chrono::utils::HCPSampler< T >:

Public Types

typedef Types< T >::PointVector PointVector
 
typedef Sampler< T >::VolumeType VolumeType
 
- Public Types inherited from chrono::utils::Sampler< T >
typedef Types< T >::PointVector PointVector
 

Public Member Functions

 HCPSampler (T separation)
 
- Public Member Functions inherited from chrono::utils::Sampler< T >
PointVector SampleBox (const ChVector< T > &center, const ChVector< T > &halfDim)
 Return points sampled from the specified box volume.
 
PointVector SampleSphere (const ChVector< T > &center, T radius)
 Return points sampled from the specified spherical volume.
 
PointVector SampleCylinderX (const ChVector< T > &center, T radius, T halfHeight)
 Return points sampled from the specified X-aligned cylindrical volume.
 
PointVector SampleCylinderY (const ChVector< T > &center, T radius, T halfHeight)
 Return points sampled from the specified Y-aligned cylindrical volume.
 
PointVector SampleCylinderZ (const ChVector< T > &center, T radius, T halfHeight)
 Return points sampled from the specified Z-aligned cylindrical volume.
 
virtual T GetSeparation () const
 Get the current value of the minimum separation.
 
virtual void SetSeparation (T separation)
 Change the minimum separation for subsequent calls to Sample.
 

Additional Inherited Members

- Protected Types inherited from chrono::utils::Sampler< T >
enum  VolumeType {
  BOX, SPHERE, CYLINDER_X, CYLINDER_Y,
  CYLINDER_Z
}
 
- Protected Member Functions inherited from chrono::utils::Sampler< T >
 Sampler (T separation)
 
bool accept (VolumeType t, const ChVector< T > &p) const
 Utility function to check if a point is inside the sampling volume.
 
- Protected Attributes inherited from chrono::utils::Sampler< T >
m_separation
 inter-particle separation
 
ChVector< T > m_center
 center of the sampling volume
 
ChVector< T > m_size
 half dimensions of the bounding box of the sampling volume
 

The documentation for this class was generated from the following file:
  • /builds/uwsbel/chrono/src/chrono/utils/ChUtilsSamplers.h