#include <clover_field_order.h>

Public Member Functions
	FieldOrder (CloverField &A, bool inverse=false)

CloverField &	Field ()

__device__ __host__ const complex< Float >	operator() (int parity, int x, int s_row, int s_col, int c_row, int c_col) const
	Read-only complex-member accessor function. More...

__device__ __host__ complex< Float >	operator() (int dummy, int parity, int x, int s_row, int s_col, int c_row, int c_col) const
	Read-only complex-member accessor function. This is a special variant that is compatible with the equivalent gauge::FieldOrder accessor so these can be used interchangebly in templated code. More...

__device__ __host__ int	Ncolor () const
	Complex-member accessor function. More...

__device__ __host__ int	Volume () const

__device__ __host__ int	VolumeCB () const

size_t	Bytes () const

__host__ double	norm1 (int dim=-1, bool global=true) const
	Returns the L1 norm of the field. More...

__host__ double	norm2 (int dim=-1, bool global=true) const
	Returns the L2 norm suared of the field. More...

__host__ double	abs_max (int dim=-1, bool global=true) const
	Returns the Linfinity norm of the field. More...

__host__ double	abs_min (int dim=-1, bool global=true) const
	Returns the minimum absolute value of the field. More...

Static Public Attributes
static constexpr bool	supports_ghost_zone = false

Protected Attributes
CloverField &	A

const int	volumeCB

const Accessor< Float, nColor, nSpin, order >	accessor

bool	inverse

const QudaFieldLocation	location

Detailed Description

template<typename Float, int nColor, int nSpin, QudaCloverFieldOrder order>
struct quda::clover::FieldOrder< Float, nColor, nSpin, order >

This is a template driven generic clover field accessor. To deploy for a specifc field ordering, the two operator() accessors have to be specialized for that ordering.

Definition at line 373 of file clover_field_order.h.

Constructor & Destructor Documentation

◆ FieldOrder()

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

quda::clover::FieldOrder< Float, nColor, nSpin, order >::FieldOrder	(	CloverField &	A,
		bool	inverse = `false`
	)

inline

Constructor for the FieldOrder class

Parameters

field The field that we are accessing

Definition at line 391 of file clover_field_order.h.

Member Function Documentation

◆ abs_max()

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

__host__ double quda::clover::FieldOrder< Float, nColor, nSpin, order >::abs_max	(	int	dim = `-1`,
		bool	global = `true`
	)		const

inline

Returns the Linfinity norm of the field.

Parameters

[in] dim Which dimension we are taking the Linfinity norm of (dummy for clover)

Returns: Linfinity norm

Definition at line 492 of file clover_field_order.h.

◆ abs_min()

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

__host__ double quda::clover::FieldOrder< Float, nColor, nSpin, order >::abs_min	(	int	dim = `-1`,
		bool	global = `true`
	)		const

inline

Returns the minimum absolute value of the field.

Parameters

[in] dim Which dimension we are taking the minimum abs of (dummy for clover)

Returns: Minimum norm

Definition at line 503 of file clover_field_order.h.

◆ Bytes()

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

size_t quda::clover::FieldOrder< Float, nColor, nSpin, order >::Bytes ( ) const

inline

Return the size of the allocation (parity left out and added as needed in Tunable::bytes)

Definition at line 459 of file clover_field_order.h.

◆ Field()

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

CloverField& quda::clover::FieldOrder< Float, nColor, nSpin, order >::Field ( )

inline

Definition at line 395 of file clover_field_order.h.

◆ Ncolor()

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

__device__ __host__ int quda::clover::FieldOrder< Float, nColor, nSpin, order >::Ncolor ( ) const

inline

Complex-member accessor function.

Parameters

parity	Parity index
x	1-d site index
s_row	row spin index
c_row	row color index
s_col	col spin index
c_col	col color index Returns the number of field colors

Definition at line 450 of file clover_field_order.h.

◆ norm1()

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

__host__ double quda::clover::FieldOrder< Float, nColor, nSpin, order >::norm1	(	int	dim = `-1`,
		bool	global = `true`
	)		const

inline

Returns the L1 norm of the field.

Parameters

[in] dim Which dimension we are taking the norm of (dummy for clover)

