alma::Supercell_index_builder Class Reference

Builder for Supercell_index objects sharing the same na, nb, nc. More...

#include <structures.hpp>

Public Member Functions
	Supercell_index_builder (const int _na, const int _nb, const int _nc, const int _natoms)
	Basic constructor.
Supercell_index	create_index (const int index) const
	Create a Supercell_index from a single integer.
Supercell_index	create_index (const int ia, const int ib, const int ic, const int iatom) const
	Create a Supercell_index from four integers.
Supercell_index	create_index_safely (const int index) const
	Perform a bounds check and create a Supercell_index from a single integer. More...
Supercell_index	create_index_safely (const int ia, const int ib, const int ic, const int iatom) const
	Perform a bounds check and create a Supercell_index from four integers. More...

Public Attributes
const int	na
	Supercell dimension along the first axis.
const int	nb
	Supercell dimension along the second axis.
const int	nc
	Supercell dimension along the third axis.
const int	natoms
	Number of atoms in the unit cell.

Detailed Description

Builder for Supercell_index objects sharing the same na, nb, nc.

Member Function Documentation

create_index_safely() [1/2]

Supercell_index alma::Supercell_index_builder::create_index_safely

(

const int

index

)

const

Perform a bounds check and create a Supercell_index from a single integer.

create_index_safely() [2/2]

Supercell_index alma::Supercell_index_builder::create_index_safely	(	const int	ia,
		const int	ib,
		const int	ic,
		const int	iatom
	)		const

Perform a bounds check and create a Supercell_index from four integers.

---

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

• structures.hpp
• structures.cpp