olb::SuperLatticeFfromAnalyticalF3D< T, DESCRIPTOR > Class Template Reference

Functor used to convert analytical functions to lattice functions. More...

#include <reductionF3D.h>

Inheritance diagram for olb::SuperLatticeFfromAnalyticalF3D< T, DESCRIPTOR >:

Collaboration diagram for olb::SuperLatticeFfromAnalyticalF3D< T, DESCRIPTOR >:

Public Member Functions
	SuperLatticeFfromAnalyticalF3D (FunctorPtr< AnalyticalF3D< T, T > > &&f, SuperLattice< T, DESCRIPTOR > &sLattice)
bool	operator() (T output[], const int input[]) override
Public Member Functions inherited from olb::SuperLatticeF3D< T, DESCRIPTOR >
SuperLattice< T, DESCRIPTOR > &	getSuperLattice ()
bool	operator() (T output[], const int input[])
Public Member Functions inherited from olb::SuperF3D< T, T >
SuperF3D< T, T > &	operator- (SuperF3D< T, T > &rhs)
SuperF3D< T, T > &	operator+ (SuperF3D< T, T > &rhs)
SuperF3D< T, T > &	operator* (SuperF3D< T, T > &rhs)
SuperF3D< T, T > &	operator/ (SuperF3D< T, T > &rhs)
SuperStructure< T, 3 > &	getSuperStructure ()
int	getBlockFSize () const
BlockF3D< T > &	getBlockF (int iCloc)
bool	operator() (T 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)

Protected Attributes
FunctorPtr< AnalyticalF3D< T, T > >	_f
Protected Attributes inherited from olb::SuperLatticeF3D< T, DESCRIPTOR >
SuperLattice< T, DESCRIPTOR > &	_sLattice
Protected Attributes inherited from olb::SuperF3D< T, T >
SuperStructure< T, 3 > &	_superStructure
std::vector< std::unique_ptr< BlockF3D< T > > >	_blockF
	Super functors may consist of several BlockF3D<W> derived functors.

Additional Inherited Members
Public Types inherited from olb::SuperLatticeF3D< T, DESCRIPTOR >
using	identity_functor_type = SuperLatticeIdentity3D<T,DESCRIPTOR>
Public Types inherited from olb::SuperF3D< T, T >
using	identity_functor_type
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, T >
static constexpr bool	isSuper
static constexpr unsigned	d
Protected Member Functions inherited from olb::SuperLatticeF3D< T, DESCRIPTOR >
	SuperLatticeF3D (SuperLattice< T, DESCRIPTOR > &superLattice, int targetDim)
Protected Member Functions inherited from olb::SuperF3D< T, T >
	SuperF3D (SuperStructure< T, 3 > &superStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< T, S >
	GenericF (int targetDim, int sourceDim)

Detailed Description

template<typename T, typename DESCRIPTOR>
class olb::SuperLatticeFfromAnalyticalF3D< T, DESCRIPTOR >

Functor used to convert analytical functions to lattice functions.

Input functions are interpreted as SI->SI units, the resulting lattice function will map lattice->lattice units

Definition at line 44 of file reductionF3D.h.

Constructor & Destructor Documentation

SuperLatticeFfromAnalyticalF3D()

template<typename T , typename DESCRIPTOR >

olb::SuperLatticeFfromAnalyticalF3D< T, DESCRIPTOR >::SuperLatticeFfromAnalyticalF3D	(	FunctorPtr< AnalyticalF3D< T, T > > &&	f,
		SuperLattice< T, DESCRIPTOR > &	sLattice )

Parameters

f	Analytical functor to be converted into a lattice functor
sLattice	DESCRIPTOR reference required for conversion and block functor construction

Definition at line 40 of file reductionF3D.hh.

  : SuperLatticeF3D<T, DESCRIPTOR>(sLattice, f->getTargetDim()),
    _f(std::move(f))
{
  this->getName() = "fromAnalyticalF(" + _f->getName() + ")";
 
  LoadBalancer<T>&     load   = sLattice.getLoadBalancer();
  CuboidGeometry3D<T>& cuboid = sLattice.getCuboidGeometry();
 
  for (int iC = 0; iC < load.size(); ++iC) {
    this->_blockF.emplace_back(
      new BlockLatticeFfromAnalyticalF3D<T,DESCRIPTOR>(
        *_f,
        sLattice.getBlock(iC),
        cuboid.get(load.glob(iC)))
    );
  }
}

References olb::SuperF3D< T, T >::_blockF, olb::SuperLatticeFfromAnalyticalF3D< T, DESCRIPTOR >::_f, olb::CuboidGeometry3D< T >::get(), olb::SuperLattice< T, DESCRIPTOR >::getBlock(), olb::SuperStructure< T, D >::getCuboidGeometry(), olb::SuperStructure< T, D >::getLoadBalancer(), olb::GenericF< T, S >::getName(), olb::LoadBalancer< T >::glob(), and olb::LoadBalancer< T >::size().

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T , typename DESCRIPTOR >

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

override

Definition at line 62 of file reductionF3D.hh.

{
  T physR[3] = {};
  this->_sLattice.getCuboidGeometry().getPhysR(physR,input);
  return _f(output,physR);
}

Member Data Documentation

_f

template<typename T , typename DESCRIPTOR >

FunctorPtr<AnalyticalF3D<T,T> > olb::SuperLatticeFfromAnalyticalF3D< T, DESCRIPTOR >::_f

protected

Definition at line 46 of file reductionF3D.h.

---

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

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