struct to define gauge fields packed into an opaque MILC site struct: More...

#include <gauge_field_order.h>

Inheritance diagram for quda::gauge::MILCSiteOrder< Float, length >:

Public Types
using	Accessor = MILCSiteOrder< Float, length >

using	real = typename mapper< Float >::type

using	complex = complex< real >

Public Types inherited from quda::gauge::LegacyOrder< Float, length >
using	Accessor = LegacyOrder< Float, length >

using	real = typename mapper< Float >::type

using	complex = complex< real >

Public Member Functions
	MILCSiteOrder (const GaugeField &u, Float gauge_=0, Float *ghost_=0)

	MILCSiteOrder (const MILCSiteOrder &order)

__device__ __host__ void	load (complex v[length/2], int x, int dir, int parity, real inphase=1.0) const

__device__ __host__ void	save (const complex v[length/2], int x, int dir, int parity)

__device__ __host__ gauge_wrapper< real, Accessor >	operator() (int dim, int x_cb, int parity)
	This accessor routine returns a gauge_wrapper to this object, allowing us to overload various operators for manipulating at the site level interms of matrix operations. More...

__device__ __host__ const gauge_wrapper< real, Accessor >	operator() (int dim, int x_cb, int parity) const
	This accessor routine returns a const gauge_wrapper to this object, allowing us to overload various operators for manipulating at the site level interms of matrix operations. More...

size_t	Bytes () const

Public Member Functions inherited from quda::gauge::LegacyOrder< Float, length >
	LegacyOrder (const GaugeField &u, Float **ghost_)

	LegacyOrder (const LegacyOrder &order)

__device__ __host__ void	loadGhost (complex v[length/2], int x, int dir, int parity, real phase=1.0) const

__device__ __host__ void	saveGhost (const complex v[length/2], int x, int dir, int parity)

__device__ __host__ gauge_ghost_wrapper< real, Accessor >	Ghost (int dim, int ghost_idx, int parity, real phase=1.0)
	This accessor routine returns a gauge_ghost_wrapper to this object, allowing us to overload various operators for manipulating at the site level interms of matrix operations. More...

__device__ __host__ const gauge_ghost_wrapper< real, Accessor >	Ghost (int dim, int ghost_idx, int parity, real phase=1.0) const
	This accessor routine returns a const gauge_ghost_wrapper to this object, allowing us to overload various operators for manipulating at the site level interms of matrix operations. More...

__device__ __host__ void	loadGhostEx (complex v[length/2], int x, int dummy, int dir, int dim, int g, int parity, const int R[]) const

__device__ __host__ void	saveGhostEx (const complex v[length/2], int x, int dummy, int dir, int dim, int g, int parity, const int R[])

Public Attributes
Float *	gauge

const int	volumeCB

const int	geometry

const size_t	offset

const size_t	size

Public Attributes inherited from quda::gauge::LegacyOrder< Float, length >
Float *	ghost [QUDA_MAX_DIM]

int	faceVolumeCB [QUDA_MAX_DIM]

const int	volumeCB

const int	stride

const int	geometry

const int	hasPhase

Detailed Description

template<typename Float, int length>
struct quda::gauge::MILCSiteOrder< Float, length >

struct to define gauge fields packed into an opaque MILC site struct:

struct { char padding[offset]; Float [dim][row][col]; } site;

site lattice [parity][volumecb];

We are just passed the size of the struct and the offset to the required matrix elements. Typically, it is expected that this accessor will be used with zero-copy memory to the original allocation in MILC.

Definition at line 2559 of file gauge_field_order.h.

Member Typedef Documentation

◆ Accessor

template<typename Float , int length>

using quda::gauge::MILCSiteOrder< Float, length >::Accessor = MILCSiteOrder<Float, length>

Definition at line 2560 of file gauge_field_order.h.

◆ complex

template<typename Float , int length>

using quda::gauge::MILCSiteOrder< Float, length >::complex = complex<real>

Definition at line 2562 of file gauge_field_order.h.

◆ real

template<typename Float , int length>

using quda::gauge::MILCSiteOrder< Float, length >::real = typename mapper<Float>::type

Definition at line 2561 of file gauge_field_order.h.

Constructor & Destructor Documentation

◆ MILCSiteOrder() [1/2]

