Clover fermion operator with chemical potential. More...

#include <afopr_Clover_Chemical.h>

Inheritance diagram for AFopr_Clover_Chemical< AFIELD >:

Public Types
typedef AFIELD::real_t	real_t

Public Member Functions
DEPRECATED	AFopr_Clover_Chemical ()

DEPRECATED	AFopr_Clover_Chemical (const std::string repr)

	AFopr_Clover_Chemical (const Parameters &params)

	~AFopr_Clover_Chemical ()

void	set_parameters (const Parameters &params)
	sets parameters by a Parameter object: to be implemented in a subclass. More...

void	get_parameters (Parameters &params) const
	gets parameters by a Parameter object: to be implemented in a subclass. More...

void	set_config (Field *U)
	sets the gauge configuration. More...

void	set_mode (const std::string mode)
	setting the mode of multiplication if necessary. Default implementation here is just to avoid irrelevant call. More...

void	mult (AFIELD &v, const AFIELD &w)
	multiplies fermion operator to a given field. More...

void	mult_dag (AFIELD &v, const AFIELD &w)
	hermitian conjugate of mult. More...

std::string	get_mode () const
	returns the current mult mode. More...

void	mult_gm5p (const int mu, AFIELD &v, const AFIELD &w)

void	mult_gm5 (AFIELD &, const AFIELD &)
	multiplies gamma_5 matrix. More...

void	D (AFIELD &, const AFIELD &)

void	Dminmu (AFIELD &, const AFIELD &)

void	DdagD (AFIELD &, const AFIELD &)

void	Ddag (AFIELD &, const AFIELD &)

void	H (AFIELD &, const AFIELD &)

void	Hdag (AFIELD &, const AFIELD &)

void	mult_up (const int mu, AFIELD &v, const AFIELD &w)
	upward nearest neighbor hopping term. More...

void	mult_dn (const int mu, AFIELD &v, const AFIELD &w)
	downward nearest neighbor hopping term. More...

virtual bool	needs_convert ()
	returns true if additional field conversion is needed. More...

virtual void	convert (AFIELD &v, const Field &w)
	converts a Field object into other format if necessary. More...

virtual void	reverse (Field &v, const AFIELD &w)
	reverses to a Field object from other format if necessary. More...

int	field_nin ()
	returns the on-site degree of freedom of the fermion field. More...

int	field_nvol ()
	returns the volume of the fermion field. More...

int	field_nex ()
	returns the external degree of freedom of the fermion field. More...

double	flop_count ()
	this returns the number of floating point operations. More...

Public Member Functions inherited from AFopr< AFIELD >
	AFopr ()

virtual	~AFopr ()

virtual void	mult (AFIELD &, const AFIELD &, const std::string mode)
	executes mult with specified mode (unchanging internal mode). More...

virtual void	mult_dag (AFIELD &, const AFIELD &, const std::string mode)
	executes mult_dag with specified mode (unchanging internal mode). More...

virtual void	normalize_fprop (AFIELD &)
	normalize propagator if necessary (default: do nothing) More...

virtual void	normalize_fopr (AFIELD &)
	normalize propagator if necessary (default: do nothing) More...

virtual double	flop_count (const std::string mode)
	returns the flops per site for specified mode. More...

Static Public Attributes
static const std::string	class_name = "AFopr_Clover_Chemical<AFIELD>"

Private Member Functions
void	init (const std::string repr)

void	init (const Parameters &params)

void	tidyup ()

void	set_parameters_impl (const real_t kappa, const real_t cSW, const real_t mu, const std::vector< int > bc)
	sets parameters given as values: private for composite operator. More...

Private Attributes
real_t	m_kappa
	hopping parameter More...

real_t	m_cSW
	clover coefficient More...

real_t	m_mu
	isospin chemical potential More...

std::vector< int >	m_boundary
	boundary conditions More...

Bridge::VerboseLevel	m_vl
	verbose level More...

std::string	m_repr
	gamma-matrix representation More...

