The field class implements the standard methods for accessing Fields. Hilapp replaces the parity access patterns, Field[par] with a loop over the appropriate sites. Since the Field class is one of the more important functionalities of HILA, extensive general instructions on the Field class can be read at HILA Functionality documentation. More...

#include <field.h>

Public Member Functions

Field ()

Field constructor.

void free ()

Destroys field data.

bool is_allocated () const

Returns true if the Field data has been allocated.

bool is_initialized (Parity p) const

Returns true if the Field has been assigned to.

void check_alloc ()

Allocate Field if it is not already allocated.

void set_boundary_condition (Direction dir, hila::bc bc)

Set the boundary condition in a given Direction (periodic or antiperiodic)

hila::bc get_boundary_condition (Direction dir) const

Get the boundary condition of the Field.

template<typename A >

void copy_boundary_condition (const Field< A > &rhs)

Copy the boundary condition from another field.

auto get_value_at (const unsigned i) const

Get an individual element outside a loop. This is also used as a getter in the vanilla code.

template<typename A >

void set_value_at (const A &value, unsigned i)

Set an individual element outside a loop. This is also used as a getter in the vanilla code.

dir_mask_t start_gather (Direction d, Parity p=ALL) const

Field< T > & shift (const CoordinateVector &v, Field< T > &r, Parity par) const

Create a periodically shifted copy of the field.

template<typename A , std::enable_if_t< std::is_assignable< T &, A >::value, int > = 0>

const T set_element (const CoordinateVector &coord, const A &value)

Get singular element which will be broadcast to all nodes.

const T get_element (const CoordinateVector &coord) const

Get singular element which will be broadcast to all nodes.

std::vector< T > get_elements (const std::vector< CoordinateVector > &coord_list, bool broadcast=false) const

Get a list of elements and store them into a vector.

std::vector< T > get_subvolume (const CoordinateVector &cmin, const CoordinateVector &cmax, bool broadcast=false) const

get a subvolume of the field elements to all nodes

std::vector< T > get_slice (const CoordinateVector &c, bool broadcast=false) const

and get a slice (subvolume)

Field< T > FFT (const CoordinateVector &dirs, fft_direction fdir=fft_direction::forward) const

Field method for performing FFT.

Field< Complex< hila::arithmetic_type< T > > > FFT_real_to_complex (fft_direction fdir=fft_direction::forward) const

Field< T > reflect (const CoordinateVector &dirs) const

void write (std::ofstream &outputfile, bool binary=true, int precision=8) const

Write the field to a file stream.

void write (const std::string &filename, bool binary=true, int precision=8) const

Write the Field to a named file replacing the file.

void read (std::ifstream &inputfile)

Read the Field from a stream.

void write_subvolume (std::ofstream &outputfile, const CoordinateVector &cmin, const CoordinateVector &cmax, int precision=6) const

T sum (Parity par=Parity::all, bool allreduce=true) const

Sum reduction of Field.

T product (Parity par=Parity::all, bool allreduce=true) const

Product reduction of Field.

T gpu_minmax (bool min_or_max, Parity par, CoordinateVector &loc) const

Declare gpu_reduce here, defined only for GPU targets.

T minmax (bool is_min, Parity par, CoordinateVector &loc) const

Function to perform min or max operations.

Standard arithmetic operations

Not all are always callable, e.g. division may not be implemented by all field types since division is not defined for all Field::T types.

Field< T > & operator= (const Field< T > &rhs)

Assignment operator.

Field< T > & operator= (Field< T > &&rhs)

Move Assignment.

template<typename A , std::enable_if_t< std::is_convertible< hila::type_plus< T, A >, T >::value, int > = 0>

Field< T > & operator+= (const Field< A > &rhs)

Addition assignment operator.

template<typename A , std::enable_if_t< std::is_convertible< hila::type_minus< T, A >, T >::value, int > = 0>

Field< T > & operator-= (const Field< A > &rhs)

Subtraction assignment operator.

template<typename A , std::enable_if_t< std::is_convertible< hila::type_mul< T, A >, T >::value, int > = 0>

Field< T > & operator*= (const Field< A > &rhs)

Product assignment operator.

template<typename A , std::enable_if_t< std::is_convertible< hila::type_div< T, A >, T >::value, int > = 0>

Field< T > & operator/= (const Field< A > &rhs)

Division assignment operator.

Field< T > operator+ () const

