Grid 0.7.0
ExactOneFlavourRatioPseudoFermionAction< Impl > Class Template Reference

#include <ExactOneFlavourRatio.h>

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

Public Types

typedef OneFlavourRationalParams Params

Public Member Functions

 INHERIT_IMPL_TYPES (Impl)
virtual void heatbathRefreshShiftCoefficients (int LorR, RealD to)
 ExactOneFlavourRatioPseudoFermionAction (AbstractEOFAFermion< Impl > &_Lop, AbstractEOFAFermion< Impl > &_Rop, OperatorFunction< FermionField > &CG, Params &p, bool use_fc=false)
 ExactOneFlavourRatioPseudoFermionAction (AbstractEOFAFermion< Impl > &_Lop, AbstractEOFAFermion< Impl > &_Rop, OperatorFunction< FermionField > &HeatbathCG, OperatorFunction< FermionField > &ActionCGL, OperatorFunction< FermionField > &ActionCGR, OperatorFunction< FermionField > &DerivCGL, OperatorFunction< FermionField > &DerivCGR, Params &p, bool use_fc=false)
 ExactOneFlavourRatioPseudoFermionAction (AbstractEOFAFermion< Impl > &_Lop, AbstractEOFAFermion< Impl > &_Rop, OperatorFunction< FermionField > &HeatbathCGL, OperatorFunction< FermionField > &HeatbathCGR, OperatorFunction< FermionField > &ActionCGL, OperatorFunction< FermionField > &ActionCGR, OperatorFunction< FermionField > &DerivCGL, OperatorFunction< FermionField > &DerivCGR, Params &p, bool use_fc=false)
const FermionField & getPhi () const
virtual std::string action_name ()
 Report the name of the action.
virtual std::string LogParameters ()
 Print the parameters of the action.
void spProj (const FermionField &in, FermionField &out, int sign, int Ls)
virtual void refresh (const GaugeField &U, GridSerialRNG &sRNG, GridParallelRNG &pRNG)
 Refresh pseudofermion fields.
void refresh (const GaugeField &U, const FermionField &eta)
void Meofa (const GaugeField &U, const FermionField &in, FermionField &out)
void MeofaInv (const GaugeField &U, const FermionField &in, FermionField &out)
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

Params param
MultiShiftFunction PowerNegHalf
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 Attributes

bool use_heatbath_forecasting
AbstractEOFAFermion< Impl > & Lop
AbstractEOFAFermion< Impl > & Rop
SchurRedBlackDiagMooeeSolve< FermionField > SolverHBL
SchurRedBlackDiagMooeeSolve< FermionField > SolverHBR
SchurRedBlackDiagMooeeSolve< FermionField > SolverL
SchurRedBlackDiagMooeeSolve< FermionField > SolverR
SchurRedBlackDiagMooeeSolve< FermionField > DerivativeSolverL
SchurRedBlackDiagMooeeSolve< FermionField > DerivativeSolverR
FermionField Phi
RealD norm2_eta
bool initial_action

Detailed Description

template<class Impl>
class ExactOneFlavourRatioPseudoFermionAction< Impl >

Definition at line 52 of file ExactOneFlavourRatio.h.

Member Typedef Documentation

◆ Params

template<class Impl>
typedef OneFlavourRationalParams ExactOneFlavourRatioPseudoFermionAction< Impl >::Params

Definition at line 56 of file ExactOneFlavourRatio.h.

Constructor & Destructor Documentation

◆ ExactOneFlavourRatioPseudoFermionAction() [1/3]

template<class Impl>
ExactOneFlavourRatioPseudoFermionAction< Impl >::ExactOneFlavourRatioPseudoFermionAction ( AbstractEOFAFermion< Impl > & _Lop,
AbstractEOFAFermion< Impl > & _Rop,
OperatorFunction< FermionField > & CG,
Params & p,
bool use_fc = false )
inline

Definition at line 84 of file ExactOneFlavourRatio.h.

References ExactOneFlavourRatioPseudoFermionAction().

Referenced by ExactOneFlavourRatioPseudoFermionAction(), and ExactOneFlavourRatioPseudoFermionAction().

◆ ExactOneFlavourRatioPseudoFermionAction() [2/3]

template<class Impl>
ExactOneFlavourRatioPseudoFermionAction< Impl >::ExactOneFlavourRatioPseudoFermionAction ( AbstractEOFAFermion< Impl > & _Lop,
AbstractEOFAFermion< Impl > & _Rop,
OperatorFunction< FermionField > & HeatbathCG,
OperatorFunction< FermionField > & ActionCGL,
OperatorFunction< FermionField > & ActionCGR,
OperatorFunction< FermionField > & DerivCGL,
OperatorFunction< FermionField > & DerivCGR,
Params & p,
bool use_fc = false )
inline

Definition at line 92 of file ExactOneFlavourRatio.h.

References ExactOneFlavourRatioPseudoFermionAction().

◆ ExactOneFlavourRatioPseudoFermionAction() [3/3]

