olb::SuperStructure< T, D > Class Template Reference

#include <superStructure.h>

Inheritance diagram for olb::SuperStructure< T, D >:

Collaboration diagram for olb::SuperStructure< T, D >:

Public Types
using	value_t = T

Public Member Functions
virtual	~SuperStructure ()
	Virtual Destructor for inheritance.
	SuperStructure (CuboidGeometry< T, D > &cuboidGeometry, LoadBalancer< T > &loadBalancer, int overlap=2)
	Construction of a super structure.
	SuperStructure (int overlap=1)
	Default Constructor for empty SuperStructure.
CuboidGeometry< T, D > &	getCuboidGeometry ()
	Read and write access to cuboid geometry.
CuboidGeometry< T, D > const &	getCuboidGeometry () const
	Read only access to cuboid geometry.
int	getOverlap ()
	Read and write access to the overlap.
int	getOverlap () const
	Read only access to the overlap.
LoadBalancer< T > &	getLoadBalancer ()
	Read and write access to the load balancer.
LoadBalancer< T > const &	getLoadBalancer () const
	Read only access to the load balancer.
virtual void	communicate ()
template<typename F >
void	forCorePhysLocations (F f) const
	Iterate over discrete physical locations.
template<typename F >
void	forCorePhysLocations (PhysR< T, D > min, PhysR< T, D > max, F f) const
	Iterate over discrete physical locations between min and max.
template<typename F >
void	forCoreSpatialLocations (F f) const
	Iterate over spatial locations NOTE: Based on physical locations (as opposed to its blockStructure version)
template<typename F >
void	forCoreSpatialLocations (PhysR< T, D > min, PhysR< T, D > max, F f) const
	Iterate over spatial locations between min and max NOTE: Based on physical locations (as opposed to its blockStructure version)

Protected Attributes
CuboidGeometry< T, D > &	_cuboidGeometry
	The grid structure is stored here.
LoadBalancer< T > &	_loadBalancer
	Distribution of the cuboids of the cuboid structure.
int	_overlap
	Size of ghost cell layer (must be greater than 1 and greater_overlapBC, default =1)
OstreamManager	clout
	class specific output stream

Detailed Description

template<typename T, unsigned D>
class olb::SuperStructure< T, D >

Definition at line 39 of file superStructure.h.

Member Typedef Documentation

value_t

template<typename T , unsigned D>

using olb::SuperStructure< T, D >::value_t = T

Definition at line 52 of file superStructure.h.

Constructor & Destructor Documentation

~SuperStructure()

template<typename T , unsigned D>

virtual olb::SuperStructure< T, D >::~SuperStructure ( )

inlinevirtual

Virtual Destructor for inheritance.

Definition at line 55 of file superStructure.h.

{};

SuperStructure() [1/2]

template<typename T , unsigned D>

olb::SuperStructure< T, D >::SuperStructure	(	CuboidGeometry< T, D > &	cuboidGeometry,
		LoadBalancer< T > &	loadBalancer,
		int	overlap = 2 )

Construction of a super structure.

Definition at line 34 of file superStructure.hh.

  : _cuboidGeometry(cuboidGeometry),
    _loadBalancer(loadBalancer),
    _overlap(overlap),
    clout(std::cout, "SuperGeometry" + std::to_string(D) + "D")
{
}

SuperStructure() [2/2]

template<typename T , unsigned D>

olb::SuperStructure< T, D >::SuperStructure

(

int

overlap = 1

)

Default Constructor for empty SuperStructure.

Definition at line 45 of file superStructure.hh.

  : SuperStructure(*(new CuboidGeometry<T,D> ()),
                   *(new LoadBalancer<T> ()),
                   overlap)
{ }

Member Function Documentation

communicate()

template<typename T , unsigned D>

virtual void olb::SuperStructure< T, D >::communicate ( )

inlinevirtual