Unary + operator, acts as Identity.

Field< T > operator- () const

Unary - operator, acts as negation to all field elements.

template<typename S >

bool operator== (const Field< S > &rhs) const

Field comparison operator.

double squarenorm () const

Squarenorm.

double norm ()

Norm.

Field< T > conj () const

Returns field with all elements conjugated depending how conjugate is defined for type.

template<typename R = T, typename A = decltype(::dagger(std::declval<R>()))>

Field< A > dagger () const

Returns dagger or Hermitian conjugate of Field depending on how it is defined for Field type T.

template<typename R = T, typename A = decltype(::real(std::declval<R>()))>

Field< A > real () const

Returns real part of Field.

template<typename R = T, typename A = decltype(::imag(std::declval<R>()))>

Field< A > imag () const

Returns imaginary part of Field.

Min functions

Minimum value of Field. If CoordinateVector is passed to function then location of minimum value will be stored in said CoordinateVector

Parameters

par Parity

Returns: T Minimum value of Field

T min (Parity par=ALL) const

Find minimum value from Field.

T min (CoordinateVector &loc) const

Find minimum value and location from Field.

T min (Parity par, CoordinateVector &loc) const

Find minimum value and location from Field.

Max functions

Maximum value of Field. If CoordinateVector is passed to function then location of maximum value will be stored in said CoordinateVector

Parameters

par Parity

Returns: T Minimum value of Field

T max (Parity par=ALL) const

Find maximum value from Field.

T max (CoordinateVector &loc) const

Find maximum value and location from Field.

T max (Parity par, CoordinateVector &loc) const

Find maximum value and location from Field.

Public Attributes
field_struct *__restrict__	fs
	Field::fs holds all of the field content in Field::field_struct.

Detailed Description

template<typename T>
class Field< T >

The field class implements the standard methods for accessing Fields. Hilapp replaces the parity access patterns, Field[par] with a loop over the appropriate sites. Since the Field class is one of the more important functionalities of HILA, extensive general instructions on the Field class can be read at HILA Functionality documentation.

The Field class contains member functions used by hilapp, which are marked internal, as well as members that are useful for application developers.

The Field mainly implements the interface to the Field and not the content.

The Field contains a pointer to Field::field_struct, which implements MPI communication of the Field boundaries. Though generally the application developer does not need to worry about the Field::field_struct class, hence it is marked as internal and it's documentation cannot be viewed in the Web documentation.

The Field::field_struct points to a field_storage, which is defined by each backend. It implements storing and accessing the Field data, including buffers for storing haloes returned from MPI communication.

Template Parameters

T	Field content type

Definition at line 61 of file field.h.

Constructor & Destructor Documentation

◆ Field()

template<typename T >

Field< T >::Field ( )

inline

Field constructor.

The following ways of constructing a Field object are the following:

Default constructor:

Assigns Field::fs to nullptr.

Field<MyType> f;

Field

The field class implements the standard methods for accessing Fields. Hilapp replaces the parity acce...

Definition field.h:61

Copy constructor:

Copy from already existing field of similar type if conversion exists. For example for float to double.

Field<MyType> f = g;

Assignment from constant constructor:

Assign constant to field if conversion exists.

.
. Let a be a constant of type MyType1
.
Field<MyType2> f = a;

Definition at line 277 of file field.h.

Member Function Documentation

◆ check_alloc()

template<typename T >

void Field< T >::check_alloc ( )

inline

Allocate Field if it is not already allocated.

Check that Field is allocated, and if not do it (if not const). Must be called before the var is actually used. "hilapp" will generate these calls as needed!

If Field is const assert that the Field is allocated.

Definition at line 459 of file field.h.

◆ conj()

template<typename T >

Field< T > Field< T >::conj ( ) const

inline

Returns field with all elements conjugated depending how conjugate is defined for type.

Returns: Field<T>

Definition at line 1110 of file field.h.

◆ copy_boundary_condition()

template<typename T >

template<typename A >

void Field< T >::copy_boundary_condition ( const Field< A > & rhs )

inline

Copy the boundary condition from another field.

Template Parameters

A	the type of the field which we are copying from

Parameters

rhs	the ohter Field

Definition at line 650 of file field.h.

◆ dagger()

template<typename T >

template<typename R = T, typename A = decltype(::dagger(std::declval<R>()))>

Field< A > Field< T >::dagger ( ) const

