Grid 0.7.0
GeneralEvenOddRatioRationalPseudoFermionAction< Impl > Class Template Reference

#include <GeneralEvenOddRationalRatio.h>

Inheritance diagram for GeneralEvenOddRatioRationalPseudoFermionAction< Impl >:
Action< Impl::GaugeField > GeneralEvenOddRatioRationalMixedPrecPseudoFermionAction< Impl, ImplF > OneFlavourEvenOddRatioRationalPseudoFermionAction< Impl > OneFlavourEvenOddRatioRationalMixedPrecPseudoFermionAction< Impl, ImplF >

Public Types

typedef RationalActionParams Params

Public Member Functions

 INHERIT_IMPL_TYPES (Impl)
void SetTolerances (std::vector< RealD > action_tolerance, std::vector< RealD > md_tolerance)
 GeneralEvenOddRatioRationalPseudoFermionAction (FermionOperator< Impl > &_NumOp, FermionOperator< Impl > &_DenOp, const Params &p)
virtual std::string action_name ()
 Report the name of the action.
virtual std::string LogParameters ()
 Print the parameters of the action.
const FermionField & getPhiOdd () const
virtual void refresh (const GaugeField &U, GridSerialRNG &sRNG, GridParallelRNG &pRNG)
 Refresh pseudofermion fields.
void refresh (const GaugeField &U, const FermionField &eta)
virtual RealD Sinitial (const GaugeField &U)
 Get the action at the start of the trajectory.
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.

Data Fields

Params param
RealD RefreshAction
MultiShiftFunction ApproxPowerAction
MultiShiftFunction ApproxNegPowerAction
MultiShiftFunction ApproxHalfPowerAction
MultiShiftFunction ApproxNegHalfPowerAction
MultiShiftFunction ApproxPowerMD
MultiShiftFunction ApproxNegPowerMD
MultiShiftFunction ApproxHalfPowerMD
MultiShiftFunction ApproxNegHalfPowerMD
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.

Protected Member Functions

virtual void multiShiftInverse (bool numerator, const MultiShiftFunction &approx, const Integer MaxIter, const FermionField &in, FermionField &out)
virtual void multiShiftInverse (bool numerator, const MultiShiftFunction &approx, const Integer MaxIter, const FermionField &in, std::vector< FermionField > &out_elems, FermionField &out)
virtual void ImportGauge (const GaugeField &U)

Static Protected Attributes

static constexpr bool Numerator
static constexpr bool Denominator

Static Private Member Functions

static void generateApprox (MultiShiftFunction &approx, MultiShiftFunction &approx_inv, int inv_pow, int approx_degree, double CG_tolerance, AlgRemez &remez)

Private Attributes

FermionOperator< Impl > & NumOp
FermionOperator< Impl > & DenOp
FermionField PhiEven
FermionField PhiOdd

Detailed Description

template<class Impl>
class GeneralEvenOddRatioRationalPseudoFermionAction< Impl >

Definition at line 55 of file GeneralEvenOddRationalRatio.h.

Member Typedef Documentation

◆ Params

template<class Impl>
typedef RationalActionParams GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::Params

Definition at line 60 of file GeneralEvenOddRationalRatio.h.

Constructor & Destructor Documentation

◆ GeneralEvenOddRatioRationalPseudoFermionAction()

template<class Impl>
GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::GeneralEvenOddRatioRationalPseudoFermionAction ( FermionOperator< Impl > & _NumOp,
FermionOperator< Impl > & _DenOp,
const Params & p )
inline

Definition at line 168 of file GeneralEvenOddRationalRatio.h.

References action_name(), ApproxHalfPowerAction, ApproxHalfPowerMD, ApproxNegHalfPowerAction, ApproxNegHalfPowerMD, ApproxNegPowerAction, ApproxNegPowerMD, ApproxPowerAction, ApproxPowerMD, DenOp, generateApprox(), GridLogMessage, NumOp, param, PhiEven, PhiOdd, and SetTolerances().

Referenced by OneFlavourEvenOddRatioRationalPseudoFermionAction< Impl >::OneFlavourEvenOddRatioRationalPseudoFermionAction().

Member Function Documentation

◆ INHERIT_IMPL_TYPES()

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

◆ generateApprox()

template<class Impl>
void GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::generateApprox ( MultiShiftFunction & approx,
MultiShiftFunction & approx_inv,
int inv_pow,
int approx_degree,
double CG_tolerance,
AlgRemez & remez )
inlinestaticprivate

Definition at line 84 of file GeneralEvenOddRationalRatio.h.

References AlgRemez::generateApprox(), GridLogMessage, and MultiShiftFunction::Init().

Referenced by GeneralEvenOddRatioRationalPseudoFermionAction().

