shammath::LatticeCubic< Tvec > Class Template Reference

utility for generating Cubic crystal lattices More...

#include <shammath/include/shammath/crystalLattice.hpp>

Classes
class	IteratorDiscontinuous
	Iterator utility to generate the lattice. More...

Public Types
using	Tscal = shambase::VecComponent< Tvec >

Static Public Member Functions
static constexpr Tvec	generator (Tscal dr, std::array< i32, dim > coord) noexcept
	generate a Cubic lattice centered on (0,0,0)
static constexpr std::pair< std::array< i32, dim >, std::array< i32, dim > >	get_box_index_bounds (Tscal dr, Tvec box_min, Tvec box_max)

Static Public Attributes
static constexpr u32	dim = 3

Detailed Description

template<class Tvec>
class shammath::LatticeCubic< Tvec >

utility for generating Cubic crystal lattices

Template Parameters

Tvec	position vector type

Definition at line 394 of file crystalLattice.hpp.

Member Typedef Documentation

Tscal

template<class Tvec >

using shammath::LatticeCubic< Tvec >::Tscal = shambase::VecComponent<Tvec>

Definition at line 401 of file crystalLattice.hpp.

Member Function Documentation

generator()

template<class Tvec >

static constexpr Tvec shammath::LatticeCubic< Tvec >::generator ( Tscal  dr, std::array< i32, dim >  coord  )

inlinestaticconstexprnoexcept

generate a Cubic lattice centered on (0,0,0)

Parameters

dr
coord

Returns

constexpr Tvec

Definition at line 410 of file crystalLattice.hpp.

get_box_index_bounds()

template<class Tvec >

static constexpr std::pair< std::array< i32, dim >, std::array< i32, dim > > shammath::LatticeCubic< Tvec >::get_box_index_bounds ( Tscal  dr, Tvec  box_min, Tvec  box_max  )

inlinestaticconstexpr

Definition at line 422 of file crystalLattice.hpp.

Member Data Documentation

dim

template<class Tvec >

constexpr u32 shammath::LatticeCubic< Tvec >::dim = 3

staticconstexpr

Definition at line 396 of file crystalLattice.hpp.

---

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

• shammath/include/shammath/crystalLattice.hpp