inline

Returns dagger or Hermitian conjugate of Field depending on how it is defined for Field type T.

Returns: Field<T>

Definition at line 1123 of file field.h.

◆ FFT()

template<typename T >

Field< T > Field< T >::FFT	(	const CoordinateVector &	dirs,
		fft_direction	fftdir = `fft_direction::forward`
	)		const

Field method for performing FFT.

By default calling without arguments will execute FFT in all directions.

.
. // Field f is defined
.
auto res = f.FFT() //Forward transform
auto res_2 = res.FFT(fft_direction::back) // res_2 is same as f

One can also specify the direction of the FFT with a coordinate vector:

.
. // Field f is defined
.
auto res = f.FFT(e_x) //Forward transform in x-direction
auto res_2 = res.FFT(e_X,fft_direction::back) // res_2 is same as f

With this in mind f.FFT(e_x+e_y+e_z) = f.FFT()

Template Parameters

T

Parameters

dirs	Direction to perform FFT in, default is all directions
fftdir	fft_direction::forward (default) or fft_direction::back

Returns: Field<T> Transformed field

Definition at line 444 of file fft.h.

◆ FFT_real_to_complex()

template<typename T >

Field< Complex< hila::arithmetic_type< T > > > Field< T >::FFT_real_to_complex ( fft_direction fftdir = fft_direction::forward ) const

FFT_real_to_complex: Field must be a real-valued field, result is a complex-valued field of the same type Implemented just by doing a FFT with a complex field with im=0; fft_direction::back gives a complex conjugate of the forward transform Result is f(-x) = f(L - x) = f(x)^*

Definition at line 467 of file fft.h.

◆ free()

template<typename T >

void Field< T >::free ( )

inline

Destroys field data.

don't call destructors when exiting - either MPI or cuda can already be off.

Definition at line 407 of file field.h.

◆ get_boundary_condition()

template<typename T >

hila::bc Field< T >::get_boundary_condition ( Direction dir ) const

inline

Get the boundary condition of the Field.

Parameters

dir	Boundary condition in certain direction

Returns: hila::bc The boundary condition of the Field

Definition at line 626 of file field.h.

◆ get_element()

template<typename T >

const T Field< T >::get_element ( const CoordinateVector & coord ) const

inline

Get singular element which will be broadcast to all nodes.

Parameters

coord coordinate of fetched element

Returns: const T

Definition at line 1221 of file field.h.

◆ get_value_at()

template<typename T >

auto Field< T >::get_value_at ( const unsigned i ) const

inline

Get an individual element outside a loop. This is also used as a getter in the vanilla code.

Parameters

i

Returns: auto

Definition at line 684 of file field.h.

◆ imag()

template<typename T >

template<typename R = T, typename A = decltype(::imag(std::declval<R>()))>

Field< A > Field< T >::imag ( ) const

inline

Returns imaginary part of Field.

Template Parameters

R	Field current type
A	Field imaginary part type

Returns: Field

Definition at line 1151 of file field.h.

◆ is_allocated()

template<typename T >

bool Field< T >::is_allocated ( ) const

inline

Returns true if the Field data has been allocated.

Returns: bool

Definition at line 422 of file field.h.

◆ is_initialized()

template<typename T >

bool Field< T >::is_initialized ( Parity p ) const

inline

Returns true if the Field has been assigned to.

Parameters

p	Field parity

Returns: bool

Definition at line 431 of file field.h.

◆ norm()

template<typename T >

double Field< T >::norm ( )

inline

Norm.

Norm of Field depending on how it is defined for Field type T

\(|f| = \sqrt{\sum_{\forall x \in f} |x|^2}\)

If norm is defined for type T then the definition can be seen on the types documentation page.

Returns: double

Definition at line 1101 of file field.h.

◆ operator*=()

template<typename T >

template<typename A , std::enable_if_t< std::is_convertible< hila::type_mul< T, A >, T >::value, int > = 0>

Field< T > & Field< T >::operator*= ( const Field< A > & rhs )

inline

Product assignment operator.

Product assignment operator can be called in the following ways as long as types are convertible.

Product assignment with field:

Field<MyType> f,g;
. . .
f *= g;

Product assignment with scalar:

Field<MyType> f;
MyType a;
. . .
f *= a;

Template Parameters

A	Type of r.h.s element

Parameters

rhs	Field to compute product with

Returns: Field<T>&

