QUDA: quda::GaugeFieldParam Struct Reference

QUDA 1.0.0

#include <gauge_field.h>

Inheritance diagram for quda::GaugeFieldParam:

Inheritance graph

[legend]

Collaboration diagram for quda::GaugeFieldParam:

Collaboration graph

[legend]

Public Member Functions
	GaugeFieldParam (void *const h_gauge=NULL)

	GaugeFieldParam (const GaugeField &u)

	GaugeFieldParam (const int *x, const QudaPrecision precision, const QudaReconstructType reconstruct, const int pad, const QudaFieldGeometry geometry, const QudaGhostExchange ghostExchange=QUDA_GHOST_EXCHANGE_PAD)

	GaugeFieldParam (void *h_gauge, const QudaGaugeParam &param, QudaLinkType link_type_=QUDA_INVALID_LINKS)

void	setPrecision (QudaPrecision precision, bool force_native=false)
	Helper function for setting the precision and corresponding field order for QUDA internal fields. More...

Public Member Functions inherited from quda::LatticeFieldParam
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
QudaFieldLocation	location

int	nColor

int	nFace

QudaReconstructType	reconstruct

QudaGaugeFieldOrder	order

QudaGaugeFixed	fixed

QudaLinkType	link_type

QudaTboundary	t_boundary

double	anisotropy

double	tadpole

void *	gauge

QudaFieldCreate	create

QudaFieldGeometry	geometry

bool	compute_fat_link_max

QudaStaggeredPhase	staggeredPhaseType

bool	staggeredPhaseApplied

double	i_mu

size_t	site_offset

size_t	site_size

Public Attributes inherited from quda::LatticeFieldParam
int	nDim

int	x [QUDA_MAX_DIM]

int	pad

QudaSiteSubset	siteSubset

QudaMemoryType	mem_type

QudaGhostExchange	ghostExchange

int	r [QUDA_MAX_DIM]

double	scale

Additional Inherited Members
Protected Attributes inherited from quda::LatticeFieldParam
QudaPrecision	precision

QudaPrecision	ghost_precision

Detailed Description

Definition at line 10 of file gauge_field.h.

Constructor & Destructor Documentation

◆ GaugeFieldParam() [1/4]

quda::GaugeFieldParam::GaugeFieldParam ( void *const h_gauge = NULL )

inline

Definition at line 51 of file gauge_field.h.

◆ GaugeFieldParam() [2/4]

quda::GaugeFieldParam::GaugeFieldParam ( const GaugeField & u )

Definition at line 7 of file gauge_field.cpp.

◆ GaugeFieldParam() [3/4]

quda::GaugeFieldParam::GaugeFieldParam	(	const int *	x,
		const QudaPrecision	precision,
		const QudaReconstructType	reconstruct,
		const int	pad,
		const QudaFieldGeometry	geometry,
		const QudaGhostExchange	ghostExchange = `QUDA_GHOST_EXCHANGE_PAD`
	)

inline

Definition at line 77 of file gauge_field.h.

◆ GaugeFieldParam() [4/4]

quda::GaugeFieldParam::GaugeFieldParam	(	void *	h_gauge,
		const QudaGaugeParam &	param,
		QudaLinkType	link_type_ = `QUDA_INVALID_LINKS`
	)

inline

Definition at line 102 of file gauge_field.h.

References errorQuda, QUDA_GENERAL_LINKS, QUDA_MOMENTUM_LINKS, QUDA_SMEARED_LINKS, QUDA_SU3_LINKS, and QUDA_THREE_LINKS.

Member Function Documentation

◆ setPrecision()

void quda::GaugeFieldParam::setPrecision	(	QudaPrecision	precision,
		bool	force_native = `false`
	)

inline

Helper function for setting the precision and corresponding field order for QUDA internal fields.

Parameters

precision The precision to use

Definition at line 131 of file gauge_field.h.

References quda::LatticeFieldParam::ghost_precision, quda::operator<<(), param, quda::LatticeFieldParam::precision, QUDA_DOUBLE_PRECISION, QUDA_FLOAT2_GAUGE_ORDER, QUDA_FLOAT4_GAUGE_ORDER, QUDA_HALF_PRECISION, QUDA_QUARTER_PRECISION, QUDA_RECONSTRUCT_10, QUDA_RECONSTRUCT_12, QUDA_RECONSTRUCT_13, QUDA_RECONSTRUCT_8, QUDA_RECONSTRUCT_9, QUDA_RECONSTRUCT_NO, and QUDA_SINGLE_PRECISION.

Referenced by quda::CoarseCoarseOp(), quda::CoarseOp(), computeGaugeForceQuda(), computeHISQForceQuda(), computeKSLinkQuda(), quda::DiracCoarse::createY(), quda::DiracCoarse::createYhat(), quda::fatLongKSLink(), hisq_force_init(), initFields(), loadGaugeQuda(), loadSloppyGaugeQuda(), packTest(), saveGaugeQuda(), and unitarize_link_test().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ anisotropy

