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

#include <shapedLatticeRod.hpp>

Inheritance diagram for OpenMD::shapedLatticeRod:
OpenMD::shapedLattice

Public Member Functions

 shapedLatticeRod (RealType latticeConstant, std::string latticeType, RealType radius, RealType length)
 
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 rodRadius_
 
RealType rodLength_
 

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 a spherically-capped rod-shaped lattice

Definition at line 57 of file shapedLatticeRod.hpp.

Constructor & Destructor Documentation

◆ shapedLatticeRod()

OpenMD::shapedLatticeRod::shapedLatticeRod ( RealType  latticeConstant,
std::string  latticeType,
RealType  radius,
RealType  length 
)

Member Function Documentation

◆ isInterior()

bool OpenMD::shapedLatticeRod::isInterior ( Vector3d  point)
virtual

Determines whether a point lies within a spherically-capped nanorod at origin (0,0,0)

Implements OpenMD::shapedLattice.

Definition at line 81 of file shapedLatticeRod.cpp.

References OpenMD::distance(), rodLength_, and rodRadius_.

Member Data Documentation

◆ rodLength_

RealType OpenMD::shapedLatticeRod::rodLength_
private

Definition at line 62 of file shapedLatticeRod.hpp.

Referenced by isInterior(), and shapedLatticeRod().

◆ rodRadius_

RealType OpenMD::shapedLatticeRod::rodRadius_
private

Definition at line 62 of file shapedLatticeRod.hpp.

Referenced by isInterior(), and shapedLatticeRod().


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