Definition at line 931 of file field.h.

◆ operator+()

template<typename T >

Field< T > Field< T >::operator+ ( ) const

inline

Unary + operator, acts as Identity.

Returns: Field<T> Returns itself

Definition at line 1037 of file field.h.

◆ operator+=()

template<typename T >

template<typename A , std::enable_if_t< std::is_convertible< hila::type_plus< T, A >, T >::value, int > = 0>

Field< T > & Field< T >::operator+= ( const Field< A > & rhs )

inline

Addition assignment operator.

Addition assignmen operator can be called in the following ways as long as types are convertible.

Addition assignment with field:

Field<MyType> f,g;
. . .
f += g;

Addition assignment with scalar:

Field<MyType> f;
MyType a;
. . .
f += a;

Template Parameters

A	Type of r.h.s element

Parameters

rhs	Field to sum

Returns: Field<T>&

Definition at line 865 of file field.h.

◆ operator-()

template<typename T >

Field< T > Field< T >::operator- ( ) const

inline

Unary - operator, acts as negation to all field elements.

Returns: Field<T> Returns negated version of itself

Definition at line 1046 of file field.h.

◆ operator-=()

template<typename T >

template<typename A , std::enable_if_t< std::is_convertible< hila::type_minus< T, A >, T >::value, int > = 0>

Field< T > & Field< T >::operator-= ( const Field< A > & rhs )

inline

Subtraction assignment operator.

Subtraction assignment operator can be called in the following ways as long as types are convertible.

Subtraction assignment with field:

Field<MyType> f,g;
. . .
f -= g;

Subtraction assignment with scalar:

Field<MyType> f;
MyType a;
. . .
f -= a;

Template Parameters

A	Type of r.h.s element

Parameters

rhs	Field to subtract

Returns: Field<T>&

Definition at line 898 of file field.h.

◆ operator/=()

template<typename T >

template<typename A , std::enable_if_t< std::is_convertible< hila::type_div< T, A >, T >::value, int > = 0>

Field< T > & Field< T >::operator/= ( const Field< A > & rhs )

inline

Division assignment operator.

Division assignment operator can be called in the following ways as long as types are convertible.

Division assignment with field:

Field<MyType> f,g;
. . .
f /= g;

Division assignment with scalar:

Field<MyType> f;
MyType a;
. . .
f /= a;

Template Parameters

A	Type of r.h.s element

Parameters

rhs	Field to divide with

Returns: Field<T>&

Definition at line 964 of file field.h.

◆ operator=() [1/2]

template<typename T >

Field< T > & Field< T >::operator= ( const Field< T > & rhs )

inline

Assignment operator.

Assignment can be performed in the following ways:

Assignment from field:

Assignment from field is possible if types are the same or convertible

f = g;

Assignment from scalar:

Assignment from scalar is possible if scalar is convertible to Field type

f = a; // a is a scalar

Parameters

rhs

Returns: Field<T>& Assigned field

Definition at line 755 of file field.h.

◆ operator=() [2/2]

template<typename T >

Field< T > & Field< T >::operator= ( Field< T > && rhs )

inline

Move Assignment.

Parameters

rhs

Returns: Field<T>&

Definition at line 828 of file field.h.

◆ operator==()

template<typename T >

template<typename S >

bool Field< T >::operator== ( const Field< S > & rhs ) const

inline

Field comparison operator.

Fields are equal if their content is element-by-element equal

Parameters

rhs	Field to compare Field with

Returns: true; false

Definition at line 1061 of file field.h.

◆ product()

template<typename T >

T Field< T >::product	(	Parity	par = `Parity::all`,
		bool	allreduce = `true`
	)		const

Product reduction of Field.

The product in the reduction is defined by the Field type T.

Parameters

par	Parity
allreduce	Switch to turn on or off MPI allreduce

Returns: T Field element type reduced to one element

Definition at line 306 of file reduction.h.

◆ real()

template<typename T >

template<typename R = T, typename A = decltype(::real(std::declval<R>()))>

Field< A > Field< T >::real ( ) const

inline

Returns real part of Field.

Template Parameters

R	Field current type
A	Field real part type

Returns: Field

Definition at line 1137 of file field.h.

◆ reflect()

template<typename T >

Field< T > Field< T >::reflect ( const CoordinateVector & dirs ) const

