LatticeModelFactory::SpinModelUnitCell Struct Reference

Spin model unit cell representation. More...

#include <LatticeModelFactory.hpp>

Public Member Functions
	SpinModelUnitCell ()
	Construct an uninitialized spin model unit cell.
	SpinModelUnitCell (const std::string &modelName, const std::string &bundle, const std::map< std::string, std::string > &modelOptions)
	Construct a SpinModelUnitCell object and initialize it from a spin model specification with a given name, located in a given resource bundle (directory). The coupling strengths are initialized from the modelOptions argument. More...

Public Attributes
std::vector< SpinInteraction >	interactions
	List of spin interactions in the unit cell.
std::set< std::string >	interactionParameters
	List of interaction parameter names as used in the specification file.

Detailed Description

Spin model unit cell representation.

Constructor & Destructor Documentation

SpinModelUnitCell()

LatticeModelFactory::SpinModelUnitCell::SpinModelUnitCell	(	const std::string &	modelName,
		const std::string &	bundle,
		const std::map< std::string, std::string > &	modelOptions
	)

Construct a SpinModelUnitCell object and initialize it from a spin model specification with a given name, located in a given resource bundle (directory). The coupling strengths are initialized from the modelOptions argument.

Parameters

modelName	Name of the model specification to search.
bundle	Directory to search for the model specification.
modelOptions	List of model options as specified in the task file, to initialize coupling strength.

---

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