LatticeModelFactory.hpp File Reference

Create lattice representations from a lattice unit cell and specification of spin interactions. More...

#include <string>
#include <map>
#include <set>
#include "Lattice.hpp"
#include "SpinModel.hpp"

Include dependency graph for LatticeModelFactory.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	LatticeModelFactory::LatticeSite
	Representation of a Lattice site. More...
struct	LatticeModelFactory::LatticeBond
	Representation of a lattice bond. More...
struct	LatticeModelFactory::LatticeUnitCell
	Representation of a lattice unit cell. More...
struct	LatticeModelFactory::SpinInteraction
	Representation of a two-spin interaction. More...
struct	LatticeModelFactory::SpinModelUnitCell
	Spin model unit cell representation. More...

Functions
std::pair< Lattice *, SpinModel * >	LatticeModelFactory::newLatticeModel (const LatticeUnitCell &uc, const SpinModelUnitCell &spinModelDefinition, const int latticeRange, const std::string &ldfPath="")
	Create and return lattice and spin model objects from given unit cell definitions. More...

Detailed Description

Create lattice representations from a lattice unit cell and specification of spin interactions.

Author

Finn Lasse Buessen

Copyright

Copyright (c) 2020

Function Documentation

newLatticeModel()

std::pair< Lattice *, SpinModel * > LatticeModelFactory::newLatticeModel	(	const LatticeUnitCell &	uc,
		const SpinModelUnitCell &	spinModelDefinition,
		const int	latticeRange,
		const std::string &	ldfPath = ""
	)

Create and return lattice and spin model objects from given unit cell definitions.

Parameters

uc	Lattice unit cell representation.
spinModelDefinition	Spin model representation.
latticeRange	Lattice range.
ldfPath	File name to write the ldf file of the newly created lattice to. If left empty, do not write an ldf file.

Returns

std::pair<Lattice *, SpinModel *> Newly created Lattice and SpinModel objects.