QUDA  v1.1.0
A library for QCD on GPUs
Public Member Functions | Public Attributes | Protected Attributes | List of all members
quda::LatticeFieldParam Struct Reference

#include <lattice_field.h>

+ Inheritance diagram for quda::LatticeFieldParam:

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 48 of file lattice_field.h.

Constructor & Destructor Documentation

◆ LatticeFieldParam() [1/4]

quda::LatticeFieldParam::LatticeFieldParam ( )
inline

Default constructor for LatticeFieldParam.

Definition at line 88 of file lattice_field.h.

◆ 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]nDimNumber of field dimensions
[in]xArray of dimension lengths
[in]padField padding
[in]precisionField Precision
[in]ghostExchangeType of ghost exchange

Definition at line 107 of file lattice_field.h.

◆ 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]paramContains the metadata for filling out the LatticeFieldParam

Definition at line 126 of file lattice_field.h.

◆ LatticeFieldParam() [4/4]

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

Contructor for creating LatticeFieldParam from a LatticeField.

Definition at line 49 of file lattice_field.cpp.

Member Function Documentation

◆ GhostPrecision()

QudaPrecision quda::LatticeFieldParam::GhostPrecision ( ) const
inline

Ghost precision

Definition at line 62 of file lattice_field.h.

◆ Precision()

QudaPrecision quda::LatticeFieldParam::Precision ( ) const
inline

Field precision

Definition at line 59 of file lattice_field.h.

Member Data Documentation

◆ ghost_precision

QudaPrecision quda::LatticeFieldParam::ghost_precision
protected

Ghost precision

Definition at line 55 of file lattice_field.h.

◆ ghostExchange

QudaGhostExchange quda::LatticeFieldParam::ghostExchange

The type of ghost exchange to be done with this field

Definition at line 77 of file lattice_field.h.

◆ mem_type

QudaMemoryType quda::LatticeFieldParam::mem_type

Definition at line 74 of file lattice_field.h.

◆ nDim

int quda::LatticeFieldParam::nDim

Number of field dimensions

Definition at line 65 of file lattice_field.h.

◆ pad

int quda::LatticeFieldParam::pad

Definition at line 70 of file lattice_field.h.

◆ precision

QudaPrecision quda::LatticeFieldParam::precision
protected

Field precision

Definition at line 52 of file lattice_field.h.

◆ r

int quda::LatticeFieldParam::r[QUDA_MAX_DIM]

The extended field radius (if applicable)

Definition at line 80 of file lattice_field.h.

◆ scale

double quda::LatticeFieldParam::scale

For fixed-point fields that need a global scaling factor

Definition at line 83 of file lattice_field.h.

◆ siteSubset

QudaSiteSubset quda::LatticeFieldParam::siteSubset

Definition at line 72 of file lattice_field.h.

◆ x

int quda::LatticeFieldParam::x[QUDA_MAX_DIM]

Array storing the length of dimension

Definition at line 68 of file lattice_field.h.


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