std::string	m_kernel_type
	kernel type More...

std::string	m_mode

int	m_Nvol

int	m_Ndim

int	m_Nc

int	m_Nd

int	m_NinF

real_t	m_exp_mu
	exp(mu) More...

AFopr< AFIELD > *	m_fopr_w

AFopr< AFIELD > *	m_fopr_csw

const Field_G *	m_U

AFIELD	m_v1

AFIELD	m_v2
	working field. More...

bool	m_is_initial_step
	to avoid redundant setup More...

Additional Inherited Members
Static Protected Attributes inherited from AFopr< AFIELD >
static const std::string	class_name

Detailed Description

template<typename AFIELD>
class AFopr_Clover_Chemical< AFIELD >

Clover fermion operator with chemical potential.

This class implements the Clover fermion operator at finite chemical potential. Former Fopr_Clover_Isochemical class was converted to a template class and renamed. The first version was implemented by H.M. [22 Aug 2012] and has been improved by Y.Namekawa and H.M. [27 Feb 2022 H.Matsufuru]

Definition at line 35 of file afopr_Clover_Chemical.h.

Member Typedef Documentation

◆ real_t

template<typename AFIELD >

typedef AFIELD::real_t AFopr_Clover_Chemical< AFIELD >::real_t

Definition at line 39 of file afopr_Clover_Chemical.h.

Constructor & Destructor Documentation

◆ AFopr_Clover_Chemical() [1/3]

template<typename AFIELD >

DEPRECATED AFopr_Clover_Chemical< AFIELD >::AFopr_Clover_Chemical ( )

inline

Definition at line 70 of file afopr_Clover_Chemical.h.

◆ AFopr_Clover_Chemical() [2/3]

template<typename AFIELD >

DEPRECATED AFopr_Clover_Chemical< AFIELD >::AFopr_Clover_Chemical ( const std::string repr )

inline

Definition at line 73 of file afopr_Clover_Chemical.h.

◆ AFopr_Clover_Chemical() [3/3]

template<typename AFIELD >

AFopr_Clover_Chemical< AFIELD >::AFopr_Clover_Chemical ( const Parameters & params )

inline

Definition at line 75 of file afopr_Clover_Chemical.h.

◆ ~AFopr_Clover_Chemical()

template<typename AFIELD >

AFopr_Clover_Chemical< AFIELD >::~AFopr_Clover_Chemical ( )

inline

Definition at line 77 of file afopr_Clover_Chemical.h.

Member Function Documentation

◆ convert()

template<typename AFIELD >

virtual void AFopr_Clover_Chemical< AFIELD >::convert	(	AFIELD &	v,
		const Field &	w
	)

inlinevirtual

converts a Field object into other format if necessary.

Reimplemented from AFopr< AFIELD >.

Definition at line 115 of file afopr_Clover_Chemical.h.

◆ D()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::D	(	AFIELD &	v,
		const AFIELD &	w
	)

Definition at line 302 of file afopr_Clover_Chemical-tmpl.h.

◆ Ddag()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::Ddag	(	AFIELD &	v,
		const AFIELD &	w
	)

Definition at line 378 of file afopr_Clover_Chemical-tmpl.h.

◆ DdagD()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::DdagD	(	AFIELD &	v,
		const AFIELD &	w
	)

Definition at line 367 of file afopr_Clover_Chemical-tmpl.h.

◆ Dminmu()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::Dminmu	(	AFIELD &	v,
		const AFIELD &	w
	)

Definition at line 324 of file afopr_Clover_Chemical-tmpl.h.

◆ field_nex()

template<typename AFIELD >

int AFopr_Clover_Chemical< AFIELD >::field_nex ( )

inlinevirtual

returns the external degree of freedom of the fermion field.

Implements AFopr< AFIELD >.

Definition at line 124 of file afopr_Clover_Chemical.h.

◆ field_nin()

template<typename AFIELD >

int AFopr_Clover_Chemical< AFIELD >::field_nin ( )

