OpenMD  2.5
Molecular Dynamics in the Open
OpenMD::shapedLatticeEllipsoid Class Reference

#include <shapedLatticeEllipsoid.hpp>

Inheritance diagram for OpenMD::shapedLatticeEllipsoid:
OpenMD::shapedLattice

Public Member Functions

 shapedLatticeEllipsoid (RealType latticeConstant, std::string latticeType, RealType rAxial, RealType rEquatorial)
 
virtual bool isInterior (Vector3d point)
 
- Public Member Functions inherited from OpenMD::shapedLattice
 shapedLattice (RealType latticeConstant, std::string latticeType)
 
virtual ~shapedLattice ()
 
void setGridDimension (Vector3d dimension)
 
void setOrigin (Vector3d origin)
 
std::vector< Vector3dgetSites ()
 
std::vector< Vector3dgetOrientations ()
 

Private Attributes

RealType rAxial_
 
RealType rEquatorial_
 
RealType rMajor_
 
RealType rMinor_
 

Additional Inherited Members

- Protected Member Functions inherited from OpenMD::shapedLattice
void findSites ()
 
- Protected Attributes inherited from OpenMD::shapedLattice
Vector3d dimension_
 
Vector3d origin_
 

Detailed Description

Implements an ellipsoid-shaped lattice

Definition at line 53 of file shapedLatticeEllipsoid.hpp.

Constructor & Destructor Documentation

◆ shapedLatticeEllipsoid()

OpenMD::shapedLatticeEllipsoid::shapedLatticeEllipsoid ( RealType  latticeConstant,
std::string  latticeType,
RealType  rAxial,
RealType  rEquatorial 
)

Member Function Documentation

◆ isInterior()

bool OpenMD::shapedLatticeEllipsoid::isInterior ( Vector3d  pos)
virtual

Determines whether a point lies within an ellipsoid centered at origin (0,0,0)

Implements OpenMD::shapedLattice.

Definition at line 77 of file shapedLatticeEllipsoid.cpp.

References rAxial_, and rEquatorial_.

Member Data Documentation

◆ rAxial_

RealType OpenMD::shapedLatticeEllipsoid::rAxial_
private

Definition at line 58 of file shapedLatticeEllipsoid.hpp.

Referenced by isInterior(), and shapedLatticeEllipsoid().

◆ rEquatorial_

RealType OpenMD::shapedLatticeEllipsoid::rEquatorial_
private

Definition at line 59 of file shapedLatticeEllipsoid.hpp.

Referenced by isInterior(), and shapedLatticeEllipsoid().

◆ rMajor_

RealType OpenMD::shapedLatticeEllipsoid::rMajor_
private

Definition at line 60 of file shapedLatticeEllipsoid.hpp.

◆ rMinor_

RealType OpenMD::shapedLatticeEllipsoid::rMinor_
private

Definition at line 61 of file shapedLatticeEllipsoid.hpp.


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