cps::AlgFixGauge Class Reference
[Algorithms]

Performs gauge fixing. More...

#include <alg_fix_gauge.h>

Inherits cps::Alg.

List of all members.

Public Member Functions
	AlgFixGauge (Lattice &latt, CommonArg *c_arg, FixGaugeArg *arg)
virtual	~AlgFixGauge ()
void	run (void)
void	free (void)

---

Detailed Description

Performs gauge fixing.

The gauge can be fixed to Landau gauge, in which case this is done at every lattice site, or to Coulomb gauge, in which case the gauge is fixed on hyperplanes normal to a specified direction. You can specify the first hyperplane, the number of hyperplanes and the distance between hyperplanes.

Definition at line 32 of file alg_fix_gauge.h.

---

Constructor & Destructor Documentation

cps::AlgFixGauge::AlgFixGauge (  Lattice &  latt, CommonArg *  c_arg, FixGaugeArg *  arg )

Parameters: latt  The lattice object containing the gauge field to be fixed. c_arg  Generic algorithm parameters arg  Gauge fixing parameters. Definition at line 49 of file alg_fix_gauge.C. References cps::ERR, cps::Verbose::Func(), cps::Error::Pointer(), and cps::VRB.

cps::AlgFixGauge::~AlgFixGauge (   )  [virtual]

Note: The destructor does not free the memory allocated. Use AlgFixGauge::free for this or Lattice::FixGaugeFree Definition at line 73 of file alg_fix_gauge.C. References cps::Verbose::Func(), and cps::VRB.

---

Member Function Documentation

void cps::AlgFixGauge::free (  void   )

Definition at line 157 of file alg_fix_gauge.C. References cps::Alg::AlgLattice(), cps::Lattice::FixGaugeFree(), cps::Verbose::Func(), and cps::VRB.

void cps::AlgFixGauge::run (  void   )

Postcondition: The Lattice class allocates memory for the gauge fixing matrices which can be accessed using Lattice::FixGaugePtr. Definition at line 82 of file alg_fix_gauge.C. References cps::Alg::AlgLattice(), cps::ERR, cps::FIX_GAUGE_COULOMB_T, cps::FIX_GAUGE_COULOMB_X, cps::FIX_GAUGE_COULOMB_Y, cps::FIX_GAUGE_COULOMB_Z, cps::FixGaugeArg::fix_gauge_kind, cps::FIX_GAUGE_LANDAU, cps::FIX_GAUGE_NONE, cps::Lattice::FixGauge(), cps::Lattice::FixGaugeAllocate(), cps::FixGaugeType, cps::Verbose::Func(), cps::Error::General(), cps::GJP, cps::FixGaugeArg::hyperplane_num, cps::FixGaugeArg::hyperplane_start, cps::FixGaugeArg::hyperplane_step, cps::FixGaugeArg::max_iter_num, cps::Error::Pointer(), cps::sfree(), cps::Verbose::Sfree(), cps::Verbose::Smalloc(), cps::smalloc(), cps::FixGaugeArg::stop_cond, cps::GlobalJobParameter::Tnodes(), cps::GlobalJobParameter::TnodeSites(), cps::VRB, cps::GlobalJobParameter::Xnodes(), cps::GlobalJobParameter::XnodeSites(), cps::GlobalJobParameter::Ynodes(), cps::GlobalJobParameter::YnodeSites(), cps::GlobalJobParameter::Znodes(), and cps::GlobalJobParameter::ZnodeSites(). Referenced by cps::AlgMeas::RunTask().

---

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

• include/alg/alg_fix_gauge.h
• src/alg/alg_fix_gauge/alg_fix_gauge.C

---