◆ multiShiftInverse() [1/2]

template<class Impl>
virtual void GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::multiShiftInverse ( bool numerator,
const MultiShiftFunction & approx,
const Integer MaxIter,
const FermionField & in,
FermionField & out )
inlineprotectedvirtual

Definition at line 100 of file GeneralEvenOddRationalRatio.h.

References DenOp, and NumOp.

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

◆ multiShiftInverse() [2/2]

template<class Impl>
virtual void GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::multiShiftInverse ( bool numerator,
const MultiShiftFunction & approx,
const Integer MaxIter,
const FermionField & in,
std::vector< FermionField > & out_elems,
FermionField & out )
inlineprotectedvirtual

Definition at line 105 of file GeneralEvenOddRationalRatio.h.

References DenOp, and NumOp.

◆ ImportGauge()

template<class Impl>
virtual void GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::ImportGauge ( const GaugeField & U)
inlineprotectedvirtual

Definition at line 111 of file GeneralEvenOddRationalRatio.h.

References DenOp, NumOp, and U.

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

◆ SetTolerances()

template<class Impl>
void GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::SetTolerances ( std::vector< RealD > action_tolerance,
std::vector< RealD > md_tolerance )
inline

Definition at line 119 of file GeneralEvenOddRationalRatio.h.

References ApproxHalfPowerAction, ApproxHalfPowerMD, ApproxNegHalfPowerAction, ApproxNegHalfPowerMD, ApproxNegPowerAction, ApproxNegPowerMD, ApproxPowerAction, ApproxPowerMD, and GridLogMessage.

Referenced by GeneralEvenOddRatioRationalPseudoFermionAction().

◆ action_name()

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

Report the name of the action.

Implements Action< Impl::GaugeField >.

Reimplemented in GeneralEvenOddRatioRationalMixedPrecPseudoFermionAction< ImplD, ImplF >, GeneralEvenOddRatioRationalMixedPrecPseudoFermionAction< Impl, ImplF >, OneFlavourEvenOddRatioRationalMixedPrecPseudoFermionAction< Impl, ImplF >, and OneFlavourEvenOddRatioRationalPseudoFermionAction< Impl >.

Definition at line 210 of file GeneralEvenOddRationalRatio.h.

Referenced by deriv(), GeneralEvenOddRatioRationalPseudoFermionAction(), LogParameters(), refresh(), refresh(), and S().

◆ LogParameters()

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

Print the parameters of the action.

Implements Action< Impl::GaugeField >.

Definition at line 212 of file GeneralEvenOddRationalRatio.h.

References action_name(), GridLogMessage, and param.

◆ getPhiOdd()

template<class Impl>
const FermionField & GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::getPhiOdd ( ) const
inline

Definition at line 227 of file GeneralEvenOddRationalRatio.h.

References PhiOdd.

◆ refresh() [1/2]

template<class Impl>
virtual void GeneralEvenOddRatioRationalPseudoFermionAction< 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 229 of file GeneralEvenOddRationalRatio.h.

References action_name(), gaussian(), GridLogMessage, NumOp, refresh(), and U.

Referenced by refresh().

◆ refresh() [2/2]

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

Definition at line 244 of file GeneralEvenOddRationalRatio.h.

References action_name(), ApproxHalfPowerAction, ApproxNegHalfPowerAction, Denominator, DenOp, Even, GridLogMessage, ImportGauge(), multiShiftInverse(), norm2(), Numerator, NumOp, Odd, param, PhiEven, PhiOdd, pickCheckerboard(), RefreshAction, and U.

◆ Sinitial()

template<class Impl>
virtual RealD GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::Sinitial ( const GaugeField & U)
inlinevirtual

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 from Action< Impl::GaugeField >.

Definition at line 283 of file GeneralEvenOddRationalRatio.h.

References GridLogMessage, RefreshAction, and U.

◆ S()

template<class Impl>
virtual RealD GeneralEvenOddRatioRationalPseudoFermionAction< 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 288 of file GeneralEvenOddRationalRatio.h.

References action_name(), ApproxHalfPowerAction, ApproxNegHalfPowerAction, ApproxNegPowerAction, Denominator, DenOp, GridLogMessage, HighBoundCheck(), ImportGauge(), InversePowerBoundsCheck(), multiShiftInverse(), norm2(), Numerator, NumOp, param, PhiOdd, and U.

◆ deriv()

template<class Impl>
virtual void GeneralEvenOddRatioRationalPseudoFermionAction< 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 358 of file GeneralEvenOddRationalRatio.h.

