File yboundary_regions.hxx#

class YBoundary#
#include <yboundary_regions.hxx>

This class allows to simplify iterating over y-boundaries.

It makes it easier to write code for FieldAligned boundaries, but if a bit care is taken the code also works with FluxCoordinateIndependent code.

An example how to replace old code is given here: ../../manual/sphinx/user_docs/boundary_options.rst

Public Functions

template<class F>
inline void iter_regions(const F &f)#
template<class F>
inline void iter_pnts(const F &f)#
template<class F>
inline void iter(const F &f)#
inline void init(Options &options, Mesh *mesh = nullptr)#

Private Members

std::vector<std::shared_ptr<BoundaryRegionPar>> boundary_regions_par#
std::vector<std::shared_ptr<NewBoundaryRegionY>> boundary_regions#
bool is_init = {false}#