tk::Around class

Helper class simplifying client code for iterating on entries surrounding entries via linked lists derived from unstructured mesh connectivity.

Contents

Constructors, destructors, conversion operators

Around(const List& list, std::size_t idx) explicit

Public functions

auto begin() const -> const_iterator noexcept
auto end() const -> const_iterator noexcept
auto cbegin() const -> const_iterator noexcept
auto cend() const -> const_iterator noexcept

Function documentation

tk::Around::Around(const List& list, std::size_t idx) explicit

Parameters
list in Linked list (vectors) storing derived data
idx in Index of entry whose surrounding items we will iterate on

Constructor

const_iterator tk::Around::begin() const noexcept

Returns Iterator to the beginning of the entries of surrounding entries

Const iterator to the beginning of the entries of surrounding entries

const_iterator tk::Around::end() const noexcept

Returns Iterator to the entry after the last of the surrounding entries

Const iterator to the entry after the last of the surrounding entries

const_iterator tk::Around::cbegin() const noexcept

Returns Iterator to the beginning of the entries of surrounding entries

Iterator to the beginning of the entries of surrounding entries

const_iterator tk::Around::cend() const noexcept

Returns Iterator to the entry after the last of the surrounding entries

Iterator to the entry after the last of the surrounding entries