Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members

LSMDD::BurgersVector Class Reference

The BurgersVector class stores the Burgers vector for a dislocation line. More...

#include <BurgersVector.h>

List of all members.

Public Member Functions

 BurgersVector ()
 BurgersVector (const BurgersVector &rhs)
virtual ~BurgersVector ()
virtual const BurgersVectoroperator= (const BurgersVector &rhs)
virtual double & operator[] (const int i)
virtual const double & operator[] (const int i) const
virtual const double * getPointer () const

Protected Attributes

double d_burgers_vector [3]


Detailed Description

The BurgersVector class stores the Burgers vector for a dislocation line.

NOTES


Constructor & Destructor Documentation

LSMDD::BurgersVector::BurgersVector  )  [inline]
 

The default constructor sets all of the components of the Burgers vector to 0.0.

LSMDD::BurgersVector::BurgersVector const BurgersVector rhs  )  [inline]
 

The copy constructor sets the new Burgers equal to the specified Burgers vector.

Arguments:

  • rhs (in): Burgers vector to be copied

virtual LSMDD::BurgersVector::~BurgersVector  )  [inline, virtual]
 

The default destructor does nothing.


Member Function Documentation

virtual const double* LSMDD::BurgersVector::getPointer  )  const [inline, virtual]
 

Array access operator that returns a pointer to a double array containing the Burgers vector.

Arguments: none

Return value: double pointer to Burgers vector data

virtual const BurgersVector& LSMDD::BurgersVector::operator= const BurgersVector rhs  )  [inline, virtual]
 

The assignment operator sets the new Burgers equal to the specified Burgers vector.

Arguments:

  • rhs (in): Burgers vector to be copied

Return value: reference to the new Burgers vector

virtual const double& LSMDD::BurgersVector::operator[] const int  i  )  const [inline, virtual]
 

Element access operator that returns a const reference.

Arguments:

  • i (in): component of Burgers vector

Return value: reference to specified component of Burgers vector

NOTES:

  • No bounds checking is performed.

virtual double& LSMDD::BurgersVector::operator[] const int  i  )  [inline, virtual]
 

Element access operator that returns a non-const reference.

Arguments:

  • i (in): component of Burgers vector

Return value: reference to specified component of Burgers vector

NOTES:

  • No bounds checking is performed.


Member Data Documentation

double LSMDD::BurgersVector::d_burgers_vector[3] [protected]
 


The documentation for this class was generated from the following file:
Generated on Tue Aug 7 15:43:41 2007 for LSMDD by doxygen 1.3.4