inlinevirtual

returns the on-site degree of freedom of the fermion field.

Implements AFopr< AFIELD >.

Definition at line 122 of file afopr_Clover_Chemical.h.

◆ field_nvol()

template<typename AFIELD >

int AFopr_Clover_Chemical< AFIELD >::field_nvol ( )

inlinevirtual

returns the volume of the fermion field.

Implements AFopr< AFIELD >.

Definition at line 123 of file afopr_Clover_Chemical.h.

◆ flop_count()

template<typename AFIELD >

double AFopr_Clover_Chemical< AFIELD >::flop_count

virtual

this returns the number of floating point operations.

Reimplemented from AFopr< AFIELD >.

Definition at line 406 of file afopr_Clover_Chemical-tmpl.h.

◆ get_mode()

template<typename AFIELD >

std::string AFopr_Clover_Chemical< AFIELD >::get_mode ( ) const

inlinevirtual

returns the current mult mode.

Reimplemented from AFopr< AFIELD >.

Definition at line 91 of file afopr_Clover_Chemical.h.

◆ get_parameters()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::get_parameters ( Parameters & params ) const

virtual

gets parameters by a Parameter object: to be implemented in a subclass.

Reimplemented from AFopr< AFIELD >.

Definition at line 217 of file afopr_Clover_Chemical-tmpl.h.

◆ H()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::H	(	AFIELD &	v,
		const AFIELD &	w
	)

Definition at line 388 of file afopr_Clover_Chemical-tmpl.h.

◆ Hdag()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::Hdag	(	AFIELD &	v,
		const AFIELD &	w
	)

Definition at line 397 of file afopr_Clover_Chemical-tmpl.h.

◆ init() [1/2]

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::init ( const Parameters & params )

private

Definition at line 29 of file afopr_Clover_Chemical-tmpl.h.

◆ init() [2/2]

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::init ( const std::string repr )

private

Definition at line 89 of file afopr_Clover_Chemical-tmpl.h.

◆ mult()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::mult	(	AFIELD &	,
		const AFIELD &
	)

virtual

multiplies fermion operator to a given field.

Reimplemented from AFopr< AFIELD >.

Definition at line 262 of file afopr_Clover_Chemical-tmpl.h.

◆ mult_dag()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::mult_dag	(	AFIELD &	,
		const AFIELD &
	)

virtual

hermitian conjugate of mult.

Reimplemented from AFopr< AFIELD >.

Definition at line 282 of file afopr_Clover_Chemical-tmpl.h.

◆ mult_dn()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::mult_dn	(	const int	mu,
		AFIELD &	,
		const AFIELD &
	)

inlinevirtual

downward nearest neighbor hopping term.

Reimplemented from AFopr< AFIELD >.

Definition at line 107 of file afopr_Clover_Chemical.h.

◆ mult_gm5()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::mult_gm5	(	AFIELD &	,
		const AFIELD &
	)

virtual

multiplies gamma_5 matrix.

Reimplemented from AFopr< AFIELD >.

Definition at line 346 of file afopr_Clover_Chemical-tmpl.h.

◆ mult_gm5p()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::mult_gm5p	(	const int	mu,
		AFIELD &	v,
		const AFIELD &	w
	)

Definition at line 354 of file afopr_Clover_Chemical-tmpl.h.

◆ mult_up()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::mult_up	(	const int	mu,
		AFIELD &	,
		const AFIELD &
	)

inlinevirtual

upward nearest neighbor hopping term.

Reimplemented from AFopr< AFIELD >.

Definition at line 104 of file afopr_Clover_Chemical.h.

◆ needs_convert()

template<typename AFIELD >

virtual bool AFopr_Clover_Chemical< AFIELD >::needs_convert ( )

inlinevirtual

returns true if additional field conversion is needed.

Reimplemented from AFopr< AFIELD >.

Definition at line 111 of file afopr_Clover_Chemical.h.

◆ reverse()

