The Wilson gauge action, as introduced in Wilson, Phys. Rev. D 10, 2445. See for example Gattringer and Lang, Eq. (3.93). More...

#include <WilsonGaugeAction.h>

Inheritance diagram for WilsonGaugeAction< Gimpl >:

Public Member Functions
	INHERIT_GIMPL_TYPES (Gimpl)
	All attributes of the gauge implementation are available from the action. See GaugeImplTypes.h.
Timing methods
void	reset_timer (void)
	Zero timers associated with this action.
void	deriv_log (RealD nrm, RealD max, RealD Fdt_nrm, RealD Fdt_max)
	Record statistics on the action and derivative.
RealD	deriv_max_average (void)
	Mean maximum derivative for a trajectory.
RealD	deriv_norm_average (void)
	Mean (absolute value of) derivative for a trajectory.
RealD	Fdt_max_average (void)
	Mean maximum value of impulse (force integrated over a time step) for a trajectory.
RealD	Fdt_norm_average (void)
	Mean (absolute value of) impulse (force integrated over a time step) for a trajectory.
RealD	deriv_timer (void)
	Time spent computing the derivative in microseconds.
RealD	S_timer (void)
	Time spent computing the action in microseconds.
RealD	refresh_timer (void)
	Time spent refreshing pseudofermion fields in microseconds.
void	deriv_timer_start (void)
	Start timing derivative computation.
void	deriv_timer_stop (void)
	Stop timing derivative computation.
void	refresh_timer_start (void)
	Start timing pseudofermion field refresh.
void	refresh_timer_stop (void)
	Stop timing pseudofermion field refresh.
void	S_timer_start (void)
	Start timing action computation.
void	S_timer_stop (void)
	Stop timing action computation.
Methods working on plain gauge fields
virtual void	refresh (const GaugeField &U, GridSerialRNG &sRNG, GridParallelRNG &pRNG)=0
	Refresh pseudofermion fields.
virtual RealD	S (const GaugeField &U)=0
	Evaluate this action with the given gauge field.
virtual RealD	Sinitial (const GaugeField &U)
	Get the action at the start of the trajectory.
virtual void	deriv (const GaugeField &U, GaugeField &dSdU)=0
Logging
virtual std::string	action_name ()=0
	Report the name of the action.
virtual std::string	LogParameters ()=0
	Print the parameters of the action.

Data Fields
bool	is_smeared
	Is the action computed on a smeared gauge field.
RealD	deriv_norm_sum
	Accumulator for absolute value of derivative of action.
RealD	deriv_max_sum
	Accumulator for maximum value of derivative of action.
RealD	Fdt_norm_sum
	Accumulator for absolute value of impulse (force integrated over time step).
RealD	Fdt_max_sum
	Accumulator for maximum impulse (force integrated over time step).
int	deriv_num
	Number of times deriv_log() has been called.
RealD	deriv_us
	Time spent computing the derivative in microseconds.
RealD	S_us
	Time spent computing the action in microseconds.
RealD	refresh_us
	Time spent refreshing pseudofermion fields in microseconds.

Detailed Description

template<class Gimpl>
class WilsonGaugeAction< Gimpl >

The Wilson gauge action, as introduced in Wilson, Phys. Rev. D 10, 2445. See for example Gattringer and Lang, Eq. (3.93).

Expects a single parameter encoding the gauge coupling.

Parameters

Gimpl The gauge implementation.

Definition at line 47 of file WilsonGaugeAction.h.

Member Function Documentation

◆ INHERIT_GIMPL_TYPES()

template<class Gimpl>

WilsonGaugeAction< Gimpl >::INHERIT_GIMPL_TYPES ( Gimpl )

All attributes of the gauge implementation are available from the action. See GaugeImplTypes.h.

◆ reset_timer()

void Action< GaugeField >::reset_timer ( void )

inlineinherited

Zero timers associated with this action.

Definition at line 79 of file ActionBase.h.

◆ deriv_log()

void Action< GaugeField >::deriv_log	(	RealD	nrm,
		RealD	max,
		RealD	Fdt_nrm,
		RealD	Fdt_max )

inlineinherited

Record statistics on the action and derivative.

Parameters