Field<T>::reflect() reflects the field around the desired axis This is here because it uses similar communications as fft TODO: refactorise so that there is separate "make columns" class!

Definition at line 560 of file fft.h.

◆ set_boundary_condition()

template<typename T >

void Field< T >::set_boundary_condition	(	Direction	dir,
		hila::bc	bc
	)

inline

Set the boundary condition in a given Direction (periodic or antiperiodic)

Parameters

dir	Direction of boundary condition
bc	Field boundary condition

Definition at line 580 of file field.h.

◆ set_element()

template<typename T >

template<typename A , std::enable_if_t< std::is_assignable< T &, A >::value, int > = 0>

const T Field< T >::set_element	(	const CoordinateVector &	coord,
		const A &	value
	)

inline

Get singular element which will be broadcast to all nodes.

Set a single element. Assuming that each node calls this with the same value, it is sufficient to set the element locally

Works as long as value type A and field type T match

Template Parameters

A type

Parameters

coord	Coordinate of element to be set
value	Value to be set

Returns: const T

Definition at line 1204 of file field.h.

◆ set_value_at()

template<typename T >

template<typename A >

void Field< T >::set_value_at	(	const A &	value,
		unsigned	i
	)

inline

Set an individual element outside a loop. This is also used as a getter in the vanilla code.

Parameters

i

Returns: auto

Definition at line 709 of file field.h.

◆ shift()

template<typename T >

Field< T > & Field< T >::shift	(	const CoordinateVector &	v,
		Field< T > &	r,
		Parity	par
	)		const

Create a periodically shifted copy of the field.

this is currently OK only for short moves, very inefficient for longer moves

.
. //Field<MyType> f is defined
.
CoordinateVector v = {1,1,0}
f.shift(v) // Shift all elements of field once in the x direction and once in the y direction
f.shift(v,EVEN) // Shift all EVEN elements of field once in the x direction and once in the y
direction

Parameters

v
par
r

Returns: Field<T>& returns a reference to res

Definition at line 162 of file field_comm.h.

◆ squarenorm()

template<typename T >

double Field< T >::squarenorm ( ) const

inline

Squarenorm.

Squarenorm of Field \(f\) is dependent on how it is defined for Field type T.

\(|f|^2 = \sum_{\forall x \in f} |x|^2\)

If squarenorm is defined for type T then the definition can be seen on the types documentation page.

Returns: double

Definition at line 1083 of file field.h.

◆ start_gather()

template<typename T >

dir_mask_t Field< T >::start_gather	(	Direction	d,
		Parity	p = `ALL`
	)		const

start_gather(): Communicate the field at Parity par from Direction d. Uses accessors to prevent dependency on the layout. return the Direction mask bits where something is happening

Definition at line 262 of file field_comm.h.

◆ sum()

template<typename T >

T Field< T >::sum	(	Parity	par = `Parity::all`,
		bool	allreduce = `true`
	)		const

Sum reduction of Field.

The sum in the reduction is defined by the Field type T

Parameters

par	Parity
allreduce	Switch to turn on or off MPI allreduce

Returns: T Field element type reduced to one element

Definition at line 296 of file reduction.h.

◆ write_subvolume()

template<typename T >

void Field< T >::write_subvolume	(	std::ofstream &	outputfile,
		const CoordinateVector &	cmin,
		const CoordinateVector &	cmax,
		int	precision = `6`
	)		const

Write a "subspace" of the original lattice Each element is written on a single line TODO: more formatting?

Definition at line 215 of file field_io.h.

Member Data Documentation

◆ fs

template<typename T >

field_struct* __restrict__ Field< T >::fs

Field::fs holds all of the field content in Field::field_struct.

The field_struct class is nonetheless marked as internal so the user need not worry about it.

Definition at line 243 of file field.h.

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

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Field()

Member Function Documentation

◆ check_alloc()

◆ conj()

◆ copy_boundary_condition()

◆ dagger()

◆ FFT()

◆ FFT_real_to_complex()

◆ free()

◆ get_boundary_condition()

◆ get_element()

◆ get_value_at()

◆ imag()

◆ is_allocated()

◆ is_initialized()

◆ norm()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ product()

◆ real()

◆ reflect()

◆ set_boundary_condition()

◆ set_element()

◆ set_value_at()

◆ shift()

◆ squarenorm()

◆ start_gather()

◆ sum()

◆ write_subvolume()

Member Data Documentation

◆ fs