template<typename AFIELD >

virtual void AFopr_Clover_Chemical< AFIELD >::reverse	(	Field &	v,
		const AFIELD &	w
	)

inlinevirtual

reverses to a Field object from other format if necessary.

Reimplemented from AFopr< AFIELD >.

Definition at line 119 of file afopr_Clover_Chemical.h.

◆ set_config()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::set_config ( Field * )

virtual

sets the gauge configuration.

Implements AFopr< AFIELD >.

Definition at line 234 of file afopr_Clover_Chemical-tmpl.h.

◆ set_mode()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::set_mode ( const std::string mode )

virtual

setting the mode of multiplication if necessary. Default implementation here is just to avoid irrelevant call.

Reimplemented from AFopr< AFIELD >.

Definition at line 248 of file afopr_Clover_Chemical-tmpl.h.

◆ set_parameters()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::set_parameters ( const Parameters & params )

virtual

sets parameters by a Parameter object: to be implemented in a subclass.

Reimplemented from AFopr< AFIELD >.

Definition at line 145 of file afopr_Clover_Chemical-tmpl.h.

◆ set_parameters_impl()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::set_parameters_impl	(	const real_t	kappa,
		const real_t	cSW,
		const real_t	mu,
		const std::vector< int >	bc
	)

private

sets parameters given as values: private for composite operator.

Definition at line 184 of file afopr_Clover_Chemical-tmpl.h.

◆ tidyup()

template<typename AFIELD >

void AFopr_Clover_Chemical< AFIELD >::tidyup

private

Definition at line 137 of file afopr_Clover_Chemical-tmpl.h.

Member Data Documentation

◆ class_name

const std::string Fopr_Clover_Chemical::class_name = "AFopr_Clover_Chemical<AFIELD>"

static

Definition at line 38 of file afopr_Clover_Chemical.h.

◆ m_boundary

template<typename AFIELD >

std::vector<int> AFopr_Clover_Chemical< AFIELD >::m_boundary

private

boundary conditions

Definition at line 45 of file afopr_Clover_Chemical.h.

◆ m_cSW

template<typename AFIELD >

real_t AFopr_Clover_Chemical< AFIELD >::m_cSW

private

clover coefficient

Definition at line 43 of file afopr_Clover_Chemical.h.

◆ m_exp_mu

template<typename AFIELD >

real_t AFopr_Clover_Chemical< AFIELD >::m_exp_mu

private

exp(mu)

Definition at line 56 of file afopr_Clover_Chemical.h.

◆ m_fopr_csw

template<typename AFIELD >

AFopr<AFIELD>* AFopr_Clover_Chemical< AFIELD >::m_fopr_csw

private

Definition at line 59 of file afopr_Clover_Chemical.h.

◆ m_fopr_w

template<typename AFIELD >

AFopr<AFIELD>* AFopr_Clover_Chemical< AFIELD >::m_fopr_w

private

Definition at line 58 of file afopr_Clover_Chemical.h.

◆ m_is_initial_step

template<typename AFIELD >

bool AFopr_Clover_Chemical< AFIELD >::m_is_initial_step

private

to avoid redundant setup

Definition at line 65 of file afopr_Clover_Chemical.h.

◆ m_kappa

template<typename AFIELD >

real_t AFopr_Clover_Chemical< AFIELD >::m_kappa

private

hopping parameter

Definition at line 42 of file afopr_Clover_Chemical.h.

◆ m_kernel_type

template<typename AFIELD >

std::string AFopr_Clover_Chemical< AFIELD >::m_kernel_type

private

kernel type

Definition at line 49 of file afopr_Clover_Chemical.h.

◆ m_mode

template<typename AFIELD >

std::string AFopr_Clover_Chemical< AFIELD >::m_mode

private

Definition at line 51 of file afopr_Clover_Chemical.h.

◆ m_mu

template<typename AFIELD >

real_t AFopr_Clover_Chemical< AFIELD >::m_mu

private