[in]	nrm	Absolute value of the action.
[in]	max	Maximum value of the action.
[in]	Fdt_nrm	Absolute value of the force integrated across this time step.
[in]	Fdt_max	Maximum value of the force integrated across this time step.

Definition at line 91 of file ActionBase.h.

◆ deriv_max_average()

RealD Action< GaugeField >::deriv_max_average ( void )

inlineinherited

Mean maximum derivative for a trajectory.

Definition at line 102 of file ActionBase.h.

◆ deriv_norm_average()

RealD Action< GaugeField >::deriv_norm_average ( void )

inlineinherited

Mean (absolute value of) derivative for a trajectory.

Definition at line 104 of file ActionBase.h.

◆ Fdt_max_average()

RealD Action< GaugeField >::Fdt_max_average ( void )

inlineinherited

Mean maximum value of impulse (force integrated over a time step) for a trajectory.

Definition at line 106 of file ActionBase.h.

◆ Fdt_norm_average()

RealD Action< GaugeField >::Fdt_norm_average ( void )

inlineinherited

Mean (absolute value of) impulse (force integrated over a time step) for a trajectory.

Definition at line 108 of file ActionBase.h.

◆ deriv_timer()

RealD Action< GaugeField >::deriv_timer ( void )

inlineinherited

Time spent computing the derivative in microseconds.

Definition at line 110 of file ActionBase.h.

◆ S_timer()

RealD Action< GaugeField >::S_timer ( void )

inlineinherited

Time spent computing the action in microseconds.

Definition at line 112 of file ActionBase.h.

◆ refresh_timer()

RealD Action< GaugeField >::refresh_timer ( void )

inlineinherited

Time spent refreshing pseudofermion fields in microseconds.

Definition at line 114 of file ActionBase.h.

◆ deriv_timer_start()

void Action< GaugeField >::deriv_timer_start ( void )

inlineinherited

Start timing derivative computation.

Definition at line 116 of file ActionBase.h.

◆ deriv_timer_stop()

void Action< GaugeField >::deriv_timer_stop ( void )

inlineinherited

Stop timing derivative computation.

Definition at line 118 of file ActionBase.h.

◆ refresh_timer_start()

void Action< GaugeField >::refresh_timer_start ( void )

inlineinherited

Start timing pseudofermion field refresh.

Definition at line 120 of file ActionBase.h.

◆ refresh_timer_stop()

void Action< GaugeField >::refresh_timer_stop ( void )

inlineinherited

Stop timing pseudofermion field refresh.

Definition at line 122 of file ActionBase.h.

◆ S_timer_start()

void Action< GaugeField >::S_timer_start ( void )

inlineinherited

Start timing action computation.

Definition at line 124 of file ActionBase.h.

◆ S_timer_stop()

void Action< GaugeField >::S_timer_stop ( void )

inlineinherited

Stop timing action computation.

Definition at line 126 of file ActionBase.h.

◆ refresh()

virtual void Action< GaugeField >::refresh	(	const GaugeField &	U,
		GridSerialRNG &	sRNG,
		GridParallelRNG &	pRNG )

pure virtualinherited

Refresh pseudofermion fields.

Parameters

[in]	U	The gauge field
[in,out]	sRNG	The serial random number generator to use
[in,out]	pRNG	The parallel random number generator to use

Implemented in JacobianAction< Gimpl >, and PlaqPlusRectangleAction< Gimpl >.

◆ S()

virtual RealD Action< GaugeField >::S ( const GaugeField & U )

pure virtualinherited

Evaluate this action with the given gauge field.

Parameters

[in] U The gauge field to evaluate the action of.

Returns: The value of the action

Implemented in JacobianAction< Gimpl >, and PlaqPlusRectangleAction< Gimpl >.

◆ Sinitial()

virtual RealD Action< GaugeField >::Sinitial ( const GaugeField & U )

inlinevirtualinherited

Get the action at the start of the trajectory.

If the refresh computes the action, it can be cached so that the value at the start of a Monte Carlo trajectory can be used mid-trajectory.

Parameters

[in] U The gauge field.

Returns: The value of the action , potentially as previously cached.

Definition at line 157 of file ActionBase.h.

◆ deriv()

virtual void Action< GaugeField >::deriv	(	const GaugeField &	U,
		GaugeField &	dSdU )

pure virtualinherited

