Spin.hpp File Reference

Header file for the inclusion of all spin related types. More...

#include <tens/TensComp.hpp>
#include <tens/TwinsComp.hpp>
#include <smet/Bind.hpp>

Go to the source code of this file.

Classes
struct	SUNphi::RwSpin
struct	SUNphi::CnSpin
struct	SUNphi::_TwinCompOf< RwSpin >
struct	SUNphi::_TwinCompOf< CnSpin >
struct	SUNphi::TwinTensCompOf< Spin >

Typedefs
using	SUNphi::Spin = CnSpin

Functions
Conditional< 0, decltype(maybeUnused(NCOMPL)), void >	SUNphi::maybeUnusedFD ()
template<typename T >
decltype(auto)	SUNphi::rwSpin (T &&ref, const int id)
template<typename T >
decltype(auto)	SUNphi::cnSpin (T &&ref, const int id)
template<typename T >
decltype(auto)	SUNphi::spin (T &&ref, const int id)

Variables
constexpr const int	SUNphi::NSPIN = 4
constexpr const int	SUNphi::NRW_Spin = NSPIN
constexpr const int	SUNphi::NCN_Spin = NSPIN
template<>
constexpr bool	SUNphi::hasTwin< RwSpin > = true
template<>
constexpr bool	SUNphi::hasTwin< CnSpin > = true

Detailed Description

Header file for the inclusion of all spin related types.

Definition in file Spin.hpp.

Typedef Documentation

using SUNphi::Spin = typedef CnSpin

Declares an alias Spin to be used when no column or row specified

Definition at line 15 of file Spin.hpp.

Function Documentation

template<typename T >

decltype(auto) SUNphi::cnSpin	(	T &&	ref,
		const int	id
	)

Get a reference to the CnSpin component id of ref

Parameters

ref	Quantity to be bind
id	Component to bind

Definition at line 15 of file Spin.hpp.

Conditional< 0, decltype(maybeUnused(hasTwin< CnCol >)), void > SUNphi::maybeUnusedFD

(

)

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of NCOMPL

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of ALIGNMENT

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of NDIR

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of NDUMMY_VOLUME

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of NSPIN

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of NRW_Spin

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of NCN_Spin

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of hasTwin< RwSpin >

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of hasTwin< CnSpin >

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of NCOL

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of NRW_Col

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of NCN_Col

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of hasTwin< RwCol >

Forward declaration of a dummy function, used to suppress "Unused variable" warning

Returns

the type of hasTwin< CnCol >

template<typename T >

decltype(auto) SUNphi::rwSpin	(	T &&	ref,
		const int	id
	)

Get a reference to the RwSpin component id of ref

Parameters

ref	Quantity to be bind
id	Component to bind

Definition at line 15 of file Spin.hpp.

template<typename T >

decltype(auto) SUNphi::spin	(	T &&	ref,
		const int	id
	)

< Name of the bindfun

Returns a binder to the only Rw Spin or Cn Spin type available

TensKind of binding expression

Tuple containing all Tk types

Check if row type is available

Check if column type is available

Check that not more than one type is available

Check that at least one type is available

Parameters

ref	Quantity to be bound
id	Component to bind

Definition at line 15 of file Spin.hpp.

Variable Documentation

template<>

constexpr bool SUNphi::hasTwin< CnSpin > = true

inline

Declare that CnSpin has a twin

Definition at line 15 of file Spin.hpp.

template<>

constexpr bool SUNphi::hasTwin< RwSpin > = true

inline

Declare that RwSpin has a twin

Definition at line 15 of file Spin.hpp.

constexpr const int SUNphi::NCN_Spin = NSPIN

Maximal value for TensKind of type CnSpin

Definition at line 15 of file Spin.hpp.

constexpr const int SUNphi::NRW_Spin = NSPIN

Maximal value for TensKind of type RwSpin

Definition at line 15 of file Spin.hpp.

constexpr const int SUNphi::NSPIN = 4

Number of components of Spin type

Definition at line 15 of file Spin.hpp.