solid::Ring< T > Class Template Reference

Ring (IGeometry implementation) class. More...

#include <Ring.hpp>

Inheritance diagram for solid::Ring< T >:

Collaboration diagram for solid::Ring< T >:

Public Member Functions
	Ring (int L, initList< T > param)
	Construct a new Ring object. More...
	Ring (int L, uniformParameters< T > &param)
	Construct a new Ring object. More...

Private Member Functions
arma::SpMat< T >	RingAdjacency (int L, T value)
	Ring Adjacency function for Nonlocal Terms. More...
void	Create (int L, std::string key, T value) override
	Create Ring (IGeometry) object. More...

Additional Inherited Members
Public Attributes inherited from solid::Geometry< T >
Parameters< T >	parameters

Detailed Description

template<typename T>
class solid::Ring< T >

Ring (IGeometry implementation) class.

Example ( \(L=4\)):

------------------------- 
|                       |
o --- o --- o --- o --- o
^     ^                 ^
|_____|                 |
   NonlocalTerms        LocalTerms

Template Parameters

T	data type: double, std::complex<double> are supported

Constructor & Destructor Documentation

template<typename T >

solid::Ring< T >::Ring ( int  L, initList< T >  param  )

inline

Construct a new Ring object.

Parameters

L	number of sites
param	map with Parameters

template<typename T >

solid::Ring< T >::Ring ( int  L, uniformParameters< T > &  param  )

inline

Construct a new Ring object.

Parameters

L	number of sites
param	map with Parameters

Member Function Documentation

template<typename T >

void solid::Ring< T >::Create ( int  L, std::string  key, T  value  )

inlineoverrideprivatevirtual

Create Ring (IGeometry) object.

Parameters

L	number of sites
key	parameter label
value	value of the parameter

Implements solid::IGeometry< T >.

template<typename T >

arma::SpMat<T> solid::Ring< T >::RingAdjacency ( int  L, T  value  )

inlineprivate

Ring Adjacency function for Nonlocal Terms.

Parameters

L	number of sites
value	parameter value (t,V,delta,...)

Returns

arma::SpMat<T> Parameters matrix

---

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

• Modules/SOLIDstate_bits/Geometry/Ring.hpp