Skip to content

Class TempLat::FieldCollection

template <class Arg, int N, bool flatAssign, int SHIFTIND>

ClassList > TempLat > FieldCollection

A class which Field collections. Allows to have collection of composite vector fields as well.More...

  • #include <fieldcollection.h>

Public Types

Type Name
typedef GetComponent Getter
typedef GetGetReturnType< Arg >::type RT
typedef typename GetFloatType< RT >::type T

Public Static Attributes

Type Name
constexpr size_t NDim = GetNDim::get&lt;Arg&gt;()
constexpr size_t size = N

Public Functions

Type Name
FieldCollection (std::string name, device::memory::host_ptr< MemoryToolBox< NDim > > toolBox, LatticeParameters< T > pLatPar=LatticeParameters< T >())
FieldCollection (const FieldCollection &) = default
FieldCollection (FieldCollection &&) noexcept
auto getComp (Tag< M > t)
auto operator() (Tag< M > t) const
void operator+= (R && r)
FieldCollection & operator= (FieldCollection &&) noexcept
void operator= (R && r)
void operator= (const FieldCollection< Arg, N, flatAssign, SHIFTIND > & other)
auto operator[] (Tag< M > t) const
std::string toString (device::Idx i) const
~FieldCollection () = default

Detailed Description

Unit test: ctest -R test-fieldcollection

@vocab-summary \(N\) fields of any one type under a single tag-indexed name. @vocab-signature FieldCollection<FieldType, N> coll("coll", toolBox); @vocab-tags Collection

Public Types Documentation

typedef Getter

using TempLat::FieldCollection< Arg, N, flatAssign, SHIFTIND >::Getter =  GetComponent;

typedef RT

using TempLat::FieldCollection< Arg, N, flatAssign, SHIFTIND >::RT =  GetGetReturnType<Arg>::type;

typedef T

using TempLat::FieldCollection< Arg, N, flatAssign, SHIFTIND >::T =  typename GetFloatType<RT>::type;

Public Static Attributes Documentation

variable NDim

constexpr size_t TempLat::FieldCollection< Arg, N, flatAssign, SHIFTIND >::NDim;

variable size

constexpr size_t TempLat::FieldCollection< Arg, N, flatAssign, SHIFTIND >::size;

Public Functions Documentation

function FieldCollection [1/3]

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

function FieldCollection [2/3]

TempLat::FieldCollection::FieldCollection (
    const FieldCollection &
) = default

function FieldCollection [3/3]

TempLat::FieldCollection::FieldCollection (
    FieldCollection &&
) noexcept

function getComp

template<int M>
inline auto TempLat::FieldCollection::getComp (
    Tag < M > t
)

function operator()

template<int M>
inline auto TempLat::FieldCollection::operator() (
    Tag < M > t
) const

function operator+=

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

function operator=

FieldCollection & TempLat::FieldCollection::operator= (
    FieldCollection &&
) noexcept

function operator=

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

function operator=

inline void TempLat::FieldCollection::operator= (
    const FieldCollection < Arg, N, flatAssign, SHIFTIND > & other
)

function operator[]

template<int M>
inline auto TempLat::FieldCollection::operator[] (
    Tag < M > t
) const

function toString

inline std::string TempLat::FieldCollection::toString (
    device::Idx i
) const

function ~FieldCollection

TempLat::FieldCollection::~FieldCollection () = default

The documentation for this class was generated from the following file cosmolatticeweb/tmp/code_source/templat/include/TempLat/lattice/field/collections/fieldcollection.h