QUDA: quda::LatticeFieldParam Struct Reference

#include <lattice_field.h>

Inheritance diagram for quda::LatticeFieldParam:

Inheritance graph

[legend]

Public Member Functions
QudaPrecision	Precision () const

QudaPrecision	GhostPrecision () const

	LatticeFieldParam ()
	Default constructor for LatticeFieldParam. More...

	LatticeFieldParam (int nDim, const int *x, int pad, QudaPrecision precision, QudaGhostExchange ghostExchange=QUDA_GHOST_EXCHANGE_PAD)
	Constructor for creating a LatticeFieldParam from a set of parameters. More...

	LatticeFieldParam (const QudaGaugeParam &param)
	Constructor for creating a LatticeFieldParam from a QudaGaugeParam. Used for wrapping around a CPU reference field. More...

	LatticeFieldParam (const LatticeField &field)
	Contructor for creating LatticeFieldParam from a LatticeField. More...

Public Attributes
int	nDim

int	x [QUDA_MAX_DIM]

int	pad

QudaSiteSubset	siteSubset

QudaMemoryType	mem_type

QudaGhostExchange	ghostExchange

int	r [QUDA_MAX_DIM]

double	scale

Protected Attributes
QudaPrecision	precision

QudaPrecision	ghost_precision

Detailed Description

Definition at line 47 of file lattice_field.h.

Constructor & Destructor Documentation

◆ LatticeFieldParam() [1/4]

quda::LatticeFieldParam::LatticeFieldParam ( )

inline

Default constructor for LatticeFieldParam.

Definition at line 87 of file lattice_field.h.

References nDim.

Referenced by LatticeFieldParam().

Here is the caller graph for this function:

◆ LatticeFieldParam() [2/4]

quda::LatticeFieldParam::LatticeFieldParam	(	int	nDim,
		const int *	x,
		int	pad,
		QudaPrecision	precision,
		QudaGhostExchange	ghostExchange = `QUDA_GHOST_EXCHANGE_PAD`
	)

inline

Constructor for creating a LatticeFieldParam from a set of parameters.

Parameters

[in]	nDim	Number of field dimensions
[in]	x	Array of dimension lengths
[in]	pad	Field padding
[in]	precision	Field Precision
[in]	ghostExchange	Type of ghost exchange

Definition at line 106 of file lattice_field.h.

References errorQuda, nDim, and QUDA_MAX_DIM.

◆ LatticeFieldParam() [3/4]

quda::LatticeFieldParam::LatticeFieldParam ( const QudaGaugeParam & param )

inline

Constructor for creating a LatticeFieldParam from a QudaGaugeParam. Used for wrapping around a CPU reference field.

Parameters

[in] param Contains the metadata for filling out the LatticeFieldParam

Definition at line 125 of file lattice_field.h.

References LatticeFieldParam(), nDim, quda::operator<<(), param, and QudaGaugeParam_s::X.

Here is the call graph for this function:

◆ LatticeFieldParam() [4/4]

quda::LatticeFieldParam::LatticeFieldParam ( const LatticeField & field )

Contructor for creating LatticeFieldParam from a LatticeField.

Definition at line 47 of file lattice_field.cpp.

References nDim, r, quda::LatticeField::R(), x, and quda::LatticeField::X().

Here is the call graph for this function:

Member Function Documentation

◆ GhostPrecision()

QudaPrecision quda::LatticeFieldParam::GhostPrecision ( ) const

inline

Ghost precision

Definition at line 61 of file lattice_field.h.

References ghost_precision.

Referenced by quda::operator<<(), and quda::ColorSpinorField::reset().

Here is the caller graph for this function:

◆ Precision()

QudaPrecision quda::LatticeFieldParam::Precision ( ) const

inline

Field precision

Definition at line 58 of file lattice_field.h.

References precision.

Referenced by quda::CoarseOp(), quda::ColorSpinorField::ColorSpinorField(), computeCloverForceQuda(), computeGaugeFixingFFTQuda(), computeGaugeFixingOVRQuda(), computeHISQForceQuda(), computeStaggeredForceQuda(), contractQuda(), quda::ColorSpinorField::CreateFine(), quda::Transfer::createTmp(), quda::fatLongKSLink(), init(), initFields(), invertMultiShiftQuda(), loadSloppyCloverQuda(), loadSloppyGaugeQuda(), quda::operator<<(), packTest(), quda::ColorSpinorField::reset(), and quda::MG::verify().

Here is the caller graph for this function:

Member Data Documentation

◆ ghost_precision

QudaPrecision quda::LatticeFieldParam::ghost_precision

protected

Ghost precision

Definition at line 54 of file lattice_field.h.

Referenced by GhostPrecision(), quda::LatticeField::GhostPrecision(), quda::CloverFieldParam::setPrecision(), and quda::GaugeFieldParam::setPrecision().

◆ ghostExchange

QudaGhostExchange quda::LatticeFieldParam::ghostExchange