template<class Impl>
ExactOneFlavourRatioPseudoFermionAction< Impl >::ExactOneFlavourRatioPseudoFermionAction ( AbstractEOFAFermion< Impl > & _Lop,
AbstractEOFAFermion< Impl > & _Rop,
OperatorFunction< FermionField > & HeatbathCGL,
OperatorFunction< FermionField > & HeatbathCGR,
OperatorFunction< FermionField > & ActionCGL,
OperatorFunction< FermionField > & ActionCGR,
OperatorFunction< FermionField > & DerivCGL,
OperatorFunction< FermionField > & DerivCGR,
Params & p,
bool use_fc = false )
inline

Definition at line 102 of file ExactOneFlavourRatio.h.

References DerivativeSolverL, DerivativeSolverR, AlgRemez::generateApprox(), GridLogMessage, initial_action, Lop, param, Phi, PowerNegHalf, Rop, SolverHBL, SolverHBR, SolverL, SolverR, and use_heatbath_forecasting.

Member Function Documentation

◆ INHERIT_IMPL_TYPES()

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

◆ heatbathRefreshShiftCoefficients()

template<class Impl>
virtual void ExactOneFlavourRatioPseudoFermionAction< Impl >::heatbathRefreshShiftCoefficients ( int LorR,
RealD to )
inlinevirtual

Reimplemented in ExactOneFlavourRatioMixedPrecHeatbathPseudoFermionAction< ImplD, ImplF >.

Definition at line 77 of file ExactOneFlavourRatio.h.

References Lop, AbstractEOFAFermion< Impl >::RefreshShiftCoefficients(), and Rop.

Referenced by ExactOneFlavourRatioMixedPrecHeatbathPseudoFermionAction< ImplD, ImplF >::heatbathRefreshShiftCoefficients(), MeofaInv(), and refresh().

◆ getPhi()

template<class Impl>
const FermionField & ExactOneFlavourRatioPseudoFermionAction< Impl >::getPhi ( ) const
inline

Definition at line 127 of file ExactOneFlavourRatio.h.

References Phi.

◆ action_name()

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

Report the name of the action.

Implements Action< Impl::GaugeField >.

Reimplemented in ExactOneFlavourRatioMixedPrecHeatbathPseudoFermionAction< ImplD, ImplF >.

Definition at line 129 of file ExactOneFlavourRatio.h.

Referenced by LogParameters(), and S().

◆ LogParameters()

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

Print the parameters of the action.

Implements Action< Impl::GaugeField >.

Definition at line 131 of file ExactOneFlavourRatio.h.

References action_name(), GridLogMessage, and param.

◆ spProj()

template<class Impl>
void ExactOneFlavourRatioPseudoFermionAction< Impl >::spProj ( const FermionField & in,
FermionField & out,
int sign,
int Ls )
inline

Definition at line 143 of file ExactOneFlavourRatio.h.

References axpby_ssp_pminus(), and axpby_ssp_pplus().

Referenced by deriv(), Meofa(), MeofaInv(), refresh(), and S().

◆ refresh() [1/2]

template<class Impl>
virtual void ExactOneFlavourRatioPseudoFermionAction< 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 149 of file ExactOneFlavourRatio.h.

References gaussian(), Lop, refresh(), and U.

Referenced by refresh().

◆ refresh() [2/2]

template<class Impl>
void ExactOneFlavourRatioPseudoFermionAction< Impl >::refresh ( const GaugeField & U,
const FermionField & eta )
inline

Definition at line 169 of file ExactOneFlavourRatio.h.

References G5R5(), heatbathRefreshShiftCoefficients(), initial_action, Lop, norm2(), norm2_eta, param, Phi, PowerNegHalf, Rop, SolverHBL, SolverHBR, spProj(), U, and use_heatbath_forecasting.

◆ Meofa()

template<class Impl>
void ExactOneFlavourRatioPseudoFermionAction< Impl >::Meofa ( const GaugeField & U,
const FermionField & in,
FermionField & out )
inline

Definition at line 258 of file ExactOneFlavourRatio.h.

References G5R5(), Lop, Rop, SolverL, SolverR, spProj(), and U.

◆ MeofaInv()

template<class Impl>
void ExactOneFlavourRatioPseudoFermionAction< Impl >::MeofaInv ( const GaugeField & U,
const FermionField & in,
FermionField & out )
inline

Definition at line 296 of file ExactOneFlavourRatio.h.

References G5R5(), heatbathRefreshShiftCoefficients(), Lop, Rop, SolverHBL, SolverHBR, spProj(), and U.

◆ S()

template<class Impl>
virtual RealD ExactOneFlavourRatioPseudoFermionAction< 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 355 of file ExactOneFlavourRatio.h.

References action_name(), G5R5(), GridLogMessage, initial_action, innerProduct(), Lop, norm2(), norm2_eta, param, Phi, Rop, SolverL, SolverR, spProj(), and U.

◆ deriv()

