Base template for UnitCell<D> classes, D=1, 2 or 3. More...
#include <UnitCell.h>
Additional Inherited Members | |
 Public Member Functions inherited from Pscf::Prdc::UnitCellBase< D > | |
| UnitCellBase () | |
| Constructor. | |
| ~UnitCellBase () | |
| Destructor. | |
| void | setParameters (FSArray< double, 6 > const ¶meters) |
| Set all the parameters of unit cell. | |
| int | nParameter () const |
| Get the number of parameters in the unit cell. | |
| FSArray< double, 6 > | parameters () const |
| Get the parameters of this unit cell. | |
| double | parameter (int i) const |
| Get a single parameter of this unit cell. | |
| bool | isInitialized () const |
| Has this unit cell been initialized? | |
| const RealVec< D > & | rBasis (int i) const |
| Get Bravais basis vector i, denoted by a_i. | |
| const RealVec< D > & | kBasis (int i) const |
| Get reciprocal basis vector i, denoted by b_i. | |
| double | drBasis (int k, int i, int j) const |
| Get component j of derivative of rBasis vector a_i w/respect to k. | |
| double | dkBasis (int k, int i, int j) const |
| Get component j of derivative of kBasis vector b_i w/respect to k. | |
| double | drrBasis (int k, int i, int j) const |
| Get derivative of dot product ai.aj with respect to parameter k. | |
| double | dkkBasis (int k, int i, int j) const |
| Get derivative of dot product bi.bj with respect to parameter k. | |
| virtual double | ksq (IntVec< D > const &k) const |
| Compute square magnitude of reciprocal lattice vector. | |
| virtual double | dksq (IntVec< D > const &vec, int n) const |
| Compute derivative of square wavevector w/respect to cell parameter. | |
| template<class Observer > | |
| void | addObserver (Observer &observer, void(Observer::*methodPtr)()) |
| Add an Observer to this unit cell. | |
| void | clearObservers () |
| Clear all observers and delete the Signal<> object. | |
| int | nObserver () const |
| Return the current number of observers. | |
| Protected Member Functions inherited from Pscf::Prdc::UnitCellBase< D > | |
| void | setLattice () |
| Compute all protected data, given latticeSystem and parameters. | |
| Protected Attributes inherited from Pscf::Prdc::UnitCellBase< D > | |
| FArray< RealVec< D >, D > | rBasis_ |
| Array of Bravais lattice basis vectors. | |
| FArray< RealVec< D >, D > | kBasis_ |
| Array of reciprocal lattice basis vectors. | |
| FArray< FMatrix< double, D, D >, 6 > | drBasis_ |
| Array of derivatives of rBasis. | |
| FArray< FMatrix< double, D, D >, 6 > | dkBasis_ |
| Array of derivatives of kBasis. | |
| FArray< FMatrix< double, D, D >, 6 > | drrBasis_ |
| Array of derivatives of a_i.a_j. | |
| FArray< FMatrix< double, D, D >, 6 > | dkkBasis_ |
| Array of derivatives of b_i.b_j. | |
| FArray< double, 6 > | parameters_ |
| Parameters used to describe the unit cell. | |
| int | nParameter_ |
| Number of parameters required to specify unit cell. | |
| bool | isInitialized_ |
| Has this unit cell been fully initialized? | |
Detailed Description
class Pscf::Prdc::UnitCell< D >
Base template for UnitCell<D> classes, D=1, 2 or 3.
Explicit specializations are defined for D=1, 2, and 3. In each case, class UnitCell<D> is derived from UnitCellBase<D> and defines an enumeration UnitCell<D>::LatticeSystem of the possible types of Bravais lattice systems in D-dimensional space. Iostream inserter (<<) and extractor (>>) operators are defined for each UnitCell<D>::LatticeSystem enumeration. These operators define a standard text representation of each allowed unit cell type, as described here.
Each explicit specialization UnitCell<D> has a member variable of type UnitCell<D>::LatticeSystem, the value of which is returned by a function named lattice(). The value of the lattice variable is initialized to an enumeration value named Null, which denotes unknown or uninitialized. This variable may only be set once. Any attempt to reset the lattice type to a different non-null after it has been set will cause an Exception to be thrown and program execution to halt. Each UnitCell<D> object may thus only be used to represent one lattice type during its lifetime.
A template defines iostream inserter (<<) and extractor (>>) operators each explicit specializations of UnitCell<D>, allowing a UnitCell<D> to be read from or written to file like a primitive variable. The text representation for a UnitCell<D> contains a text representation of the LatticeSystem<D> enumeration (i.e., the unit cell type) and a list of one or more unit cell parameters (lengths and angles), as described here.
Definition at line 34 of file rpg/System.h.
The documentation for this class was generated from the following files:
Generated on Fri Mar 28 2025 00:57:29 for PSCF by
1.12.0