Returns: L1 norm

Definition at line 470 of file clover_field_order.h.

◆ norm2()

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

__host__ double quda::clover::FieldOrder< Float, nColor, nSpin, order >::norm2	(	int	dim = `-1`,
		bool	global = `true`
	)		const

inline

Returns the L2 norm suared of the field.

Parameters

[in] dim Which dimension we are taking the norm of (dummy for clover)

Returns: L1 norm

Definition at line 481 of file clover_field_order.h.

◆ operator()() [1/2]

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

__device__ __host__ complex<Float> quda::clover::FieldOrder< Float, nColor, nSpin, order >::operator()	(	int	dummy,
		int	parity,
		int	x,
		int	s_row,
		int	s_col,
		int	c_row,
		int	c_col
	)		const

inline

Read-only complex-member accessor function. This is a special variant that is compatible with the equivalent gauge::FieldOrder accessor so these can be used interchangebly in templated code.

Parameters

dummy	Dummy parameter that is ignored
parity	Parity index
x	1-d site index
s_row	row spin index
c_row	row color index
s_col	col spin index
c_col	col color index

Definition at line 426 of file clover_field_order.h.

◆ operator()() [2/2]

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

__device__ __host__ const complex<Float> quda::clover::FieldOrder< Float, nColor, nSpin, order >::operator()	(	int	parity,
		int	x,
		int	s_row,
		int	s_col,
		int	c_row,
		int	c_col
	)		const

inline

Read-only complex-member accessor function.

Parameters

parity	Parity index
x	1-d site index
s_row	row spin index
c_row	row color index
s_col	col spin index
c_col	col color index

Definition at line 407 of file clover_field_order.h.

◆ Volume()

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

__device__ __host__ int quda::clover::FieldOrder< Float, nColor, nSpin, order >::Volume ( ) const

inline

Returns the field volume

Definition at line 453 of file clover_field_order.h.

◆ VolumeCB()

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

__device__ __host__ int quda::clover::FieldOrder< Float, nColor, nSpin, order >::VolumeCB ( ) const

inline

Returns the field volume

Definition at line 456 of file clover_field_order.h.

Member Data Documentation

◆ A

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

CloverField& quda::clover::FieldOrder< Float, nColor, nSpin, order >::A

protected

An internal reference to the actual field we are accessing

Definition at line 380 of file clover_field_order.h.

◆ accessor

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

const Accessor<Float, nColor, nSpin, order> quda::clover::FieldOrder< Float, nColor, nSpin, order >::accessor

protected

Definition at line 382 of file clover_field_order.h.

◆ inverse

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

bool quda::clover::FieldOrder< Float, nColor, nSpin, order >::inverse

protected

Definition at line 383 of file clover_field_order.h.

◆ location

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

const QudaFieldLocation quda::clover::FieldOrder< Float, nColor, nSpin, order >::location

protected

Definition at line 384 of file clover_field_order.h.

◆ supports_ghost_zone

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

constexpr bool quda::clover::FieldOrder< Float, nColor, nSpin, order >::supports_ghost_zone = false

staticconstexpr

Does this field type support ghost zones?

Definition at line 376 of file clover_field_order.h.

◆ volumeCB

template<typename Float , int nColor, int nSpin, QudaCloverFieldOrder order>

const int quda::clover::FieldOrder< Float, nColor, nSpin, order >::volumeCB

protected

Definition at line 381 of file clover_field_order.h.

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

quda/include/clover_field_order.h

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

template<typename Float, int nColor, int nSpin, QudaCloverFieldOrder order> struct quda::clover::FieldOrder< Float, nColor, nSpin, order >

Constructor & Destructor Documentation

◆ FieldOrder()

Member Function Documentation

◆ abs_max()

◆ abs_min()

◆ Bytes()

◆ Field()

◆ Ncolor()

◆ norm1()

◆ norm2()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ Volume()

◆ VolumeCB()

Member Data Documentation

◆ A

◆ accessor

◆ inverse

◆ location

◆ supports_ghost_zone

◆ volumeCB

template<typename Float, int nColor, int nSpin, QudaCloverFieldOrder order>
struct quda::clover::FieldOrder< Float, nColor, nSpin, order >