olb::SuperGeometryFaces3D< T > Class Template Reference

Accumulates the discrete surface of indicated cells facing unit directions and returns the individual as well as the total surface in phys units. More...

#include <superGeometryFaces3D.h>

Inheritance diagram for olb::SuperGeometryFaces3D< T >:

Collaboration diagram for olb::SuperGeometryFaces3D< T >:

Public Member Functions
	SuperGeometryFaces3D (FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF, T _latticeL)
	Constructor accepting solid cell indicator and custom lattice length.
	SuperGeometryFaces3D (SuperGeometry< T, 3 > &superGeometry, const int material, T _latticeL)
	Constructor accepting single solid cell material and custom lattice length.
template<typename DESCRIPTOR >
	SuperGeometryFaces3D (FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF, const UnitConverter< T, DESCRIPTOR > &converter)
	Constructor accepting solid cell indicator and a unit converter to query lattice length.
template<typename DESCRIPTOR >
	SuperGeometryFaces3D (SuperGeometry< T, 3 > &superGeometry, const int material, const UnitConverter< T, DESCRIPTOR > &converter)
	Constructor accepting single solid cell material and a unit converter to query lattice length.
bool	operator() (T output[], const int input[]) override
Public Member Functions inherited from olb::SuperF3D< T, W >
SuperF3D< T, W > &	operator- (SuperF3D< T, W > &rhs)
SuperF3D< T, W > &	operator+ (SuperF3D< T, W > &rhs)
SuperF3D< T, W > &	operator* (SuperF3D< T, W > &rhs)
SuperF3D< T, W > &	operator/ (SuperF3D< T, W > &rhs)
SuperStructure< T, 3 > &	getSuperStructure ()
int	getBlockFSize () const
BlockF3D< W > &	getBlockF (int iCloc)
bool	operator() (W output[], const int input[])
Public Member Functions inherited from olb::GenericF< T, S >
virtual	~GenericF ()=default
int	getSourceDim () const
	read only access to member variable _m
int	getTargetDim () const
	read only access to member variable _n
std::string &	getName ()
	read and write access to name
std::string const &	getName () const
	read only access to name
virtual bool	operator() (T output[], const S input[])=0
	has to be implemented for 'every' derived class
bool	operator() (T output[])
	wrapper that call the pure virtual operator() (T output[], const S input[]) from above
bool	operator() (T output[], S input0)
bool	operator() (T output[], S input0, S input1)
bool	operator() (T output[], S input0, S input1, S input2)
bool	operator() (T output[], S input0, S input1, S input2, S input3)

Additional Inherited Members
Public Types inherited from olb::SuperF3D< T, W >
using	identity_functor_type = SuperIdentity3D<T,W>
Public Types inherited from olb::GenericF< T, S >
using	targetType = T
using	sourceType = S
Public Attributes inherited from olb::GenericF< T, S >
std::shared_ptr< GenericF< T, S > >	_ptrCalcC
	memory management, frees resouces (calcClass)
