ESyS-Particle  2.3.2
esys::lsm::GeometryInfo Class Reference

#include <GeometryInfo.h>

Collaboration diagram for esys::lsm::GeometryInfo:

Classes

class  Impl

Public Member Functions

 GeometryInfo ()
 GeometryInfo (float version, const Vec3 &bBoxMin, const Vec3 &bBoxMax, const BoolVector &periodicDimensions, bool is2d=false)
 GeometryInfo (const GeometryInfo &geoInfo)
GeometryInfooperator= (const GeometryInfo &geoInfo)
 ~GeometryInfo ()
bool operator== (const GeometryInfo &geoInfo) const
void setBBox (const Vec3 &min, const Vec3 &max)
bool hasAnyPeriodicDimensions () const
bool is2d () const
void set_is2d (bool do2d)
Vec3Vector getBBoxCorners () const
Vec3 getMinBBoxCorner () const
Vec3 getMaxBBoxCorner () const
IntVector getPeriodicDimensions () const
void setPeriodicDimensions (BoolVector periodicDimensions)
void setLsmGeoVersion (float version)
float getLsmGeoVersion () const
void read (std::istream &iStream)
void write (std::ostream &oStream) const
void writeWithoutVersion (std::ostream &oStream) const
bool isCompatible (const GeometryInfo &) const
bool isIdenticalGeometry (const GeometryInfo &) const

Private Attributes

Implm_pImpl

Detailed Description

Container class for geometry meta-info.

Constructor & Destructor Documentation

esys::lsm::GeometryInfo::GeometryInfo ( )
esys::lsm::GeometryInfo::GeometryInfo ( float  version,
const Vec3 bBoxMin,
const Vec3 bBoxMax,
const BoolVector periodicDimensions,
bool  is2d = false 
)
esys::lsm::GeometryInfo::GeometryInfo ( const GeometryInfo geoInfo)
esys::lsm::GeometryInfo::~GeometryInfo ( )

References m_pImpl.

Member Function Documentation

Vec3Vector esys::lsm::GeometryInfo::getBBoxCorners ( ) const

Returns two corner points of bounding box.

References esys::lsm::GeometryInfo::Impl::m_bBoxMax, esys::lsm::GeometryInfo::Impl::m_bBoxMin, and m_pImpl.

Referenced by CLatticeMaster::loadCheckPointData().

Here is the caller graph for this function:

float esys::lsm::GeometryInfo::getLsmGeoVersion ( ) const

get the version of the loaded geometry

References m_pImpl, and esys::lsm::GeometryInfo::Impl::m_version.

Referenced by CLatticeMaster::readGeometry().

Here is the caller graph for this function:

Vec3 esys::lsm::GeometryInfo::getMaxBBoxCorner ( ) const
Vec3 esys::lsm::GeometryInfo::getMinBBoxCorner ( ) const
IntVector esys::lsm::GeometryInfo::getPeriodicDimensions ( ) const

Returns the periodic dimensions.

References esys::lsm::GeometryInfo::Impl::m_periodicDimensions, and m_pImpl.

Referenced by CLatticeMaster::loadCheckPointData().

Here is the caller graph for this function:

bool esys::lsm::GeometryInfo::hasAnyPeriodicDimensions ( ) const

Returns true if any of the x, y or z dimensions have been specified as periodic.

References esys::lsm::GeometryInfo::Impl::m_periodicDimensions, and m_pImpl.

Referenced by CLatticeMaster::loadCheckPointData().

Here is the caller graph for this function:

bool esys::lsm::GeometryInfo::is2d ( ) const

Returns true info indicates two-dimensional particle data.

References esys::lsm::GeometryInfo::Impl::m_is2d, and m_pImpl.

bool esys::lsm::GeometryInfo::isCompatible ( const GeometryInfo gi) const

check if a model with the geometry described in the GeoInfo given in the argument can be loaded into a pre-existing model

Parameters
githe new geometry info

References esys::lsm::GeometryInfo::Impl::m_bBoxMax, esys::lsm::GeometryInfo::Impl::m_bBoxMin, esys::lsm::GeometryInfo::Impl::m_periodicDimensions, and m_pImpl.

bool esys::lsm::GeometryInfo::isIdenticalGeometry ( const GeometryInfo gi) const

Check if the geometrical dimensions in two GeometryInfo objects are identical

Parameters
githe new geometry info

References esys::lsm::GeometryInfo::Impl::m_bBoxMax, esys::lsm::GeometryInfo::Impl::m_bBoxMin, esys::lsm::GeometryInfo::Impl::m_periodicDimensions, and m_pImpl.

Referenced by CLatticeMaster::loadCheckPointData().

Here is the caller graph for this function:

GeometryInfo & esys::lsm::GeometryInfo::operator= ( const GeometryInfo geoInfo)

References m_pImpl.

bool esys::lsm::GeometryInfo::operator== ( const GeometryInfo geoInfo) const

References m_pImpl.

void esys::lsm::GeometryInfo::read ( std::istream &  iStream)

Parses specified istream and assigns to this object.

References m_pImpl, and esys::lsm::GeometryInfo::Impl::read().

Referenced by esys::lsm::operator<<(), and esys::lsm::CheckPointInfo::Impl::read().

Here is the call graph for this function:

Here is the caller graph for this function:

void esys::lsm::GeometryInfo::set_is2d ( bool  do2d)

Set 2-D information to true if the particle data are two-dimensional; otherwise set to false.

References esys::lsm::GeometryInfo::Impl::m_is2d, and m_pImpl.

Referenced by CheckPointController::set_is2d().

Here is the caller graph for this function:

void esys::lsm::GeometryInfo::setBBox ( const Vec3 min,
const Vec3 max 
)

Sets the bounding box for geometry data.

References esys::lsm::GeometryInfo::Impl::m_bBoxMax, esys::lsm::GeometryInfo::Impl::m_bBoxMin, and m_pImpl.

Referenced by CheckPointController::setSpatialDomain(), and CLatticeMaster::setSpatialDomain().

Here is the caller graph for this function:

void esys::lsm::GeometryInfo::setLsmGeoVersion ( float  version)

Set the LSMGeometry version for use in geometry files.

References m_pImpl, and esys::lsm::GeometryInfo::Impl::m_version.

Referenced by CLatticeMaster::readGeometry(), and CheckPointController::setLsmGeoVersion().

Here is the caller graph for this function:

void esys::lsm::GeometryInfo::setPeriodicDimensions ( BoolVector  periodicDimensions)

Set the periodicity of the x, y and z dimensions.

References esys::lsm::GeometryInfo::Impl::m_periodicDimensions, and m_pImpl.

Referenced by CheckPointController::setPeriodicDimensions(), and CLatticeMaster::setSpatialDomain().

Here is the caller graph for this function:

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

Writes to specified istream in form parsable by the GeometryInfo::read method.

References m_pImpl, and esys::lsm::GeometryInfo::Impl::write().

Referenced by esys::lsm::operator<<(), esys::lsm::GougeBlock3D::write(), and esys::lsm::GougeConfig< TmplGrainRandomBoxPacker, TmplParticleRandomBoxPacker, TmplConnection >::write().

Here is the call graph for this function:

Here is the caller graph for this function:

void esys::lsm::GeometryInfo::writeWithoutVersion ( std::ostream &  oStream) const

References m_pImpl, and esys::lsm::GeometryInfo::Impl::writeWithoutVersion().

Referenced by esys::lsm::GeometryInfo::Impl::write(), and esys::lsm::CheckPointInfo::Impl::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation


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