q3::ReciprocalSpaceVectorsGrid Class Reference

A grid of reciprocal-space vectors. More...

#include <reciprocal_space_vectors_grid.hpp>

Inheritance diagram for q3::ReciprocalSpaceVectorsGrid:

Public Member Functions
	ReciprocalSpaceVectorsGrid ()=default
int	number_of_vectors () const
const ReciprocalSpaceVector &	vector (int index) const
const std::vector< ReciprocalSpaceVector > &	vectors () const
Public Member Functions inherited from q3::PointsGrid
	PointsGrid ()=default
virtual	~PointsGrid ()=default
bool	empty () const
int	number_of_points () const
const WeightedPoint3D &	point (int index) const
const std::vector< WeightedPoint3D > &	points () const

Protected Attributes
std::vector< ReciprocalSpaceVector >	vectors_
Protected Attributes inherited from q3::PointsGrid
std::vector< WeightedPoint3D >	points_

Detailed Description

A grid of reciprocal-space vectors.

Definition at line 19 of file reciprocal_space_vectors_grid.hpp.

Constructor & Destructor Documentation

ReciprocalSpaceVectorsGrid()

q3::ReciprocalSpaceVectorsGrid::ReciprocalSpaceVectorsGrid ( )

default

Member Function Documentation

number_of_vectors()

int q3::ReciprocalSpaceVectorsGrid::number_of_vectors ( ) const

inline

Definition at line 23 of file reciprocal_space_vectors_grid.hpp.

References vectors_.

vector()

const ReciprocalSpaceVector & q3::ReciprocalSpaceVectorsGrid::vector ( int  index ) const

inline

Definition at line 31 of file reciprocal_space_vectors_grid.hpp.

References vectors_.

Referenced by q3::GVectorsGrid::estimate_maximum_plane_waves_per_kpoint(), q3::GVectorsGrid::g_vector_to_fft_grid_index(), and q3::GVectorsGrid::generate().

vectors()

const std::vector< ReciprocalSpaceVector > & q3::ReciprocalSpaceVectorsGrid::vectors ( ) const

inline

Definition at line 27 of file reciprocal_space_vectors_grid.hpp.

References vectors_.

Member Data Documentation

vectors_

std::vector<ReciprocalSpaceVector> q3::ReciprocalSpaceVectorsGrid::vectors_

protected

Definition at line 36 of file reciprocal_space_vectors_grid.hpp.

Referenced by number_of_vectors(), vector(), and vectors().

---

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

• src/layer_1_structure/reciprocal_space/reciprocal_space_vectors_grid.hpp