triqs::mesh::cyclat::mesh_point_t

#include <triqs/mesh/cyclat.hpp>

Detailed Description

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

It inherits from triqs::lattice::bravais_lattice::point_t and in addition to the index \( \mathbf{n} \), the underlying Bravais lattice and the value \( \mathbf{R}^{\mathbf{n}} \), it also stores the data index \( d \) and the hash value of the parent mesh.

Definition at line 106 of file cyclat.hpp.

Inheritance diagram for triqs::mesh::cyclat::mesh_point_t:

Public Types
using	mesh_t = cyclat
	Parent mesh type.

Public Member Functions
	mesh_point_t ()=default
	Default constructor leaves the mesh point uninitialized.
	mesh_point_t (std::array< long, 3 > const &n, long d, uint64_t mhash, bravais_lattice const *bl_ptr)
	Construct a mesh point with a given index \( \mathbf{n} \), data index \( d \), hash value of the parent mesh and Bravais lattice to which the mesh point belongs.
long	data_index () const
	Get the data index \( d \) of the mesh point.
uint64_t	mesh_hash () const noexcept
	Get the hash value of the parent mesh.
value_t const &	value () const
	Get the lattice point \( \mathbf{R}^{\mathbf{n}} \) of the mesh point.
Public Member Functions inherited from triqs::lattice::bravais_lattice::point_t
	point_t ()=default
	Default constructor leaves the lattice point uninitialized, i.e. belonging to no Bravais lattice.
	point_t (index_t const &n, bravais_lattice const *bl_ptr)
	Construct a lattice point with a given index vector on the given Bravais lattice.
auto	index () const
	Get the index vector \( \mathbf{n} \) of the lattice point.
auto const &	lattice () const
	Get the underlying Bravais lattice.
	operator r_t () const
	Conversion to the corresponding lattice vector \( \mathbf{R}^{\mathbf{n}} = \sum_{i=1}^{d} \mathbf{a}_i n_i \).
double	operator() (int d) const
	Get the coordinate \( R^{\mathbf{n}}_i \) of the corresponding lattice vector \(\mathbf{R}^{\mathbf{n}} \).
point_t	operator+ (point_t const &pt) const
	Add two lattice points \( \mathbf{R}^{\mathbf{n}} \) and \( \mathbf{R}^{\mathbf{m}} \).
point_t	operator- () const
	Invert the lattice point \( \mathbf{R}^{\mathbf{n}} \).
point_t	operator- (point_t const &pt) const
	Subtract two lattice points \( \mathbf{R}^{\mathbf{n}} \) and \( \mathbf{R}^{\mathbf{m}} \).
double	operator[] (int i) const
	Get the coordinate \( R^{\mathbf{n}}_i \) of the corresponding lattice vector \(\mathbf{R}^{\mathbf{n}} \).

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

Constructor & Destructor Documentation

mesh_point_t()

triqs::mesh::cyclat::mesh_point_t::mesh_point_t ( std::array< long, 3 > const & n, long d, uint64_t mhash, bravais_lattice const * bl_ptr )

inline

Construct a mesh point with a given index \( \mathbf{n} \), data index \( d \), hash value of the parent mesh and Bravais lattice to which the mesh point belongs.

Parameters

n	Index \(\mathbf{n} \) of the mesh point.
d	Data index \( d \) of the mesh point.
mhash	Hash value of the parent mesh.
bl_ptr	Pointer to a triqs::lattice::bravais_lattice object.

Definition at line 123 of file cyclat.hpp.

Friends And Related Symbol Documentation

operator<<

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

friend

Write triqs::mesh::cyclat::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 142 of file cyclat.hpp.

---

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

• triqs/mesh/cyclat.hpp