Static Public Attributes inherited from olb::SuperF3D< T, W >
static constexpr bool	isSuper = true
static constexpr unsigned	d = 3
Protected Member Functions inherited from olb::SuperF3D< T, W >
	SuperF3D (SuperStructure< T, 3 > &superStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< T, S >
	GenericF (int targetDim, int sourceDim)
Protected Attributes inherited from olb::SuperF3D< T, W >
SuperStructure< T, 3 > &	_superStructure
std::vector< std::unique_ptr< BlockF3D< W > > >	_blockF
	Super functors may consist of several BlockF3D<W> derived functors.

Detailed Description

template<typename T>
class olb::SuperGeometryFaces3D< T >

Accumulates the discrete surface of indicated cells facing unit directions and returns the individual as well as the total surface in phys units.

Unit directions: (1,0,0), (0,1,0), (0,0,1), (-1,0,0), (0,-1,0), (0,0,-1)

Definition at line 40 of file superGeometryFaces3D.h.

Constructor & Destructor Documentation

SuperGeometryFaces3D() [1/4]

template<typename T >

olb::SuperGeometryFaces3D< T >::SuperGeometryFaces3D	(	FunctorPtr< SuperIndicatorF3D< T > > &&	indicatorF,
		T	_latticeL )

Constructor accepting solid cell indicator and custom lattice length.

Definition at line 34 of file superGeometryFaces3D.hh.

  : SuperF3D<T>(indicatorF->getSuperStructure(), 7),
    _indicatorF(std::move(indicatorF))
{
  this->getName() = "superGeometryFaces";
  for (int iC = 0; iC < this->getSuperStructure().getLoadBalancer().size(); ++iC) {
    this->_blockF.emplace_back(
      new BlockGeometryFaces3D<T>(indicatorF->getBlockIndicatorF(iC), latticeL));
  }
}

References olb::SuperF3D< T, W >::_blockF, olb::SuperStructure< T, D >::getLoadBalancer(), olb::GenericF< T, S >::getName(), and olb::SuperF3D< T, W >::getSuperStructure().

Here is the call graph for this function:

SuperGeometryFaces3D() [2/4]

template<typename T >

olb::SuperGeometryFaces3D< T >::SuperGeometryFaces3D	(	SuperGeometry< T, 3 > &	superGeometry,
		const int	material,
		T	_latticeL )

Constructor accepting single solid cell material and custom lattice length.

Definition at line 47 of file superGeometryFaces3D.hh.

  : SuperGeometryFaces3D(superGeometry.getMaterialIndicator(material), latticeL)
{ }

SuperGeometryFaces3D() [3/4]

template<typename T >

template<typename DESCRIPTOR >

olb::SuperGeometryFaces3D< T >::SuperGeometryFaces3D ( FunctorPtr< SuperIndicatorF3D< T > > && indicatorF, const UnitConverter< T, DESCRIPTOR > & converter )

inline

Constructor accepting solid cell indicator and a unit converter to query lattice length.

Definition at line 53 of file superGeometryFaces3D.h.

    : SuperGeometryFaces3D(std::forward<decltype(indicatorF)>(indicatorF),
                           converter.getConversionFactorLength()) { };

SuperGeometryFaces3D() [4/4]

template<typename T >

template<typename DESCRIPTOR >

olb::SuperGeometryFaces3D< T >::SuperGeometryFaces3D ( SuperGeometry< T, 3 > & superGeometry, const int material, const UnitConverter< T, DESCRIPTOR > & converter )

inline

Constructor accepting single solid cell material and a unit converter to query lattice length.

Definition at line 59 of file superGeometryFaces3D.h.

    : SuperGeometryFaces3D(superGeometry.getMaterialIndicator(material), converter) { };

Member Function Documentation

operator()()

template<typename T >

bool olb::SuperGeometryFaces3D< T >::operator() ( T output[], const int input[] )

override

Definition at line 53 of file superGeometryFaces3D.hh.

{
  this->getSuperStructure().communicate();
 
  T blockOutput[7] = { };
  for (int iDim = 0; iDim < this->getTargetDim(); ++iDim) {
    output[iDim] = T();
  }
 
  for (int iC = 0; iC < this->getSuperStructure().getLoadBalancer().size(); ++iC) {
    this->getBlockF(iC)(blockOutput, input);
    for (int iDim = 0; iDim < this->getTargetDim(); ++iDim) {
      output[iDim] += blockOutput[iDim];
    }
  }
 
#ifdef PARALLEL_MODE_MPI
  for (int iDim = 0; iDim < this->getTargetDim(); ++iDim) {
    singleton::mpi().reduceAndBcast(output[iDim], MPI_SUM);
  }
#endif
  return true;
}

References olb::singleton::mpi(), and olb::singleton::MpiManager::reduceAndBcast().

Here is the call graph for this function:

---

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

• src/functors/lattice/superGeometryFaces3D.h
• src/functors/lattice/superGeometryFaces3D.hh