walberla::grid_generator::SCGrid Class Reference

Detailed Description

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

Usage:

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

#include <SCIterator.h>

Public Types
using	iterator = SCIterator
using	value_type = iterator::value_type

Public Member Functions
	SCGrid (const AABB &domain, const Vector3< real_t > &pointOfReference, const real_t spacing)
	SCGrid (const AABB &domain, const Vector3< real_t > &pointOfReference, const Vector3< real_t > &spacing)
	begin iterator More...
SCIterator	begin ()
SCIterator	begin () const
SCIterator	cbegin () const
SCIterator	end ()
SCIterator	end () const
SCIterator	cend () const

Private Attributes
AABB	domain_
Vector3< real_t >	pointOfReference_
Vector3< real_t >	spacing_

Member Typedef Documentation

iterator

using walberla::grid_generator::SCGrid::iterator = SCIterator

value_type

using walberla::grid_generator::SCGrid::value_type = iterator::value_type

Constructor & Destructor Documentation

SCGrid() [1/2]

walberla::grid_generator::SCGrid::SCGrid ( 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, y and z direction

SCGrid() [2/2]

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

inline

begin iterator

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, y and z direction

Member Function Documentation

begin() [1/2]

SCIterator walberla::grid_generator::SCGrid::begin ( )

inline

begin() [2/2]

SCIterator walberla::grid_generator::SCGrid::begin ( ) const

inline

cbegin()

SCIterator walberla::grid_generator::SCGrid::cbegin ( ) const

inline

cend()

SCIterator walberla::grid_generator::SCGrid::cend ( ) const

inline

end() [1/2]

SCIterator walberla::grid_generator::SCGrid::end ( )

inline

end() [2/2]

SCIterator walberla::grid_generator::SCGrid::end ( ) const

inline

Member Data Documentation

domain_

AABB walberla::grid_generator::SCGrid::domain_

private

pointOfReference_

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

private

spacing_

Vector3<real_t> walberla::grid_generator::SCGrid::spacing_

private

---

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

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