walberla::grid_generator::HCPGrid Class Reference

Detailed Description

Convenience class to enable range based for loops over grid points.

Usage:

for (const auto& pt : HCPGrid(...) ) 

#include <HCPIterator.h>

Public Types
using	iterator = HCPIterator
using	value_type = iterator::value_type

Public Member Functions
	HCPGrid (const AABB &domain, const Vector3< real_t > &pointOfReference, const real_t spacing)
HCPIterator	begin ()
HCPIterator	begin () const
HCPIterator	cbegin () const
HCPIterator	end ()
HCPIterator	end () const
HCPIterator	cend () const

Private Attributes
AABB	domain_
Vector3< real_t >	pointOfReference_
real_t	spacing_

Member Typedef Documentation

iterator

using walberla::grid_generator::HCPGrid::iterator = HCPIterator

value_type

using walberla::grid_generator::HCPGrid::value_type = iterator::value_type

Constructor & Destructor Documentation

HCPGrid()

walberla::grid_generator::HCPGrid::HCPGrid ( const AABB & domain, const Vector3< real_t > & pointOfReference, const real_t spacing )

inline

Parameters

domain	volume were lattice points will be returned
pointOfReference	point somewhere in the world which fixes the lattice
spacing	spacing between grid points in x direction

Member Function Documentation

begin() [1/2]

HCPIterator walberla::grid_generator::HCPGrid::begin ( )

inline

begin() [2/2]

HCPIterator walberla::grid_generator::HCPGrid::begin ( ) const

inline

cbegin()

HCPIterator walberla::grid_generator::HCPGrid::cbegin ( ) const

inline

cend()

HCPIterator walberla::grid_generator::HCPGrid::cend ( ) const

inline

end() [1/2]

HCPIterator walberla::grid_generator::HCPGrid::end ( )

inline

end() [2/2]

HCPIterator walberla::grid_generator::HCPGrid::end ( ) const

inline

Member Data Documentation

domain_

AABB walberla::grid_generator::HCPGrid::domain_

private

pointOfReference_

Vector3<real_t> walberla::grid_generator::HCPGrid::pointOfReference_

private

spacing_

real_t walberla::grid_generator::HCPGrid::spacing_

private

---

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

• /builds/administration/walberla-website/walberla/src/core/grid_generator/HCPIterator.h