OpenLB 1.8.1
Loading...
Searching...
No Matches
olb::refinement::ContextDataWithNeighbors< DATA > Class Template Reference

#include <coarseCell.h>

+ Collaboration diagram for olb::refinement::ContextDataWithNeighbors< DATA >:

Public Types

using value_t = typename DATA::value_t
 
using descriptor_t = typename DATA::descriptor_t
 

Public Member Functions

 ContextDataWithNeighbors (DATA &&data) any_platform
 
 ContextDataWithNeighbors (const DATA &data) any_platform
 
 ContextDataWithNeighbors (const ContextDataWithNeighbors &rhs) any_platform
 
 operator bool () const any_platform
 
DATA & operator* () any_platform
 
DATA * operator-> () any_platform
 
ContextDataWithNeighbors neighbor (unsigned iN) any_platform
 

Detailed Description

template<typename DATA>
class olb::refinement::ContextDataWithNeighbors< DATA >

Definition at line 114 of file coarseCell.h.

Member Typedef Documentation

◆ descriptor_t

template<typename DATA >
using olb::refinement::ContextDataWithNeighbors< DATA >::descriptor_t = typename DATA::descriptor_t

Definition at line 120 of file coarseCell.h.

◆ value_t

template<typename DATA >
using olb::refinement::ContextDataWithNeighbors< DATA >::value_t = typename DATA::value_t

Definition at line 119 of file coarseCell.h.

Constructor & Destructor Documentation

◆ ContextDataWithNeighbors() [1/3]

template<typename DATA >
olb::refinement::ContextDataWithNeighbors< DATA >::ContextDataWithNeighbors ( DATA && data)
inline

Definition at line 122 of file coarseCell.h.

123 : _data{std::move(data)}
124 { }

◆ ContextDataWithNeighbors() [2/3]

template<typename DATA >
olb::refinement::ContextDataWithNeighbors< DATA >::ContextDataWithNeighbors ( const DATA & data)
inline

Definition at line 126 of file coarseCell.h.

127 : _data{data}
128 { }

◆ ContextDataWithNeighbors() [3/3]

template<typename DATA >
olb::refinement::ContextDataWithNeighbors< DATA >::ContextDataWithNeighbors ( const ContextDataWithNeighbors< DATA > & rhs)
inline

Definition at line 130 of file coarseCell.h.

131 : _data(rhs._data)
132 { }

Member Function Documentation

◆ neighbor()

template<typename DATA >
ContextDataWithNeighbors olb::refinement::ContextDataWithNeighbors< DATA >::neighbor ( unsigned iN)
inline

Definition at line 146 of file coarseCell.h.

146 {
147 auto data = _data;
148 const CellID index = data.template getFieldComponent<fields::refinement::CONTEXT_NEIGHBORS>(iN);
149 data.setCellId(index);
150 return ContextDataWithNeighbors{data};
151 }
ContextDataWithNeighbors(DATA &&data) any_platform
Definition coarseCell.h:122
std::uint32_t CellID
Type for sequential block-local cell indices.

◆ operator bool()

template<typename DATA >
olb::refinement::ContextDataWithNeighbors< DATA >::operator bool ( ) const
inline

Definition at line 134 of file coarseCell.h.

134 {
135 return _data.getCellId() != std::numeric_limits<CellID>::max();
136 }

◆ operator*()

template<typename DATA >
DATA & olb::refinement::ContextDataWithNeighbors< DATA >::operator* ( )
inline

Definition at line 138 of file coarseCell.h.

138 {
139 return _data;
140 }

◆ operator->()

template<typename DATA >
DATA * olb::refinement::ContextDataWithNeighbors< DATA >::operator-> ( )
inline

Definition at line 142 of file coarseCell.h.

142 {
143 return &_data;
144 }

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