template<class Impl>
virtual void ExactOneFlavourRatioPseudoFermionAction< 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 411 of file ExactOneFlavourRatio.h.

References DaggerNo, DerivativeSolverL, DerivativeSolverR, G5R5(), Lop, Phi, Rop, spProj(), 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

◆ param

template<class Impl>
Params ExactOneFlavourRatioPseudoFermionAction< Impl >::param

Definition at line 57 of file ExactOneFlavourRatio.h.

Referenced by ExactOneFlavourRatioPseudoFermionAction(), LogParameters(), refresh(), and S().

◆ PowerNegHalf

template<class Impl>
MultiShiftFunction ExactOneFlavourRatioPseudoFermionAction< Impl >::PowerNegHalf

Definition at line 58 of file ExactOneFlavourRatio.h.

Referenced by ExactOneFlavourRatioPseudoFermionAction(), and refresh().

◆ use_heatbath_forecasting

template<class Impl>
bool ExactOneFlavourRatioPseudoFermionAction< Impl >::use_heatbath_forecasting
private

Definition at line 61 of file ExactOneFlavourRatio.h.

Referenced by ExactOneFlavourRatioPseudoFermionAction(), and refresh().

◆ Lop

template<class Impl>
AbstractEOFAFermion<Impl>& ExactOneFlavourRatioPseudoFermionAction< Impl >::Lop
private

Definition at line 62 of file ExactOneFlavourRatio.h.

Referenced by deriv(), ExactOneFlavourRatioPseudoFermionAction(), heatbathRefreshShiftCoefficients(), Meofa(), MeofaInv(), refresh(), refresh(), and S().

◆ Rop

template<class Impl>
AbstractEOFAFermion<Impl>& ExactOneFlavourRatioPseudoFermionAction< Impl >::Rop
private

Definition at line 63 of file ExactOneFlavourRatio.h.

Referenced by deriv(), ExactOneFlavourRatioPseudoFermionAction(), heatbathRefreshShiftCoefficients(), Meofa(), MeofaInv(), refresh(), and S().

◆ SolverHBL

template<class Impl>
SchurRedBlackDiagMooeeSolve<FermionField> ExactOneFlavourRatioPseudoFermionAction< Impl >::SolverHBL
private

Definition at line 64 of file ExactOneFlavourRatio.h.

Referenced by ExactOneFlavourRatioPseudoFermionAction(), MeofaInv(), and refresh().

◆ SolverHBR

template<class Impl>
SchurRedBlackDiagMooeeSolve<FermionField> ExactOneFlavourRatioPseudoFermionAction< Impl >::SolverHBR
private

Definition at line 65 of file ExactOneFlavourRatio.h.

Referenced by ExactOneFlavourRatioPseudoFermionAction(), MeofaInv(), and refresh().

◆ SolverL

template<class Impl>
SchurRedBlackDiagMooeeSolve<FermionField> ExactOneFlavourRatioPseudoFermionAction< Impl >::SolverL
private

Definition at line 66 of file ExactOneFlavourRatio.h.

Referenced by ExactOneFlavourRatioPseudoFermionAction(), Meofa(), and S().

◆ SolverR

template<class Impl>
SchurRedBlackDiagMooeeSolve<FermionField> ExactOneFlavourRatioPseudoFermionAction< Impl >::SolverR
private

Definition at line 67 of file ExactOneFlavourRatio.h.

Referenced by ExactOneFlavourRatioPseudoFermionAction(), Meofa(), and S().

◆ DerivativeSolverL

template<class Impl>
SchurRedBlackDiagMooeeSolve<FermionField> ExactOneFlavourRatioPseudoFermionAction< Impl >::DerivativeSolverL
private

Definition at line 68 of file ExactOneFlavourRatio.h.

Referenced by deriv(), and ExactOneFlavourRatioPseudoFermionAction().

◆ DerivativeSolverR

template<class Impl>
SchurRedBlackDiagMooeeSolve<FermionField> ExactOneFlavourRatioPseudoFermionAction< Impl >::DerivativeSolverR
private

Definition at line 69 of file ExactOneFlavourRatio.h.

Referenced by deriv(), and ExactOneFlavourRatioPseudoFermionAction().

◆ Phi

template<class Impl>
FermionField ExactOneFlavourRatioPseudoFermionAction< Impl >::Phi
private

Definition at line 70 of file ExactOneFlavourRatio.h.

Referenced by deriv(), ExactOneFlavourRatioPseudoFermionAction(), getPhi(), refresh(), and S().

◆ norm2_eta

template<class Impl>
RealD ExactOneFlavourRatioPseudoFermionAction< Impl >::norm2_eta
private

Definition at line 72 of file ExactOneFlavourRatio.h.

Referenced by refresh(), and S().

◆ initial_action

template<class Impl>
bool ExactOneFlavourRatioPseudoFermionAction< Impl >::initial_action
private

Definition at line 73 of file ExactOneFlavourRatio.h.

Referenced by ExactOneFlavourRatioPseudoFermionAction(), refresh(), and S().

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