The type of ghost exchange to be done with this field

Definition at line 76 of file lattice_field.h.

Referenced by computeHISQForceQuda(), computeHISQLinksCPU(), computeKSLinkQuda(), quda::DiracCoarse::createY(), quda::DiracCoarse::createYhat(), dslash_4_4d(), dw_dslash(), eigensolve_test(), gaussGaugeQuda(), quda::LatticeField::GhostExchange(), hisq_force_init(), hisq_test(), init(), initFields(), invert_test(), loadGaugeQuda(), main(), quda::operator<<(), saveGaugeQuda(), GaugeAlgTest::SetUp(), unitarize_link_test(), updateGaugeFieldQuda(), and wil_dslash().

◆ mem_type

QudaMemoryType quda::LatticeFieldParam::mem_type

Definition at line 73 of file lattice_field.h.

Referenced by quda::cudaColorSpinorField::create(), quda::ColorSpinorField::CreateCoarse(), quda::ColorSpinorField::CreateFine(), quda::DiracCoarse::createY(), quda::LatticeField::MemType(), and quda::multigrid_solver::multigrid_solver().

◆ nDim

int quda::LatticeFieldParam::nDim

◆ pad

int quda::LatticeFieldParam::pad

◆ precision

QudaPrecision quda::LatticeFieldParam::precision

protected

Field precision

Definition at line 51 of file lattice_field.h.

Referenced by quda::CloverFieldParam::CloverFieldParam(), quda::cudaColorSpinorField::CopySubset(), Precision(), quda::LatticeField::Precision(), quda::Precision_(), quda::CloverFieldParam::setPrecision(), and quda::GaugeFieldParam::setPrecision().

◆ r

int quda::LatticeFieldParam::r[QUDA_MAX_DIM]

The extended field radius (if applicable)

Definition at line 79 of file lattice_field.h.

Referenced by computeHISQForceQuda(), hisq_force_init(), hisq_force_test(), LatticeFieldParam(), quda::operator<<(), and quda::LatticeField::R().

◆ scale

double quda::LatticeFieldParam::scale

For fixed-point fields that need a global scaling factor

Definition at line 82 of file lattice_field.h.

Referenced by quda::operator<<(), and quda::LatticeField::Scale().

◆ siteSubset

QudaSiteSubset quda::LatticeFieldParam::siteSubset

Definition at line 71 of file lattice_field.h.

Referenced by quda::CloverFieldParam::CloverFieldParam(), quda::CoarseOp(), quda::ColorSpinorField::ColorSpinorField(), quda::ColorSpinorParam::ColorSpinorParam(), quda::colorSpinorParam(), computeCloverForceQuda(), computeHISQForceQuda(), computeStaggeredForceQuda(), construct_spinor_source(), quda::cudaColorSpinorField::CopySubset(), quda::cpuColorSpinorField::cpuColorSpinorField(), quda::cudaColorSpinorField::create(), quda::cpuColorSpinorField::create(), createCloverQuda(), quda::ColorSpinorField::CreateCoarse(), quda::ColorSpinorField::CreateFine(), quda::Transfer::createV(), quda::DiracCoarse::createY(), quda::DiracCoarse::createYhat(), dslash_4_4d(), dw_dslash(), quda::ColorSpinorField::fill(), init(), initFields(), invert_test(), loadCloverQuda(), quda::MG::MG(), qChargeDensityQuda(), qChargeQuda(), quda::ColorSpinorField::reset(), quda::RNG::RNG(), quda::LatticeField::SiteSubset(), and wil_dslash().

◆ x

int quda::LatticeFieldParam::x[QUDA_MAX_DIM]

Array storing the length of dimension

Definition at line 67 of file lattice_field.h.

Referenced by quda::CloverFieldParam::CloverFieldParam(), quda::CoarseOp(), quda::ColorSpinorField::ColorSpinorField(), quda::colorSpinorParam(), computeCloverForceQuda(), computeHISQForceQuda(), computeHISQLinksCPU(), computeStaggeredForceQuda(), construct_spinor_source(), quda::cudaColorSpinorField::CopySubset(), quda::cudaColorSpinorField::create(), quda::cpuColorSpinorField::create(), quda::ColorSpinorField::CreateCoarse(), quda::ColorSpinorField::CreateFine(), quda::Transfer::createV(), quda::DiracCoarse::createY(), quda::DiracCoarse::createYhat(), dslash_4_4d(), dw_dslash(), quda::ColorSpinorField::fill(), quda::FullClover::FullClover(), getGaugePadding(), hisq_force_init(), hisq_force_test(), init(), initFields(), invert_test(), LatticeFieldParam(), loadCloverQuda(), quda::MG::MG(), quda::XSD::operator()(), quda::operator<<(), quda::ColorSpinorField::reset(), quda::RNG::RNG(), wil_dslash(), and quda::LatticeField::X().

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

include/lattice_field.h
lib/lattice_field.cpp