solid::Chain< T > Class Template Reference

Chain (IGeometry implementation) class. More...

#include <Chain.hpp>

Inheritance diagram for solid::Chain< T >:

Collaboration diagram for solid::Chain< T >:

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

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

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

Detailed Description

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

Chain (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::Chain< T >::Chain ( int  L, initList< T >  param  )

inline

Construct a new Chain object.

Parameters

L	number of sites
param	map with Parameters

template<typename T >

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

inline

Construct a new Chain object.

Parameters

L	number of sites
param	map with Parameters

Member Function Documentation

template<typename T >

arma::SpMat<T> solid::Chain< T >::ChainAdjacency ( int  L, T  value  )

inlineprivate

Chain Adjacency function for Nonlocal Terms.

Parameters

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

Returns

arma::SpMat<T> Parameters matrix

template<typename T >

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

inlineoverrideprivatevirtual

Create Chain (IGeometry) object.

Parameters

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

Implements solid::IGeometry< T >.

---

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

• Modules/SOLIDstate_bits/Geometry/Chain.hpp