quda::gauge_ghost_wrapper< Float, T > Struct Template Reference

gauge_ghost_wrapper is an internal class that is used to wrap instances of gauge ghost accessors, currying in a specific location and dimension on the field. The Ghost() accessors in gauge-field accessors return instances to this class, allowing us to then use operator overloading upon this class to interact with the Matrix class. As a result we can include gauge-field ghost accessors directly in Matrix expressions in kernels without having to declare temporaries with explicit calls to the load/save methods in the gauge-field accessors. More...

#include <gauge_field_order.h>

Public Member Functions
__device__ __host__	gauge_ghost_wrapper (T &gauge, int dim, int ghost_idx, int parity, Float phase=1.0)
	gauge_wrapper constructor More...
template<typename M >
__device__ __host__ void	operator= (const M &a)
	Assignment operator with Matrix instance as input. More...

Public Attributes
const int	dim
const int	ghost_idx
const int	parity
const Float	phase
T &	gauge

Detailed Description

template<typename Float, typename T>
struct quda::gauge_ghost_wrapper< Float, T >

gauge_ghost_wrapper is an internal class that is used to wrap instances of gauge ghost accessors, currying in a specific location and dimension on the field. The Ghost() accessors in gauge-field accessors return instances to this class, allowing us to then use operator overloading upon this class to interact with the Matrix class. As a result we can include gauge-field ghost accessors directly in Matrix expressions in kernels without having to declare temporaries with explicit calls to the load/save methods in the gauge-field accessors.

Definition at line 109 of file gauge_field_order.h.

Constructor & Destructor Documentation

gauge_ghost_wrapper()

template<typename Float , typename T >

__device__ __host__ quda::gauge_ghost_wrapper< Float, T >::gauge_ghost_wrapper ( T &  gauge, int  dim, int  ghost_idx, int  parity, Float  phase = 1.0  )

inline

gauge_wrapper constructor

Parameters

[in]	gauge	Gauge field accessor we are wrapping
[in]	dim	Dimension we are accessing
[in]	ghost_idx	Ghost index we are accessing
[in]	parity	Parity we are accessing

Definition at line 123 of file gauge_field_order.h.

Member Function Documentation

operator=()

template<typename Float , typename T >

template<typename M >

__device__ __host__ void quda::gauge_ghost_wrapper< Float, T >::operator= ( const M &  a )

inline

Assignment operator with Matrix instance as input.

Parameters

[in]

M

Matrix we want to store in this accessot

Definition at line 138 of file gauge_field_order.h.

Member Data Documentation

dim

template<typename Float , typename T >

const int quda::gauge_ghost_wrapper< Float, T >::dim

Definition at line 110 of file gauge_field_order.h.

gauge

template<typename Float , typename T >

T& quda::gauge_ghost_wrapper< Float, T >::gauge

Definition at line 114 of file gauge_field_order.h.

ghost_idx

template<typename Float , typename T >

const int quda::gauge_ghost_wrapper< Float, T >::ghost_idx

Definition at line 111 of file gauge_field_order.h.

parity

template<typename Float , typename T >

const int quda::gauge_ghost_wrapper< Float, T >::parity

Definition at line 112 of file gauge_field_order.h.

phase

template<typename Float , typename T >

const Float quda::gauge_ghost_wrapper< Float, T >::phase

Definition at line 113 of file gauge_field_order.h.

---

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

• quda/include/gauge_field_order.h