isospin chemical potential

Definition at line 44 of file afopr_Clover_Chemical.h.

◆ m_Nc

template<typename AFIELD >

int AFopr_Clover_Chemical< AFIELD >::m_Nc

private

Definition at line 55 of file afopr_Clover_Chemical.h.

◆ m_Nd

template<typename AFIELD >

int AFopr_Clover_Chemical< AFIELD >::m_Nd

private

Definition at line 55 of file afopr_Clover_Chemical.h.

◆ m_Ndim

template<typename AFIELD >

int AFopr_Clover_Chemical< AFIELD >::m_Ndim

private

Definition at line 54 of file afopr_Clover_Chemical.h.

◆ m_NinF

template<typename AFIELD >

int AFopr_Clover_Chemical< AFIELD >::m_NinF

private

Definition at line 55 of file afopr_Clover_Chemical.h.

◆ m_Nvol

template<typename AFIELD >

int AFopr_Clover_Chemical< AFIELD >::m_Nvol

private

Definition at line 54 of file afopr_Clover_Chemical.h.

◆ m_repr

template<typename AFIELD >

std::string AFopr_Clover_Chemical< AFIELD >::m_repr

private

gamma-matrix representation

Definition at line 47 of file afopr_Clover_Chemical.h.

◆ m_U

template<typename AFIELD >

const Field_G* AFopr_Clover_Chemical< AFIELD >::m_U

private

Definition at line 61 of file afopr_Clover_Chemical.h.

◆ m_v1

template<typename AFIELD >

AFIELD AFopr_Clover_Chemical< AFIELD >::m_v1

private

Definition at line 63 of file afopr_Clover_Chemical.h.

◆ m_v2

template<typename AFIELD >

AFIELD AFopr_Clover_Chemical< AFIELD >::m_v2

private

working field.

Definition at line 63 of file afopr_Clover_Chemical.h.

◆ m_vl

template<typename AFIELD >

Bridge::VerboseLevel AFopr_Clover_Chemical< AFIELD >::m_vl

private

verbose level

Definition at line 46 of file afopr_Clover_Chemical.h.

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

src/lib/Fopr/afopr_Clover_Chemical.h
src/lib/Fopr/afopr_Clover_Chemical-tmpl.h
src/lib/Fopr/fopr_Clover_Chemical.cpp

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename AFIELD> class AFopr_Clover_Chemical< AFIELD >

Member Typedef Documentation

◆ real_t

Constructor & Destructor Documentation

◆ AFopr_Clover_Chemical() [1/3]

◆ AFopr_Clover_Chemical() [2/3]

◆ AFopr_Clover_Chemical() [3/3]

◆ ~AFopr_Clover_Chemical()

Member Function Documentation

◆ convert()

◆ D()

◆ Ddag()

◆ DdagD()

◆ Dminmu()

◆ field_nex()

◆ field_nin()

◆ field_nvol()

◆ flop_count()

◆ get_mode()

◆ get_parameters()

◆ H()

◆ Hdag()

◆ init() [1/2]

◆ init() [2/2]

◆ mult()

◆ mult_dag()

◆ mult_dn()

◆ mult_gm5()

◆ mult_gm5p()

◆ mult_up()

◆ needs_convert()

◆ reverse()

◆ set_config()

◆ set_mode()

◆ set_parameters()

◆ set_parameters_impl()

◆ tidyup()

Member Data Documentation

◆ class_name

◆ m_boundary

◆ m_cSW

◆ m_exp_mu

◆ m_fopr_csw

◆ m_fopr_w

◆ m_is_initial_step

◆ m_kappa

◆ m_kernel_type

◆ m_mode

◆ m_mu

◆ m_Nc

◆ m_Nd

◆ m_Ndim

◆ m_NinF

◆ m_Nvol

◆ m_repr

◆ m_U

◆ m_v1

◆ m_v2

◆ m_vl

template<typename AFIELD>
class AFopr_Clover_Chemical< AFIELD >