gbLAB::ReferenceState< dim > Class Template Reference

#include <ReferenceState.h>

Inheritance diagram for gbLAB::ReferenceState< dim >:

Public Member Functions
	ReferenceState (const Gb< dim > &gb, const ReciprocalLatticeVector< dim > &axis, const int &periodScaling)
int	numberOfPlanesOrthogonalToGB () const
LatticeVector< dim >	shiftLatticeVector () const

Data Fields
const Gb< dim > &	gb
const ReciprocalLatticeVector< dim > &	axis
const int	periodScaling
std::map< Triplet >	refState
Eigen::VectorXd	planeEnergies

Private Types
using	IntScalarType = typename LatticeCore< dim >::IntScalarType

Detailed Description

template<int dim>
class gbLAB::ReferenceState< dim >

Definition at line 14 of file ReferenceState.h.

Member Typedef Documentation

IntScalarType

template<int dim>

using gbLAB::ReferenceState< dim >::IntScalarType = typename LatticeCore<dim>::IntScalarType

private

Definition at line 16 of file ReferenceState.h.

Constructor & Destructor Documentation

ReferenceState()

template<int dim>

gbLAB::ReferenceState< dim >::ReferenceState ( const Gb< dim > &  gb, const ReciprocalLatticeVector< dim > &  axis, const int &  periodScaling  )

explicit

Member Function Documentation

numberOfPlanesOrthogonalToGB()

template<int dim>

int gbLAB::ReferenceState< dim >::numberOfPlanesOrthogonalToGB

(

)

const

shiftLatticeVector()

template<int dim>

LatticeVector< dim > gbLAB::ReferenceState< dim >::shiftLatticeVector

(

)

const

Field Documentation

axis

template<int dim>

const ReciprocalLatticeVector<dim>& gbLAB::ReferenceState< dim >::axis

Definition at line 19 of file ReferenceState.h.

gb

template<int dim>

const Gb<dim>& gbLAB::ReferenceState< dim >::gb

Definition at line 18 of file ReferenceState.h.

periodScaling

template<int dim>

const int gbLAB::ReferenceState< dim >::periodScaling

Definition at line 20 of file ReferenceState.h.

planeEnergies

template<int dim>

Eigen::VectorXd gbLAB::ReferenceState< dim >::planeEnergies

Definition at line 23 of file ReferenceState.h.

refState

template<int dim>

std::map<Triplet> gbLAB::ReferenceState< dim >::refState

Definition at line 22 of file ReferenceState.h.

---

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

• include/Lattices/old/ReferenceState.h