triqs::mesh::brzone::mesh_point_t

#include <triqs/mesh/brzone.hpp>

Detailed Description

Mesh point of a triqs::mesh::brzone mesh.

It stores the index \( \mathbf{n} \), data index \( d(\mathbf{n}) \), a pointer to and the hash value of the parent mesh, and the value \( \mathbf{k}^{\mathbf{n}} \).

Definition at line 121 of file brzone.hpp.

Public Types
using	mesh_t = brzone
	Parent mesh type.

Public Member Functions
	mesh_point_t ()=default
	Default constructor leaves the mesh point uninitialized.
	mesh_point_t (mesh_point_t const &mp)
	Copy constructor to handle the presence of the std::mutex object correctly.
	mesh_point_t (std::array< long, 3 > const &n, brzone const *m_ptr, long d)
	Construct a mesh point with a given index \( \mathbf{n} \), pointer to the Brillouin zone mesh the mesh point belongs to and data index \( d \).
long	data_index () const
	Get the data index \( d \) of the mesh point.
mesh_t::index_t	index () const
	Get the index \( \mathbf{n} \) of the mesh point.
uint64_t	mesh_hash () const noexcept
	Get the hash value of the parent mesh.
	operator value_t () const
	Conversion to the value type of the parent mesh.
double	operator() (int d) const
	Get the coordinate \( k^{\mathbf{n}}_i \) of the corresponding reciprocal vector \(\mathbf{k}^{\mathbf{n}} \).
double	operator[] (int i) const
	Get the coordinate \( k^{\mathbf{n}}_i \) of the corresponding reciprocal vector \(\mathbf{k}^{\mathbf{n}} \).
value_t const &	value () const
	Get the reciprocal vector \( \mathbf{k}^\mathbf{n} \) corresponding to the mesh point.

Friends
std::ostream &	operator<< (std::ostream &sout, mesh_point_t const &mp)
	Write triqs::mesh::brzone::mesh_point_t to a std::ostream.

Constructor & Destructor Documentation

mesh_point_t()

triqs::mesh::brzone::mesh_point_t::mesh_point_t ( std::array< long, 3 > const & n, brzone const * m_ptr, long d )

inline

Construct a mesh point with a given index \( \mathbf{n} \), pointer to the Brillouin zone mesh the mesh point belongs to and data index \( d \).

Parameters

n	Index \(\mathbf{n} \) of the mesh point.
m_ptr	Pointer to a triqs::mesh::brzone object.
d	Data index \( d \) of the mesh point.

Definition at line 137 of file brzone.hpp.

Member Function Documentation

operator()()

double triqs::mesh::brzone::mesh_point_t::operator() ( int d ) const

inline

Get the coordinate \( k^{\mathbf{n}}_i \) of the corresponding reciprocal vector \(\mathbf{k}^{\mathbf{n}} \).

Deprecated

Use operator[]() instead.

Definition at line 172 of file brzone.hpp.

operator[]()

double triqs::mesh::brzone::mesh_point_t::operator[] ( int i ) const

inlinenodiscard

Get the coordinate \( k^{\mathbf{n}}_i \) of the corresponding reciprocal vector \(\mathbf{k}^{\mathbf{n}} \).

Parameters

i	Dimension index \( i \).

Returns

Reciprocal vector coordinate \( k^{\mathbf{n}}_i \).

Definition at line 181 of file brzone.hpp.

Friends And Related Symbol Documentation

operator<<

std::ostream & operator<< ( std::ostream & sout, mesh_point_t const & mp )

friend

Write triqs::mesh::brzone::mesh_point_t to a std::ostream.

Parameters

sout	std::ostream object.
mp	Mesh point to be written.

Returns

Reference to std::ostream object.

Definition at line 190 of file brzone.hpp.

---

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

• triqs/mesh/brzone.hpp