template<typename Float , int length>

quda::gauge::MILCSiteOrder< Float, length >::MILCSiteOrder	(	const GaugeField &	u,
		Float *	gauge_ = `0`,
		Float **	ghost_ = `0`
	)

inline

Definition at line 2568 of file gauge_field_order.h.

◆ MILCSiteOrder() [2/2]

template<typename Float , int length>

quda::gauge::MILCSiteOrder< Float, length >::MILCSiteOrder ( const MILCSiteOrder< Float, length > & order )

inline

Definition at line 2579 of file gauge_field_order.h.

Member Function Documentation

◆ Bytes()

template<typename Float , int length>

size_t quda::gauge::MILCSiteOrder< Float, length >::Bytes ( ) const

inline

Definition at line 2656 of file gauge_field_order.h.

◆ load()

template<typename Float , int length>

__device__ __host__ void quda::gauge::MILCSiteOrder< Float, length >::load	(	complex	v[length/2],
		int	x,
		int	dir,
		int	parity,
		real	inphase = `1.0`
	)		const

inline

Definition at line 2589 of file gauge_field_order.h.

◆ operator()() [1/2]

template<typename Float , int length>

__device__ __host__ gauge_wrapper<real, Accessor> quda::gauge::MILCSiteOrder< Float, length >::operator()	(	int	dim,
		int	x_cb,
		int	parity
	)

inline

This accessor routine returns a gauge_wrapper to this object, allowing us to overload various operators for manipulating at the site level interms of matrix operations.

Parameters

[in]	dir	Which dimension are we requesting
[in]	x_cb	Checkerboarded space-time index we are requesting
[in]	parity	Parity we are requesting

Returns: Instance of a gauge_wrapper that curries in access to this field at the above coordinates.

Definition at line 2636 of file gauge_field_order.h.

◆ operator()() [2/2]

template<typename Float , int length>

__device__ __host__ const gauge_wrapper<real, Accessor> quda::gauge::MILCSiteOrder< Float, length >::operator()	(	int	dim,
		int	x_cb,
		int	parity
	)		const

inline

This accessor routine returns a const gauge_wrapper to this object, allowing us to overload various operators for manipulating at the site level interms of matrix operations.

Parameters

[in]	dir	Which dimension are we requesting
[in]	x_cb	Checkerboarded space-time index we are requesting
[in]	parity	Parity we are requesting

Returns: Instance of a gauge_wrapper that curries in access to this field at the above coordinates.

Definition at line 2651 of file gauge_field_order.h.

◆ save()

template<typename Float , int length>

__device__ __host__ void quda::gauge::MILCSiteOrder< Float, length >::save	(	const complex	v[length/2],
		int	x,
		int	dir,
		int	parity
	)

inline

Definition at line 2604 of file gauge_field_order.h.

Member Data Documentation

◆ gauge

template<typename Float , int length>

Float* quda::gauge::MILCSiteOrder< Float, length >::gauge

Definition at line 2563 of file gauge_field_order.h.

◆ geometry

template<typename Float , int length>

const int quda::gauge::MILCSiteOrder< Float, length >::geometry

Definition at line 2565 of file gauge_field_order.h.

◆ offset

template<typename Float , int length>

const size_t quda::gauge::MILCSiteOrder< Float, length >::offset

Definition at line 2566 of file gauge_field_order.h.

◆ size

template<typename Float , int length>

const size_t quda::gauge::MILCSiteOrder< Float, length >::size

Definition at line 2567 of file gauge_field_order.h.

◆ volumeCB

template<typename Float , int length>

const int quda::gauge::MILCSiteOrder< Float, length >::volumeCB

Definition at line 2564 of file gauge_field_order.h.

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

quda/include/gauge_field_order.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

template<typename Float, int length> struct quda::gauge::MILCSiteOrder< Float, length >

Member Typedef Documentation

◆ Accessor

◆ complex

◆ real

Constructor & Destructor Documentation

◆ MILCSiteOrder() [1/2]

◆ MILCSiteOrder() [2/2]

Member Function Documentation

◆ Bytes()

◆ load()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ save()

Member Data Documentation

◆ gauge

◆ geometry

◆ offset

◆ size

◆ volumeCB

template<typename Float, int length>
struct quda::gauge::MILCSiteOrder< Float, length >