Class TempLat::ComplexField

template <typename T, size_t _NDim>

ClassList > TempLat > ComplexField

A class which implements complex-valued fields. More...

• #include <complexfield.h>

Public Types

Type	Name
typedef ComplexFieldGetter	Getter

Public Static Attributes

Type	Name
constexpr size_t	NDim = \_NDim
constexpr size_t	SHIFTIND = 0
constexpr size_t	size = 2

Public Functions

Type	Name
	ComplexField (Field< T, NDim > f1, Field< T, NDim > f2)
	ComplexField (std::string name, device::memory::host_ptr< MemoryToolBox< NDim > > toolBox, LatticeParameters< T > pLatPar=LatticeParameters< T >())
auto &	ComplexFieldGet (Tag< 0 > t)
const auto &	ComplexFieldGet (Tag< 0 > t) const
auto &	ComplexFieldGet (Tag< 1 > t)
const auto &	ComplexFieldGet (Tag< 1 > t) const
DEVICE_INLINE_FUNCTION auto	eval (const IDX &... idx) const
auto	getDx () const
auto	getKIR () const
ComplexFieldFourierView< T, NDim >	inFourierSpace ()
auto &	operator() (Tag< 0 > t)
const auto &	operator() (Tag< 0 > t) const
auto &	operator() (Tag< 1 > t)
const auto &	operator() (Tag< 1 > t) const
auto &	operator() (Tag< N > t)
const auto &	operator() (Tag< N > t) const
void	operator+= (R && r)
void	operator= (R && g)
void	setGhostsAreStale ()
std::string	toString () const
void	updateGhosts ()

Detailed Description

Unit test: ctest -R test-complexfield

@vocab-summary A complex scalar field, stored as two real components. @vocab-signature ComplexField<T, NDim> psi("psi", toolBox);

Public Types Documentation

typedef Getter

using TempLat::ComplexField< T, _NDim >::Getter =  ComplexFieldGetter;

---

Public Static Attributes Documentation

variable NDim

constexpr size_t TempLat::ComplexField< T, _NDim >::NDim;

---

variable SHIFTIND

constexpr size_t TempLat::ComplexField< T, _NDim >::SHIFTIND;

---

variable size

constexpr size_t TempLat::ComplexField< T, _NDim >::size;

---

Public Functions Documentation

function ComplexField [1/2]

inline TempLat::ComplexField::ComplexField (
    Field < T, NDim > f1,
    Field < T, NDim > f2
) 

---

function ComplexField [2/2]

inline TempLat::ComplexField::ComplexField (
    std::string name,
    device::memory::host_ptr < MemoryToolBox < NDim > > toolBox,
    LatticeParameters < T > pLatPar=LatticeParameters < T >()
) 

---

function ComplexFieldGet [1/4]

inline auto & TempLat::ComplexField::ComplexFieldGet (
    Tag < 0 > t
) 

---

function ComplexFieldGet [2/4]

inline const auto & TempLat::ComplexField::ComplexFieldGet (
    Tag < 0 > t
) const

---

function ComplexFieldGet [3/4]

inline auto & TempLat::ComplexField::ComplexFieldGet (
    Tag < 1 > t
) 

---

function ComplexFieldGet [4/4]

inline const auto & TempLat::ComplexField::ComplexFieldGet (
    Tag < 1 > t
) const

---

function eval

template<typename... IDX>
inline DEVICE_INLINE_FUNCTION auto TempLat::ComplexField::eval (
    const IDX &... idx
) const

---

function getDx

inline auto TempLat::ComplexField::getDx () const

---

function getKIR

inline auto TempLat::ComplexField::getKIR () const

---

function inFourierSpace

inline ComplexFieldFourierView < T, NDim > TempLat::ComplexField::inFourierSpace () 

---

function operator()

inline auto & TempLat::ComplexField::operator() (
    Tag < 0 > t
) 

---

function operator()

inline const auto & TempLat::ComplexField::operator() (
    Tag < 0 > t
) const

---

function operator()

inline auto & TempLat::ComplexField::operator() (
    Tag < 1 > t
) 

---

function operator()

inline const auto & TempLat::ComplexField::operator() (
    Tag < 1 > t
) const

---

function operator()

template<int N>
inline auto & TempLat::ComplexField::operator() (
    Tag < N > t
) 

---

function operator()

template<int N>
inline const auto & TempLat::ComplexField::operator() (
    Tag < N > t
) const

---

function operator+=

template<typename R>
inline void TempLat::ComplexField::operator+= (
    R && r
) 

---

function operator=

template<typename R>
inline void TempLat::ComplexField::operator= (
    R && g
) 

---

function setGhostsAreStale

inline void TempLat::ComplexField::setGhostsAreStale () 

---

function toString

inline std::string TempLat::ComplexField::toString () const

---

function updateGhosts

inline void TempLat::ComplexField::updateGhosts () 

---

---

The documentation for this class was generated from the following file cosmolatticeweb/tmp/code_source/templat/include/TempLat/lattice/algebra/complexalgebra/complexfield.h