Evaluate the derivative of the action, to be integrated in the molecular dynamics part of the HMC.

Parameters

[in]	U	The gauge field to compute the action's derivative on.
[out]	dSdU	Array into which to output the resulting derivative.

Implemented in JacobianAction< Gimpl >, and PlaqPlusRectangleAction< Gimpl >.

◆ action_name()

virtual std::string Action< GaugeField >::action_name ( )

pure virtualinherited

Report the name of the action.

Implemented in DBW2GaugeAction< Gimpl >, IwasakiGaugeAction< Gimpl >, IwasakiGaugeAction< ConjugateGimplD >, IwasakiGaugeAction< ConjugateGimplF >, IwasakiGaugeAction< ConjugateGimplR >, IwasakiGaugeAction< PeriodicGimplD >, IwasakiGaugeAction< PeriodicGimplF >, IwasakiGaugeAction< PeriodicGimplR >, JacobianAction< Gimpl >, PlaqPlusRectangleAction< Gimpl >, RBCGaugeAction< Gimpl >, SymanzikGaugeAction< Gimpl >, SymanzikGaugeAction< ConjugateGimplD >, SymanzikGaugeAction< ConjugateGimplF >, SymanzikGaugeAction< ConjugateGimplR >, SymanzikGaugeAction< PeriodicGimplD >, SymanzikGaugeAction< PeriodicGimplF >, and SymanzikGaugeAction< PeriodicGimplR >.

◆ LogParameters()

virtual std::string Action< GaugeField >::LogParameters ( )

pure virtualinherited

Print the parameters of the action.

Implemented in JacobianAction< Gimpl >, and PlaqPlusRectangleAction< Gimpl >.

Field Documentation

◆ is_smeared

bool Action< GaugeField >::is_smeared

inherited

Is the action computed on a smeared gauge field.

Definition at line 66 of file ActionBase.h.

◆ deriv_norm_sum

RealD Action< GaugeField >::deriv_norm_sum

inherited

Accumulator for absolute value of derivative of action.

Definition at line 67 of file ActionBase.h.

◆ deriv_max_sum

RealD Action< GaugeField >::deriv_max_sum

inherited

Accumulator for maximum value of derivative of action.

Definition at line 68 of file ActionBase.h.

◆ Fdt_norm_sum

RealD Action< GaugeField >::Fdt_norm_sum

inherited

Accumulator for absolute value of impulse (force integrated over time step).

Definition at line 69 of file ActionBase.h.

◆ Fdt_max_sum

RealD Action< GaugeField >::Fdt_max_sum

inherited

Accumulator for maximum impulse (force integrated over time step).

Definition at line 70 of file ActionBase.h.

◆ deriv_num

int Action< GaugeField >::deriv_num

inherited

Number of times deriv_log() has been called.

Definition at line 71 of file ActionBase.h.

◆ deriv_us

RealD Action< GaugeField >::deriv_us

inherited

Time spent computing the derivative in microseconds.

Definition at line 72 of file ActionBase.h.

◆ S_us

RealD Action< GaugeField >::S_us

inherited

Time spent computing the action in microseconds.

Definition at line 73 of file ActionBase.h.

◆ refresh_us

RealD Action< GaugeField >::refresh_us

inherited

Time spent refreshing pseudofermion fields in microseconds.

Definition at line 74 of file ActionBase.h.

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

Grid/qcd/action/gauge/WilsonGaugeAction.h

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ INHERIT_GIMPL_TYPES()

◆ reset_timer()

◆ deriv_log()

◆ deriv_max_average()

◆ deriv_norm_average()

◆ Fdt_max_average()

◆ Fdt_norm_average()

◆ deriv_timer()

◆ S_timer()

◆ refresh_timer()

◆ deriv_timer_start()

◆ deriv_timer_stop()

◆ refresh_timer_start()

◆ refresh_timer_stop()

◆ S_timer_start()

◆ S_timer_stop()

◆ refresh()

◆ S()

◆ Sinitial()

◆ deriv()

◆ action_name()

◆ LogParameters()

Field Documentation

◆ is_smeared

◆ deriv_norm_sum

◆ deriv_max_sum

◆ Fdt_norm_sum

◆ Fdt_max_sum

◆ deriv_num

◆ deriv_us

◆ S_us

◆ refresh_us