Grid 0.7.0
TwoFlavourRatioEO4DPseudoFermionAction< Impl > Class Template Reference

#include <TwoFlavourRatioEO4DPseudoFermion.h>

Inheritance diagram for TwoFlavourRatioEO4DPseudoFermionAction< Impl >:
Action< Impl::GaugeField >

Public Member Functions

 INHERIT_IMPL_TYPES (Impl)
 TwoFlavourRatioEO4DPseudoFermionAction (FermionOperator< Impl > &_NumOp, FermionOperator< Impl > &_DenOp, OperatorFunction< FermionField > &DS, OperatorFunction< FermionField > &AS)
 TwoFlavourRatioEO4DPseudoFermionAction (FermionOperator< Impl > &_NumOp, FermionOperator< Impl > &_DenOp, OperatorFunction< FermionField > &DS, OperatorFunction< FermionField > &DDS, OperatorFunction< FermionField > &AS, OperatorFunction< FermionField > &HS)
virtual std::string action_name ()
 Report the name of the action.
virtual std::string LogParameters ()
 Print the parameters of the action.
virtual void refresh (const GaugeField &U, GridSerialRNG &sRNG, GridParallelRNG &pRNG)
 Refresh pseudofermion fields.
virtual RealD S (const GaugeField &U)
 Evaluate this action with the given gauge field.
virtual void deriv (const GaugeField &U, GaugeField &dSdU)
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 RealD Sinitial (const GaugeField &U)
 Get the action at the start of the trajectory.

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.

Private Types

typedef FermionOperator< Impl > FermOp

Private Attributes

FermionOperator< Impl > & NumOp
FermionOperator< Impl > & DenOp
OperatorFunction< FermionField > & DerivativeSolver
OperatorFunction< FermionField > & DerivativeDagSolver
OperatorFunction< FermionField > & ActionSolver
OperatorFunction< FermionField > & HeatbathSolver
FermionField phi4

Detailed Description

template<class Impl>
class TwoFlavourRatioEO4DPseudoFermionAction< Impl >

Definition at line 38 of file TwoFlavourRatioEO4DPseudoFermion.h.

Member Typedef Documentation

◆ FermOp

template<class Impl>
typedef FermionOperator<Impl> TwoFlavourRatioEO4DPseudoFermionAction< Impl >::FermOp
private

Definition at line 43 of file TwoFlavourRatioEO4DPseudoFermion.h.

Constructor & Destructor Documentation

◆ TwoFlavourRatioEO4DPseudoFermionAction() [1/2]

template<class Impl>
TwoFlavourRatioEO4DPseudoFermionAction< Impl >::TwoFlavourRatioEO4DPseudoFermionAction ( FermionOperator< Impl > & _NumOp,
FermionOperator< Impl > & _DenOp,
OperatorFunction< FermionField > & DS,
OperatorFunction< FermionField > & AS )
inline

Definition at line 55 of file TwoFlavourRatioEO4DPseudoFermion.h.

References TwoFlavourRatioEO4DPseudoFermionAction().

Referenced by TwoFlavourRatioEO4DPseudoFermionAction().

◆ TwoFlavourRatioEO4DPseudoFermionAction() [2/2]

template<class Impl>
TwoFlavourRatioEO4DPseudoFermionAction< Impl >::TwoFlavourRatioEO4DPseudoFermionAction ( FermionOperator< Impl > & _NumOp,
FermionOperator< Impl > & _DenOp,
OperatorFunction< FermionField > & DS,
OperatorFunction< FermionField > & DDS,
OperatorFunction< FermionField > & AS,
OperatorFunction< FermionField > & HS )
inline

Definition at line 60 of file TwoFlavourRatioEO4DPseudoFermion.h.

References ActionSolver, DenOp, DerivativeDagSolver, DerivativeSolver, HeatbathSolver, NumOp, and phi4.

Member Function Documentation

◆ INHERIT_IMPL_TYPES()

template<class Impl>
TwoFlavourRatioEO4DPseudoFermionAction< Impl >::INHERIT_IMPL_TYPES ( Impl )

◆ action_name()

template<class Impl>
virtual std::string TwoFlavourRatioEO4DPseudoFermionAction< Impl >::action_name ( )
inlinevirtual

Report the name of the action.

Implements Action< Impl::GaugeField >.

Definition at line 75 of file TwoFlavourRatioEO4DPseudoFermion.h.

Referenced by LogParameters().

◆ LogParameters()

template<class Impl>
virtual std::string TwoFlavourRatioEO4DPseudoFermionAction< Impl >::LogParameters ( )
inlinevirtual

Print the parameters of the action.

Implements Action< Impl::GaugeField >.

Definition at line 77 of file TwoFlavourRatioEO4DPseudoFermion.h.

References action_name(), and GridLogMessage.

◆ refresh()