Reimplemented in olb::SuperData< D, T, U >, olb::SuperData< 2, T, BaseType >, olb::SuperData< 2, T, T >, olb::SuperData< 3, T, BaseType >, olb::SuperData< 3, T, T >, olb::SuperLattice< T, DESCRIPTOR >, olb::SuperLattice< S, descriptor >, olb::SuperLattice< T, Lattice >, olb::SuperLattice< T, TDESCRIPTOR >, olb::SuperGeometry< T, D >, olb::SuperGeometry< S, D >, olb::SuperGeometry< S, dim >, olb::SuperGeometry< T, 2 >, olb::SuperGeometry< T, 3 >, and olb::SuperGeometry< T, DESCRIPTOR::d >.

Definition at line 77 of file superStructure.h.

{ };

Here is the caller graph for this function:

forCorePhysLocations() [1/2]

template<typename T , unsigned D>

template<typename F >

void olb::SuperStructure< T, D >::forCorePhysLocations

(

F

f

)

const

Iterate over discrete physical locations.

Definition at line 89 of file superStructure.hh.

{
  using loc = typename PhysR<T,D>::value_t;
  Vector<loc,D> minPhysR = _cuboidGeometry.getMinPhysR();
  Vector<loc,D> maxPhysR = _cuboidGeometry.getMaxPhysR();
  const loc L = _cuboidGeometry.getMotherCuboid().getDeltaR();
  for (loc iX=minPhysR[0]; iX < maxPhysR[0]; iX+=L) {
    for (loc iY=minPhysR[1]; iY < maxPhysR[1]; iY+=L) {
      if constexpr (D == 3) {
        for (loc iZ=minPhysR[2]; iZ < maxPhysR[2]; iZ+=L) {
          if constexpr (std::is_invocable_v<F, PhysR<T,D>>) {
            f({iX,iY,iZ});
          } else {
            f(iX,iY,iZ);
          }
        }
      } else {
        if constexpr (std::is_invocable_v<F, PhysR<T,D>>) {
          f({iX,iY});
        } else {
          f(iX,iY);
        }
      }
    }
  }
};

forCorePhysLocations() [2/2]

template<typename T , unsigned D>

template<typename F >

void olb::SuperStructure< T, D >::forCorePhysLocations	(	PhysR< T, D >	min,
		PhysR< T, D >	max,
		F	f ) const

Iterate over discrete physical locations between min and max.

Definition at line 118 of file superStructure.hh.

{
  using loc = typename PhysR<T,D>::value_t;
  Vector<loc,D> minPhysR = _cuboidGeometry.getMinPhysR();
  Vector<loc,D> maxPhysR = _cuboidGeometry.getMaxPhysR();
  const loc L = _cuboidGeometry.getMotherCuboid().getDeltaR();
  for (loc iX=std::max(minPhysR[0],min[0]); iX < std::min(maxPhysR[0],max[0]+L); iX+=L) {
    for (loc iY=std::max(minPhysR[1],min[1]); iY < std::min(maxPhysR[1],max[1]+L); iY+=L) {
      if constexpr (D == 3) {
        for (loc iZ=std::max(minPhysR[2],min[2]); iZ < std::min(maxPhysR[2],max[2]+L); iZ+=L) {
          if constexpr (std::is_invocable_v<F, PhysR<T,D>>) {
            f({iX,iY,iZ});
          } else {
            f(iX,iY,iZ);
          }
        }
      } else {
        if constexpr (std::is_invocable_v<F, PhysR<T,D>>) {
          f({iX,iY});
        } else {
          f(iX,iY);
        }
      }
    }
  }
};

forCoreSpatialLocations() [1/2]

template<typename T , unsigned D>

template<typename F >

void olb::SuperStructure< T, D >::forCoreSpatialLocations

(

F

f

)

const

Iterate over spatial locations NOTE: Based on physical locations (as opposed to its blockStructure version)

Definition at line 147 of file superStructure.hh.

{
  forCorePhysLocations([&](PhysR<T,D> physLoc){
    LatticeR<D+1> latticeR;
    _cuboidGeometry.getLatticeR( latticeR.data(), physLoc.data() );
    if constexpr (std::is_invocable_v<F, LatticeR<D+1>>) {
      f(latticeR);
    } else {
      if constexpr (D == 3) {
        f(latticeR[0],latticeR[1],latticeR[2],latticeR[3]);
      } else {
        f(latticeR[0],latticeR[1],latticeR[2]);
      }
    }
  });
};