double quda::GaugeFieldParam::anisotropy

Definition at line 22 of file gauge_field.h.

Referenced by quda::GaugeField::Anisotropy(), hisq_force_init(), and quda::operator<<().

◆ compute_fat_link_max

bool quda::GaugeFieldParam::compute_fat_link_max

Definition at line 33 of file gauge_field.h.

Referenced by quda::cpuGaugeField::cpuGaugeField(), and loadGaugeQuda().

◆ create

◆ fixed

QudaGaugeFixed quda::GaugeFieldParam::fixed

Definition at line 18 of file gauge_field.h.

Referenced by quda::GaugeField::GaugeFixed(), and quda::operator<<().

◆ gauge

void* quda::GaugeFieldParam::gauge

Definition at line 24 of file gauge_field.h.

Referenced by computeHISQForceQuda(), computeHISQLinksCPU(), computeKSLinkQuda(), computeStaggeredForceQuda(), quda::cpuGaugeField::cpuGaugeField(), quda::cudaGaugeField::cudaGaugeField(), quda::cudaGaugeField::Gauge_p(), quda::cpuGaugeField::Gauge_p(), and unitarize_link_test().

◆ geometry

QudaFieldGeometry quda::GaugeFieldParam::geometry

Definition at line 28 of file gauge_field.h.

Referenced by computeCloverForceQuda(), createGaugeFieldQuda(), quda::DiracCoarse::createY(), quda::DiracCoarse::createYhat(), quda::GaugeField::Geometry(), initFields(), quda::operator<<(), and saveGaugeFieldQuda().

◆ i_mu

double quda::GaugeFieldParam::i_mu

Imaginary chemical potential

Definition at line 42 of file gauge_field.h.

Referenced by quda::GaugeField::iMu().

◆ link_type

QudaLinkType quda::GaugeFieldParam::link_type

◆ location

QudaFieldLocation quda::GaugeFieldParam::location

Definition at line 12 of file gauge_field.h.

Referenced by quda::CoarseCoarseOp(), quda::CoarseOp(), quda::GaugeField::Create(), and quda::cpuGaugeField::Gauge_p().

◆ nColor

int quda::GaugeFieldParam::nColor

Definition at line 13 of file gauge_field.h.

Referenced by quda::DiracCoarse::createY(), quda::DiracCoarse::createYhat(), initFields(), quda::GaugeField::Ncolor(), and quda::operator<<().

◆ nFace

int quda::GaugeFieldParam::nFace

Definition at line 14 of file gauge_field.h.

Referenced by computeHISQForceQuda(), quda::DiracCoarse::createY(), quda::DiracCoarse::createYhat(), initFields(), quda::GaugeField::Nface(), and quda::operator<<().

◆ order

◆ reconstruct

◆ site_offset

size_t quda::GaugeFieldParam::site_offset

Offset into MILC site struct to the desired matrix field (only if gauge_order=MILC_SITE_GAUGE_ORDER)

Definition at line 45 of file gauge_field.h.

Referenced by computeGaugeForceQuda(), projectSU3Quda(), quda::GaugeField::SiteOffset(), and updateGaugeFieldQuda().

◆ site_size

size_t quda::GaugeFieldParam::site_size

Size of MILC site struct (only if gauge_order=MILC_SITE_GAUGE_ORDER)

Definition at line 48 of file gauge_field.h.

Referenced by computeGaugeForceQuda(), projectSU3Quda(), quda::GaugeField::SiteSize(), and updateGaugeFieldQuda().

◆ staggeredPhaseApplied

bool quda::GaugeFieldParam::staggeredPhaseApplied

Whether the staggered phase factor has been applied

Definition at line 39 of file gauge_field.h.

Referenced by quda::operator<<(), and quda::GaugeField::StaggeredPhaseApplied().

◆ staggeredPhaseType

QudaStaggeredPhase quda::GaugeFieldParam::staggeredPhaseType

The staggered phase convention to use

Definition at line 36 of file gauge_field.h.

Referenced by quda::operator<<(), and quda::GaugeField::StaggeredPhase().

◆ t_boundary

QudaTboundary quda::GaugeFieldParam::t_boundary

Definition at line 20 of file gauge_field.h.

Referenced by computeStaggeredForceQuda(), quda::DiracCoarse::createY(), quda::DiracCoarse::createYhat(), initFields(), main(), quda::operator<<(), GaugeAlgTest::SetUp(), and quda::GaugeField::TBoundary().

◆ tadpole

double quda::GaugeFieldParam::tadpole

Definition at line 23 of file gauge_field.h.

Referenced by quda::operator<<(), and quda::GaugeField::Tadpole().

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

include/gauge_field.h
lib/gauge_field.cpp