CHROMA: Chroma::FermBC< T, P, Q > Class Template Reference

CHROMA

Base class for all fermion action boundary conditions. More...

#include <fermbc.h>

Inheritance diagram for Chroma::FermBC< T, P, Q >:

Public Member Functions
virtual	~FermBC ()
	Virtual destructor to help with cleanup;. More...

virtual void	modifyF (T &psi) const =0
	Modify fermion fields in place. More...

virtual void	modifyF (T &psi, const Subset &s) const =0
	Modify fermion fields in place under a subset. More...

virtual void	modifyF (multi1d< T > &psi) const =0
	Modify fermion fields in place. More...

virtual void	modifyF (multi1d< T > &psi, const Subset &s) const =0
	Modify fermion fields in place under a subset. More...

virtual void	modify (Q &u) const =0
	Modify U fields according to the fermion BC in place. More...

virtual void	zero (P &ds_u) const =0
	Zero some gauge-like field in place on the masked links. More...

virtual bool	nontrivialP () const =0
	Says if there are fermion non-trivial. More...

Public Member Functions inherited from Chroma::BoundCond< P, Q >
virtual	~BoundCond ()
	Virtual destructor to help with cleanup;. More...

Detailed Description

template<typename T, typename P, typename Q>
class Chroma::FermBC< T, P, Q >

Base class for all fermion action boundary conditions.

Definition at line 19 of file fermbc.h.

Constructor & Destructor Documentation

◆ ~FermBC()

template<typename T , typename P , typename Q >

virtual Chroma::FermBC< T, P, Q >::~FermBC ( )

inlinevirtual

Virtual destructor to help with cleanup;.

Definition at line 23 of file fermbc.h.

Member Function Documentation

◆ modify()

template<typename T , typename P , typename Q >

virtual void Chroma::FermBC< T, P, Q >::modify ( Q & u ) const

pure virtual

Modify U fields according to the fermion BC in place.

Implements Chroma::BoundCond< P, Q >.

Implemented in Chroma::SimpleFermBC< T, P, Q >, Chroma::PeriodicFermBC< T, P, Q >, Chroma::TwistedFermBC< T >, Chroma::SchrFermBC, and Chroma::BackgroundFermBC< T >.

◆ modifyF() [1/4]

template<typename T , typename P , typename Q >

virtual void Chroma::FermBC< T, P, Q >::modifyF ( multi1d< T > & psi ) const

pure virtual

Modify fermion fields in place.

Convenience function

Implemented in Chroma::TwistedFermBC< T >, Chroma::SimpleFermBC< T, P, Q >, Chroma::PeriodicFermBC< T, P, Q >, Chroma::BackgroundFermBC< T >, and Chroma::SchrFermBC.

◆ modifyF() [2/4]

template<typename T , typename P , typename Q >

virtual void Chroma::FermBC< T, P, Q >::modifyF	(	multi1d< T > &	psi,
		const Subset &	s
	)		const

pure virtual

Modify fermion fields in place under a subset.

Convenience function

Implemented in Chroma::TwistedFermBC< T >, Chroma::SimpleFermBC< T, P, Q >, Chroma::PeriodicFermBC< T, P, Q >, Chroma::BackgroundFermBC< T >, and Chroma::SchrFermBC.

◆ modifyF() [3/4]

template<typename T , typename P , typename Q >

virtual void Chroma::FermBC< T, P, Q >::modifyF ( T & psi ) const

pure virtual

Modify fermion fields in place.

Implemented in Chroma::TwistedFermBC< T >, Chroma::SimpleFermBC< T, P, Q >, Chroma::PeriodicFermBC< T, P, Q >, Chroma::BackgroundFermBC< T >, and Chroma::SchrFermBC.

◆ modifyF() [4/4]

template<typename T , typename P , typename Q >

virtual void Chroma::FermBC< T, P, Q >::modifyF	(	T &	psi,
		const Subset &	s
	)		const

pure virtual

Modify fermion fields in place under a subset.

Implemented in Chroma::TwistedFermBC< T >, Chroma::SimpleFermBC< T, P, Q >, Chroma::PeriodicFermBC< T, P, Q >, Chroma::BackgroundFermBC< T >, and Chroma::SchrFermBC.

◆ nontrivialP()

template<typename T , typename P , typename Q >

virtual bool Chroma::FermBC< T, P, Q >::nontrivialP ( ) const

pure virtual

Says if there are fermion non-trivial.

Implements Chroma::BoundCond< P, Q >.

Implemented in Chroma::TwistedFermBC< T >, Chroma::SimpleFermBC< T, P, Q >, Chroma::SchrFermBC, Chroma::PeriodicFermBC< T, P, Q >, and Chroma::BackgroundFermBC< T >.

◆ zero()

template<typename T , typename P , typename Q >

virtual void Chroma::FermBC< T, P, Q >::zero ( P & ds_u ) const

pure virtual

Zero some gauge-like field in place on the masked links.

Implements Chroma::BoundCond< P, Q >.

Implemented in Chroma::SimpleFermBC< T, P, Q >, Chroma::PeriodicFermBC< T, P, Q >, Chroma::TwistedFermBC< T >, Chroma::SchrFermBC, and Chroma::BackgroundFermBC< T >.

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

fermbc.h