References olb::Vector< T, D >::data().

Here is the call graph for this function:

forCoreSpatialLocations() [2/2]

template<typename T , unsigned D>

template<typename F >

void olb::SuperStructure< T, D >::forCoreSpatialLocations	(	PhysR< T, D >	min,
		PhysR< T, D >	max,
		F	f ) const

Iterate over spatial locations between min and max NOTE: Based on physical locations (as opposed to its blockStructure version)

Definition at line 166 of file superStructure.hh.

{
  forCorePhysLocations(min, max, [&](PhysR<T,D> physLoc){
    LatticeR<D+1> latticeR;
    _cuboidGeometry.getLatticeR( latticeR.data(), physLoc.data() );
    if constexpr (std::is_invocable_v<F, LatticeR<D+1>>) {
      f(latticeR);
    } else {
      if constexpr (D == 3) {
        f(latticeR[0],latticeR[1],latticeR[2],latticeR[3]);
      } else {
        f(latticeR[0],latticeR[1],latticeR[2]);
      }
    }
  });
};

References olb::Vector< T, D >::data().

Here is the call graph for this function:

getCuboidGeometry() [1/2]

template<typename T , unsigned D>

CuboidGeometry< T, D > & olb::SuperStructure< T, D >::getCuboidGeometry

(

)

Read and write access to cuboid geometry.

Definition at line 52 of file superStructure.hh.

{
  return _cuboidGeometry;
}

Here is the caller graph for this function:

getCuboidGeometry() [2/2]

template<typename T , unsigned D>

CuboidGeometry< T, D > const & olb::SuperStructure< T, D >::getCuboidGeometry

(

)

const

Read only access to cuboid geometry.

Definition at line 58 of file superStructure.hh.

{
  return _cuboidGeometry;
}

getLoadBalancer() [1/2]

template<typename T , unsigned D>

LoadBalancer< T > & olb::SuperStructure< T, D >::getLoadBalancer

(

)

Read and write access to the load balancer.

Definition at line 76 of file superStructure.hh.

{
  return _loadBalancer;
}

getLoadBalancer() [2/2]

template<typename T , unsigned D>

LoadBalancer< T > const & olb::SuperStructure< T, D >::getLoadBalancer

(

)

const

Read only access to the load balancer.

Definition at line 82 of file superStructure.hh.

{
  return _loadBalancer;
}

getOverlap() [1/2]

template<typename T , unsigned D>

int olb::SuperStructure< T, D >::getOverlap

(

)

Read and write access to the overlap.

Definition at line 64 of file superStructure.hh.

{
  return _overlap;
}

Here is the caller graph for this function:

getOverlap() [2/2]

template<typename T , unsigned D>

int olb::SuperStructure< T, D >::getOverlap

(

)

const

Read only access to the overlap.

Definition at line 70 of file superStructure.hh.

{
  return _overlap;
}

Member Data Documentation

_cuboidGeometry

template<typename T , unsigned D>

CuboidGeometry<T,D>& olb::SuperStructure< T, D >::_cuboidGeometry

protected

The grid structure is stored here.

Definition at line 42 of file superStructure.h.

_loadBalancer

template<typename T , unsigned D>

LoadBalancer<T>& olb::SuperStructure< T, D >::_loadBalancer

protected

Distribution of the cuboids of the cuboid structure.

Definition at line 44 of file superStructure.h.

_overlap

template<typename T , unsigned D>

int olb::SuperStructure< T, D >::_overlap

protected

Size of ghost cell layer (must be greater than 1 and greater_overlapBC, default =1)

Definition at line 47 of file superStructure.h.

clout

template<typename T , unsigned D>

OstreamManager olb::SuperStructure< T, D >::clout

mutableprotected

class specific output stream

Definition at line 49 of file superStructure.h.

---

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

• src/communication/superStructure.h
• src/communication/superStructure.hh