template<class Impl>
virtual void TwoFlavourRatioEO4DPseudoFermionAction< Impl >::refresh ( const GaugeField & U,
GridSerialRNG & sRNG,
GridParallelRNG & pRNG )
inlinevirtual

Refresh pseudofermion fields.

Parameters
[in]UThe gauge field
[in,out]sRNGThe serial random number generator to use
[in,out]pRNGThe parallel random number generator to use

Implements Action< Impl::GaugeField >.

Definition at line 83 of file TwoFlavourRatioEO4DPseudoFermion.h.

References DenOp, gaussian(), GridLogMessage, HeatbathSolver, norm2(), NumOp, phi4, and U.

◆ S()

template<class Impl>
virtual RealD TwoFlavourRatioEO4DPseudoFermionAction< Impl >::S ( const GaugeField & U)
inlinevirtual

Evaluate this action with the given gauge field.

Parameters
[in]UThe gauge field to evaluate the action of.
Returns
The value of the action $S[U]$

Implements Action< Impl::GaugeField >.

Definition at line 124 of file TwoFlavourRatioEO4DPseudoFermion.h.

References ActionSolver, DenOp, norm2(), NumOp, phi4, and U.

◆ deriv()

template<class Impl>
virtual void TwoFlavourRatioEO4DPseudoFermionAction< Impl >::deriv ( const GaugeField & U,
GaugeField & dSdU )
inlinevirtual

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

Parameters
[in]UThe gauge field to compute the action's derivative on.
[out]dSdUArray into which to output the resulting derivative.

Implements Action< Impl::GaugeField >.

Definition at line 151 of file TwoFlavourRatioEO4DPseudoFermion.h.

References DaggerNo, DaggerYes, DenOp, DerivativeDagSolver, DerivativeSolver, GridLogMessage, norm2(), NumOp, phi4, and U.

◆ 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]nrmAbsolute value of the action.
[in]maxMaximum value of the action.
[in]Fdt_nrmAbsolute value of the force integrated across this time step.
[in]Fdt_maxMaximum 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.

◆ 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]UThe gauge field.
Returns
The value of the action $S[U]$, potentially as previously cached.

Reimplemented in GeneralEvenOddRatioRationalPseudoFermionAction< Impl >, and TwoFlavourEvenOddRatioPseudoFermionAction< Impl >.

Definition at line 157 of file ActionBase.h.

Field Documentation

◆ NumOp

template<class Impl>
FermionOperator<Impl>& TwoFlavourRatioEO4DPseudoFermionAction< Impl >::NumOp
private

Definition at line 44 of file TwoFlavourRatioEO4DPseudoFermion.h.

Referenced by deriv(), refresh(), S(), and TwoFlavourRatioEO4DPseudoFermionAction().

◆ DenOp

template<class Impl>
FermionOperator<Impl>& TwoFlavourRatioEO4DPseudoFermionAction< Impl >::DenOp
private

Definition at line 45 of file TwoFlavourRatioEO4DPseudoFermion.h.

Referenced by deriv(), refresh(), S(), and TwoFlavourRatioEO4DPseudoFermionAction().

◆ DerivativeSolver

template<class Impl>
OperatorFunction<FermionField>& TwoFlavourRatioEO4DPseudoFermionAction< Impl >::DerivativeSolver
private

Definition at line 47 of file TwoFlavourRatioEO4DPseudoFermion.h.

Referenced by deriv(), and TwoFlavourRatioEO4DPseudoFermionAction().

◆ DerivativeDagSolver

template<class Impl>
OperatorFunction<FermionField>& TwoFlavourRatioEO4DPseudoFermionAction< Impl >::DerivativeDagSolver
private

Definition at line 48 of file TwoFlavourRatioEO4DPseudoFermion.h.

Referenced by deriv(), and TwoFlavourRatioEO4DPseudoFermionAction().

◆ ActionSolver

template<class Impl>
OperatorFunction<FermionField>& TwoFlavourRatioEO4DPseudoFermionAction< Impl >::ActionSolver
private

Definition at line 49 of file TwoFlavourRatioEO4DPseudoFermion.h.

Referenced by S(), and TwoFlavourRatioEO4DPseudoFermionAction().

◆ HeatbathSolver

template<class Impl>
OperatorFunction<FermionField>& TwoFlavourRatioEO4DPseudoFermionAction< Impl >::HeatbathSolver
private

Definition at line 50 of file TwoFlavourRatioEO4DPseudoFermion.h.

Referenced by refresh(), and TwoFlavourRatioEO4DPseudoFermionAction().

◆ phi4

template<class Impl>
FermionField TwoFlavourRatioEO4DPseudoFermionAction< Impl >::phi4
private

Definition at line 52 of file TwoFlavourRatioEO4DPseudoFermion.h.

Referenced by deriv(), refresh(), S(), and TwoFlavourRatioEO4DPseudoFermionAction().

◆ 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: