Base of a regular block. More...

#include <blockStructure.h>

Inheritance diagram for olb::BlockStructureD< D >:

Collaboration diagram for olb::BlockStructureD< D >:

Public Member Functions
	BlockStructureD (Vector< int, D > size, int padding=0)

	BlockStructureD ()

int	getNx () const
	Read only access to block width.

int	getNy () const
	Read only access to block height.

int	getNz () const
	Read only access to block height.

LatticeR< D >	getExtent () const

int	getPadding () const
	Read only access to padding.

std::size_t	getNcells () const
	Get number of cells.

CellID	getCellId (LatticeR< D > latticeR) const
	Get 1D cell ID.

template<typename... L>
std::enable_if_t< sizeof...(L)==D, CellID >	getCellId (L... latticeR) const

CellDistance	getNeighborDistance (LatticeR< D > dir) const
	Get 1D neighbor distance.

bool	isInside (LatticeR< D > latticeR) const
	Return whether location is valid.

bool	isInsideCore (LatticeR< D > latticeR) const
	Return whether location is inside core.

bool	isPadding (LatticeR< D > latticeR) const
	Return whether location is valid.

template<typename... L>
std::enable_if_t< sizeof...(L)==D, bool >	isInside (L... latticeR) const

CellDistance	getNeighborhoodRadius (LatticeR< D > latticeR) const
	Return maximum valid neighborhood sphere radius w.r.t. latticeR.

template<typename F >
void	forSpatialLocations (F f) const

template<typename F >
void	forSpatialLocationsParallel (F f) const

template<typename F >
void	forSpatialLocations (LatticeR< D > min, LatticeR< D > max, F f) const

template<typename F >
void	forCoreSpatialLocations (F f) const

template<typename F >
void	forCellIndices (F f) const

Protected Attributes
LatticeR< D >	_core

LatticeR< D >	_size

LatticeR< D >	_projection

int	_padding

Detailed Description

template<unsigned D>
class olb::BlockStructureD< D >

Base of a regular block.

With extent, optional padding and memory bijection for spatial locations

Definition at line 54 of file blockStructure.h.

Constructor & Destructor Documentation

◆ BlockStructureD() [1/2]

template<unsigned D>

olb::BlockStructureD< D >::BlockStructureD	(	Vector< int, D >	size,
		int	padding = 0 )

inline

Definition at line 65 of file blockStructure.h.

                                                    :
    _core(size),
    _size(size + 2*padding),
    _padding(padding)
  {
    if constexpr (D == 3) {
      _projection = {_size[1]*_size[2], _size[2], 1};
    } else {
      _projection = {_size[1], 1};
    }
 
    if (getNcells()-1 > std::numeric_limits<CellID>::max()) {
      throw std::invalid_argument("Cell count must not exceed cell index space");
    }
  };

References olb::BlockStructureD< D >::_projection, olb::BlockStructureD< D >::_size, and olb::BlockStructureD< D >::getNcells().

Here is the call graph for this function:

◆ BlockStructureD() [2/2]

template<unsigned D>

olb::BlockStructureD< D >::BlockStructureD ( )

inline

Definition at line 81 of file blockStructure.h.

                   :
    BlockStructureD(1, 0)
  { };

Member Function Documentation

◆ forCellIndices()

template<unsigned D>

template<typename F >

void olb::BlockStructureD< D >::forCellIndices ( F f ) const

inline

Definition at line 286 of file blockStructure.h.

  {
    for (CellID iCell=0; iCell < getNcells(); ++iCell) {
      f(iCell);
    }
  }

References olb::BlockStructureD< D >::getNcells().

Here is the call graph for this function:

◆ forCoreSpatialLocations()

template<unsigned D>

template<typename F >

void olb::BlockStructureD< D >::forCoreSpatialLocations ( F f ) const

inline

Definition at line 261 of file blockStructure.h.

  {
    using loc = typename LatticeR<D>::value_t;
    for (loc iX=0; iX < _core[0]; ++iX) {
      for (loc iY=0; iY < _core[1]; ++iY) {
        if constexpr (D == 3) {
          for (loc iZ=0; iZ < _core[2]; ++iZ) {
            if constexpr (std::is_invocable_v<F, LatticeR<D>>) {
              f({iX,iY,iZ});
            } else {
              f(iX,iY,iZ);
            }
          }
        } else {
          if constexpr (std::is_invocable_v<F, LatticeR<D>>) {
            f({iX,iY});
          } else {
            f(iX,iY);
          }
        }
      }
    }
  };

References olb::BlockStructureD< D >::_core.

Here is the caller graph for this function:

◆ forSpatialLocations() [1/2]

template<unsigned D>

template<typename F >

void olb::BlockStructureD< D >::forSpatialLocations ( F f ) const

inline

Definition at line 183 of file blockStructure.h.

  {
    using loc = typename LatticeR<D>::value_t;
    for (loc iX=-_padding; iX < _core[0] + _padding; ++iX) {
      for (loc iY=-_padding; iY < _core[1] + _padding; ++iY) {
        if constexpr (D == 3) {
          for (loc iZ=-_padding; iZ < _core[2] + _padding; ++iZ) {
            if constexpr (std::is_invocable_v<F, LatticeR<D>>) {
              f({iX,iY,iZ});
            } else {
              f(iX,iY,iZ);
            }
          }
        } else {
          if constexpr (std::is_invocable_v<F, LatticeR<D>>) {
            f({iX,iY});
          } else {
            f(iX,iY);
          }
        }
      }
    }
  };

References olb::BlockStructureD< D >::_core, and olb::BlockStructureD< D >::_padding.

Here is the caller graph for this function:

◆ forSpatialLocations() [2/2]

template<unsigned D>

template<typename F >

void olb::BlockStructureD< D >::forSpatialLocations	(	LatticeR< D >	min,
		LatticeR< D >	max,
		F	f ) const

inline

Definition at line 236 of file blockStructure.h.

  {
    using loc = typename LatticeR<D>::value_t;
    for (loc iX=std::max(-_padding, min[0]); iX < std::min(_core[0] + _padding, max[0]+1); ++iX) {
      for (loc iY=std::max(-_padding, min[1]); iY < std::min(_core[1] + _padding, max[1]+1); ++iY) {
        if constexpr (D == 3) {
          for (loc iZ=std::max(-_padding, min[2]); iZ < std::min(_core[2] + _padding, max[2]+1); ++iZ) {
            if constexpr (std::is_invocable_v<F, LatticeR<D>>) {
              f({iX,iY,iZ});
            } else {
              f(iX,iY,iZ);
            }
          }
        } else {
          if constexpr (std::is_invocable_v<F, LatticeR<D>>) {
            f({iX,iY});
          } else {
            f(iX,iY);
          }
        }
      }
    }
  };

References olb::BlockStructureD< D >::_core, and olb::BlockStructureD< D >::_padding.

◆ forSpatialLocationsParallel()

template<unsigned D>

template<typename F >

void olb::BlockStructureD< D >::forSpatialLocationsParallel ( F f ) const

inline

Definition at line 208 of file blockStructure.h.

  {
    using loc = typename LatticeR<D>::value_t;
    #ifdef PARALLEL_MODE_OMP
    #pragma omp parallel for schedule(dynamic,1)
    #endif
    for (loc iX=-_padding; iX < _core[0] + _padding; ++iX) {
      for (loc iY=-_padding; iY < _core[1] + _padding; ++iY) {
        if constexpr (D == 3) {
          for (loc iZ=-_padding; iZ < _core[2] + _padding; ++iZ) {
            if constexpr (std::is_invocable_v<F, LatticeR<D>>) {
              f({iX,iY,iZ});
            } else {
              f(iX,iY,iZ);
            }
          }
        } else {
          if constexpr (std::is_invocable_v<F, LatticeR<D>>) {
            f({iX,iY});
          } else {
            f(iX,iY);
          }
        }
      }
    }
  }

References olb::BlockStructureD< D >::_core, and olb::BlockStructureD< D >::_padding.

◆ getCellId() [1/2]

template<unsigned D>

template<typename... L>

std::enable_if_t< sizeof...(L)==D, CellID > olb::BlockStructureD< D >::getCellId ( L... latticeR ) const

inline

Definition at line 133 of file blockStructure.h.

  {
    return LatticeR<D>{latticeR+_padding...} * _projection;
  }

References olb::BlockStructureD< D >::_padding, and olb::BlockStructureD< D >::_projection.

◆ getCellId() [2/2]

template<unsigned D>

CellID olb::BlockStructureD< D >::getCellId ( LatticeR< D > latticeR ) const

inline

Get 1D cell ID.

Definition at line 125 of file blockStructure.h.

  {
    OLB_PRECONDITION(isInside(latticeR));
    return (latticeR+_padding) * _projection;
  }

References olb::BlockStructureD< D >::_padding, olb::BlockStructureD< D >::_projection, olb::BlockStructureD< D >::isInside(), and OLB_PRECONDITION.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExtent()

template<unsigned D>

LatticeR< D > olb::BlockStructureD< D >::getExtent ( ) const

inline

Definition at line 102 of file blockStructure.h.

  {
    return _core;
  }

References olb::BlockStructureD< D >::_core.

◆ getNcells()

template<unsigned D>

std::size_t olb::BlockStructureD< D >::getNcells ( ) const

inline

Get number of cells.

Definition at line 114 of file blockStructure.h.

  {
    if constexpr (D == 3) {
      return _size[0] * _size[1] * _size[2];
    } else {
      return _size[0] * _size[1];
    }
    __builtin_unreachable();
  }

References olb::BlockStructureD< D >::_size.

Here is the caller graph for this function:

◆ getNeighborDistance()

template<unsigned D>

CellDistance olb::BlockStructureD< D >::getNeighborDistance ( LatticeR< D > dir ) const

inline

Get 1D neighbor distance.

Definition at line 139 of file blockStructure.h.

  {
    return dir * _projection;
  }

References olb::BlockStructureD< D >::_projection.

Here is the caller graph for this function:

◆ getNeighborhoodRadius()

template<unsigned D>

CellDistance olb::BlockStructureD< D >::getNeighborhoodRadius ( LatticeR< D > latticeR ) const

inline

Return maximum valid neighborhood sphere radius w.r.t. latticeR.

Definition at line 170 of file blockStructure.h.

  {
    auto lower = latticeR + _padding;
    auto upper = LatticeR<D>([&](unsigned iDim) -> int {
      int x = lower[iDim] - _size[iDim] + 1;
      return x < 0 ? -x : 0;
    });
    auto y = std::min(*std::min_element(lower.data(), lower.data() + D),
                      *std::min_element(upper.data(), upper.data() + D));
    return y;
  };

References olb::BlockStructureD< D >::_padding, and olb::BlockStructureD< D >::_size.

◆ getNx()

template<unsigned D>

int olb::BlockStructureD< D >::getNx ( ) const

inline

Read only access to block width.

Definition at line 86 of file blockStructure.h.

  {
    return _core[0];
  };

References olb::BlockStructureD< D >::_core.

Here is the caller graph for this function:

◆ getNy()

template<unsigned D>

int olb::BlockStructureD< D >::getNy ( ) const

inline

Read only access to block height.

Definition at line 91 of file blockStructure.h.

  {
    return _core[1];
  };

References olb::BlockStructureD< D >::_core.

Here is the caller graph for this function:

◆ getNz()

template<unsigned D>

int olb::BlockStructureD< D >::getNz ( ) const

inline

Read only access to block height.

Definition at line 96 of file blockStructure.h.

  {
    static_assert(D == 3, "z-component only available in 3D");
    return _core[2];
  };

References olb::BlockStructureD< D >::_core.

Here is the caller graph for this function:

◆ getPadding()

template<unsigned D>

int olb::BlockStructureD< D >::getPadding ( ) const

inline

Read only access to padding.

Definition at line 108 of file blockStructure.h.

  {
    return _padding;
  };

References olb::BlockStructureD< D >::_padding.

Here is the caller graph for this function:

◆ isInside() [1/2]

template<unsigned D>

template<typename... L>

std::enable_if_t< sizeof...(L)==D, bool > olb::BlockStructureD< D >::isInside ( L... latticeR ) const

inline

Definition at line 164 of file blockStructure.h.

  {
    return isInside({latticeR...});
  };

References olb::BlockStructureD< D >::isInside().

Here is the call graph for this function:

◆ isInside() [2/2]

template<unsigned D>

bool olb::BlockStructureD< D >::isInside ( LatticeR< D > latticeR ) const

inline

Return whether location is valid.

Definition at line 145 of file blockStructure.h.

  {
    return latticeR >= -_padding && latticeR < _core + _padding;
  };

References olb::BlockStructureD< D >::_core, and olb::BlockStructureD< D >::_padding.

Here is the caller graph for this function:

◆ isInsideCore()

template<unsigned D>

bool olb::BlockStructureD< D >::isInsideCore ( LatticeR< D > latticeR ) const

inline

Return whether location is inside core.

Definition at line 151 of file blockStructure.h.

  {
    return latticeR >= 0 && latticeR < _core;
  };

References olb::BlockStructureD< D >::_core.

◆ isPadding()

template<unsigned D>

bool olb::BlockStructureD< D >::isPadding ( LatticeR< D > latticeR ) const

inline

Return whether location is valid.

Definition at line 157 of file blockStructure.h.

  {
    return isInside(latticeR) && !(latticeR >= 0 && latticeR < _core);
  };

References olb::BlockStructureD< D >::_core, and olb::BlockStructureD< D >::isInside().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ _core

template<unsigned D>

LatticeR<D> olb::BlockStructureD< D >::_core

protected

Definition at line 56 of file blockStructure.h.

◆ _padding

template<unsigned D>

int olb::BlockStructureD< D >::_padding

protected

Definition at line 60 of file blockStructure.h.

◆ _projection

template<unsigned D>

LatticeR<D> olb::BlockStructureD< D >::_projection

protected

Definition at line 58 of file blockStructure.h.

◆ _size

template<unsigned D>

LatticeR<D> olb::BlockStructureD< D >::_size

protected

Definition at line 57 of file blockStructure.h.

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

src/core/blockStructure.h

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BlockStructureD() [1/2]

◆ BlockStructureD() [2/2]

Member Function Documentation

◆ forCellIndices()

◆ forCoreSpatialLocations()

◆ forSpatialLocations() [1/2]

◆ forSpatialLocations() [2/2]

◆ forSpatialLocationsParallel()

◆ getCellId() [1/2]

◆ getCellId() [2/2]

◆ getExtent()

◆ getNcells()

◆ getNeighborDistance()

◆ getNeighborhoodRadius()

◆ getNx()

◆ getNy()

◆ getNz()

◆ getPadding()

◆ isInside() [1/2]

◆ isInside() [2/2]

◆ isInsideCore()

◆ isPadding()

Member Data Documentation

◆ _core

◆ _padding

◆ _projection

◆ _size