ESyS-Particle  4.0.1
Classes | Public Member Functions
esys::lsm::GeometryInfo Class Reference

#include <GeometryInfo.h>

List of all members.

Classes

class  Impl

Public Member Functions

 GeometryInfo (float version, const Vec3 &bBoxMin, const Vec3 &bBoxMax, const BoolVector &periodicDimensions, bool is2d=false)
 GeometryInfo (const GeometryInfo &geoInfo)
GeometryInfooperator= (const GeometryInfo &geoInfo)
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)
void read (std::istream &iStream)
void write (std::ostream &oStream) const

Detailed Description

Container class for geometry meta-info.


Member Function Documentation

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

Returns two corner points of bounding box.

Referenced by CLatticeMaster::initialiseGeometry().

Here is the caller graph for this function:

IntVector esys::lsm::GeometryInfo::getPeriodicDimensions ( ) const

Returns the periodic dimensions.

References esys::lsm::GeometryInfo::Impl::m_periodicDimensions.

Referenced by CLatticeMaster::initialiseGeometry().

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.

Referenced by CLatticeMaster::initialiseGeometry().

Here is the caller graph for this function:

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

Returns true info indicates two-dimensional particle data.

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

Parses specified istream and assigns to this object.

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.

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.

Referenced by CLatticeMaster::readGeometry(), and CheckPointController::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.

Referenced by 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.

Referenced by CheckPointController::setPeriodicDimensions().

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.


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