LatticeModelFactory::LatticeUnitCell Struct Reference

Representation of a lattice unit cell. More...

#include <LatticeModelFactory.hpp>

Public Member Functions
	LatticeUnitCell ()
	Construct an unitialized lattice unit cell.
	LatticeUnitCell (const std::string &latticeName, const std::string &bundle)
	Construct a new LatticeUnitCell and initialize it from a specification file placed in the given resource bundle (directory). This will search all .xml files in the specified directory for valid unit cell definitions and use the first one that matches the desired name. More...

Public Attributes
std::vector< geometry::Vec3< double > >	latticeVectors
	List of the three Bravais lattice vectors.
std::vector< geometry::Vec3< double > >	basisSites
	List of all basis site positions.
std::vector< LatticeBond >	latticeBonds
	List of all lattice bonds.

Detailed Description

Representation of a lattice unit cell.

Constructor & Destructor Documentation

LatticeUnitCell()

LatticeModelFactory::LatticeUnitCell::LatticeUnitCell	(	const std::string &	latticeName,
		const std::string &	bundle
	)

Construct a new LatticeUnitCell and initialize it from a specification file placed in the given resource bundle (directory). This will search all .xml files in the specified directory for valid unit cell definitions and use the first one that matches the desired name.

Parameters

latticeName	Name of the unit cell specification to search for.
bundle	Directory to search.

---

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

• /home/runner/work/SpinParser/SpinParser/src/LatticeModelFactory.hpp
• /home/runner/work/SpinParser/SpinParser/src/LatticeModelFactory.cpp