References action_name(), ApproxHalfPowerMD, ApproxNegPowerMD, Denominator, DenOp, GridLogMessage, ImportGauge(), SchurDiagMooeeOperator< Matrix, Field >::Mpc(), SchurDifferentiableOperator< Impl >::MpcDagDeriv(), SchurDifferentiableOperator< Impl >::MpcDeriv(), multiShiftInverse(), Numerator, NumOp, param, PhiOdd, 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.

Field Documentation

◆ param

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

Definition at line 61 of file GeneralEvenOddRationalRatio.h.

Referenced by deriv(), GeneralEvenOddRatioRationalPseudoFermionAction(), LogParameters(), refresh(), and S().

◆ RefreshAction

template<class Impl>
RealD GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::RefreshAction

Definition at line 62 of file GeneralEvenOddRationalRatio.h.

Referenced by refresh(), and Sinitial().

◆ ApproxPowerAction

template<class Impl>
MultiShiftFunction GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::ApproxPowerAction

Definition at line 64 of file GeneralEvenOddRationalRatio.h.

Referenced by GeneralEvenOddRatioRationalPseudoFermionAction(), and SetTolerances().

◆ ApproxNegPowerAction

template<class Impl>
MultiShiftFunction GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::ApproxNegPowerAction

Definition at line 65 of file GeneralEvenOddRationalRatio.h.

Referenced by GeneralEvenOddRatioRationalPseudoFermionAction(), S(), and SetTolerances().

◆ ApproxHalfPowerAction

template<class Impl>
MultiShiftFunction GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::ApproxHalfPowerAction

Definition at line 66 of file GeneralEvenOddRationalRatio.h.

Referenced by GeneralEvenOddRatioRationalPseudoFermionAction(), refresh(), S(), and SetTolerances().

◆ ApproxNegHalfPowerAction

template<class Impl>
MultiShiftFunction GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::ApproxNegHalfPowerAction

Definition at line 67 of file GeneralEvenOddRationalRatio.h.

Referenced by GeneralEvenOddRatioRationalPseudoFermionAction(), refresh(), S(), and SetTolerances().

◆ ApproxPowerMD

template<class Impl>
MultiShiftFunction GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::ApproxPowerMD

Definition at line 70 of file GeneralEvenOddRationalRatio.h.

Referenced by GeneralEvenOddRatioRationalPseudoFermionAction(), and SetTolerances().

◆ ApproxNegPowerMD

template<class Impl>
MultiShiftFunction GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::ApproxNegPowerMD

Definition at line 71 of file GeneralEvenOddRationalRatio.h.

Referenced by deriv(), GeneralEvenOddRatioRationalPseudoFermionAction(), and SetTolerances().

◆ ApproxHalfPowerMD

template<class Impl>
MultiShiftFunction GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::ApproxHalfPowerMD

Definition at line 72 of file GeneralEvenOddRationalRatio.h.

Referenced by deriv(), GeneralEvenOddRatioRationalPseudoFermionAction(), and SetTolerances().

◆ ApproxNegHalfPowerMD

template<class Impl>
MultiShiftFunction GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::ApproxNegHalfPowerMD

Definition at line 73 of file GeneralEvenOddRationalRatio.h.

Referenced by GeneralEvenOddRatioRationalPseudoFermionAction(), and SetTolerances().

◆ NumOp

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

Definition at line 77 of file GeneralEvenOddRationalRatio.h.

Referenced by deriv(), GeneralEvenOddRatioRationalPseudoFermionAction(), ImportGauge(), multiShiftInverse(), multiShiftInverse(), refresh(), refresh(), and S().

◆ DenOp

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

Definition at line 78 of file GeneralEvenOddRationalRatio.h.

Referenced by deriv(), GeneralEvenOddRatioRationalPseudoFermionAction(), ImportGauge(), multiShiftInverse(), multiShiftInverse(), refresh(), and S().

◆ PhiEven

template<class Impl>
FermionField GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::PhiEven
private

Definition at line 79 of file GeneralEvenOddRationalRatio.h.

Referenced by GeneralEvenOddRatioRationalPseudoFermionAction(), and refresh().

◆ PhiOdd

template<class Impl>
FermionField GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::PhiOdd
private

Definition at line 80 of file GeneralEvenOddRationalRatio.h.

Referenced by deriv(), GeneralEvenOddRatioRationalPseudoFermionAction(), getPhiOdd(), refresh(), and S().

◆ Numerator

template<class Impl>
bool GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::Numerator
staticconstexprprotected

Definition at line 96 of file GeneralEvenOddRationalRatio.h.

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

◆ Denominator

template<class Impl>
bool GeneralEvenOddRatioRationalPseudoFermionAction< Impl >::Denominator
staticconstexprprotected

Definition at line 97 of file GeneralEvenOddRationalRatio.h.

Referenced by deriv(), 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: