olb::SuperPlaneIntegralF3D< T > Class Template Reference

Surface integral of a subset of a interpolated hyperplane. More...

#include <superPlaneIntegralF3D.h>

Inheritance diagram for olb::SuperPlaneIntegralF3D< T >:

Collaboration diagram for olb::SuperPlaneIntegralF3D< T >:

Public Member Functions
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const HyperplaneLattice3D< T > &hyperplaneLattice, FunctorPtr< SuperIndicatorF3D< T > > &&integrationIndicator, FunctorPtr< IndicatorF2D< T > > &&subplaneIndicator, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Primary constructor.
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const Hyperplane3D< T > &hyperplane, FunctorPtr< SuperIndicatorF3D< T > > &&integrationIndicator, FunctorPtr< IndicatorF2D< T > > &&subplaneIndicator, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Constructor providing automatic lattice generation.
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const Hyperplane3D< T > &hyperplane, FunctorPtr< SuperIndicatorF3D< T > > &&integrationIndicator, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Constructor providing automatic lattice generation and omitting subplane restriction.
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &origin, const Vector< T, 3 > &u, const Vector< T, 3 > &v, std::vector< int > materials, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Constructor providing automatic lattice and material indicator instantiation.
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &origin, const Vector< T, 3 > &u, const Vector< T, 3 > &v, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Constructor providing automatic lattice parametrization, only interpolating material 1.
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &origin, const Vector< T, 3 > &normal, std::vector< int > materials, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Constructor providing automatic lattice and material indicator instantiation.
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &origin, const Vector< T, 3 > &normal, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Constructor providing automatic lattice parametrization, only interpolating material 1.
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &normal, std::vector< int > materials, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Constructor providing automatic lattice and material indicator instantiation.
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &normal, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Constructor providing automatic lattice parametrization, only interpolating material 1.
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const IndicatorCircle3D< T > &circle, std::vector< int > materials, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Constructor providing automatic lattice parametrization to fit a given circle.
	SuperPlaneIntegralF3D (FunctorPtr< SuperF3D< T > > &&f, SuperGeometry< T, 3 > &geometry, const IndicatorCircle3D< T > &circle, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)
	Constructor providing automatic lattice parametrization to fit a given circle and only interpolating material 1.
bool	operator() (T output[], const int input[]) override
	Returns the plane integral in the following structure:
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)

Protected Member Functions
bool	isToBeIntegrated (const Vector< T, 3 > &physR, int iC)
	This is determined using the _integrationIndicatorF indicated subset of the 2d plane reduced by _reductionF.
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
SuperGeometry< T, 3 > &	_geometry
FunctorPtr< SuperF3D< T > >	_f
	Functor to be integrated on the plane.
FunctorPtr< SuperIndicatorF3D< T > >	_integrationIndicatorF
	Indicator describing relevant discrete integration points.
FunctorPtr< IndicatorF2D< T > >	_subplaneIndicatorF
	Indicator describing the relevant subset of the interpolated hyperplane.
BlockReduction3D2D< T >	_reductionF
	Functor describing plane to be interpolated and integrated.
Vector< T, 3 >	_origin
	Origin vector as given by hyperplane definition, (0,0) in respect to the subplane indicator _subplaneIndicatorF.
Vector< T, 3 >	_u
	Span vector u as given by hyperplane definition, normalized to h.
Vector< T, 3 >	_v
	Span vector v as given by hyperplane definition, normalized to h.
Vector< T, 3 >	_normal
	Orthogonal vector to _u and _v.
std::vector< std::tuple< int, int > >	_rankLocalSubplane
	Subset of the discrete plane points given by _reductionF as indicated by _integrationIndicatorF.
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.

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

Detailed Description

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

Surface integral of a subset of a interpolated hyperplane.

Definition at line 45 of file superPlaneIntegralF3D.h.

Constructor & Destructor Documentation

SuperPlaneIntegralF3D() [1/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const HyperplaneLattice3D< T > &	hyperplaneLattice,
		FunctorPtr< SuperIndicatorF3D< T > > &&	integrationIndicator,
		FunctorPtr< IndicatorF2D< T > > &&	subplaneIndicator,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Primary constructor.

All other constructors defer the actual construction to this constructor.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
hyperplaneLattice	Parametrization of the hyperplane lattice to be interpolated.
integrationIndicator	(non-)owning pointer or reference to SuperIndicatorF3D<T>. Describes the set of lattice points relevant for integration.
subplaneIndicator	(non-)owning pointer or reference to IndicatorF2D<T>. Describes the relevant subplane of the interpolated hyperplane.
mode	Defines how the values of the discrete hyperplane are determined. i.e. if they are interpolated or read directly from lattice points. Note: BlockDataReductionMode::Analytical imposes restrictions on hyperplane definition and discretization. If you are not sure consider providing only a hyperplane defintion instead of both a definition and a discretization.

Definition at line 60 of file superPlaneIntegralF3D.hh.

  : SuperF3D<T>(f->getSuperStructure(), 2 + f->getTargetDim()),
    _geometry(geometry),
    _f(std::move(f)),
    _integrationIndicatorF(std::move(integrationIndicator)),
    _subplaneIndicatorF(std::move(subplaneIndicator)),
    _reductionF(*_f,
                hyperplaneLattice,
                BlockDataSyncMode::None,
                mode),
    _origin(hyperplaneLattice.getHyperplane().origin),
    _u(hyperplaneLattice.getVectorU()),
    _v(hyperplaneLattice.getVectorV()),
    _normal(hyperplaneLattice.getHyperplane().normal)
{
  this->getName() = "SuperPlaneIntegralF3D";
 
  _normal = normalize(_normal);
  _u = normalize(_u);
  _v = normalize(_v);
 
  for ( const std::tuple<int,int,int>& pos : _reductionF.getRankLocalSubplane() ) {
    const int& i  = std::get<0>(pos);
    const int& j  = std::get<1>(pos);
    const int& iC = std::get<2>(pos);
    const Vector<T,3> physR = _reductionF.getPhysR(i, j);
    if (isToBeIntegrated(physR, iC)) {
      // check if interpolated hyperplane is to be restricted further
      // e.g. using IndicatorCircle2D
      if ( _subplaneIndicatorF ) {
        // determine physical coordinates relative to original hyperplane origin
        // [!] different from _reductionF._origin in the general case.
        const Vector<T,3> physRelativeToOrigin = physR - _origin;
        const T physOnHyperplane[2] {
          physRelativeToOrigin * _u,
          physRelativeToOrigin * _v
        };
 
        if ( _subplaneIndicatorF->operator()(physOnHyperplane) ) {
          _rankLocalSubplane.emplace_back(i, j);
        }
      }
      else {
        // plane is not restricted further
        _rankLocalSubplane.emplace_back(i, j);
      }
    }
  }
}

References olb::SuperPlaneIntegralF3D< T >::_normal, olb::SuperPlaneIntegralF3D< T >::_origin, olb::SuperPlaneIntegralF3D< T >::_rankLocalSubplane, olb::SuperPlaneIntegralF3D< T >::_reductionF, olb::SuperPlaneIntegralF3D< T >::_subplaneIndicatorF, olb::SuperPlaneIntegralF3D< T >::_u, olb::SuperPlaneIntegralF3D< T >::_v, olb::GenericF< T, S >::getName(), olb::SuperPlaneIntegralF3D< T >::isToBeIntegrated(), and olb::normalize().

Here is the call graph for this function:

SuperPlaneIntegralF3D() [2/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const Hyperplane3D< T > &	hyperplane,
		FunctorPtr< SuperIndicatorF3D< T > > &&	integrationIndicator,
		FunctorPtr< IndicatorF2D< T > > &&	subplaneIndicator,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Constructor providing automatic lattice generation.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
hyperplane	Parametrization of the hyperplane to be integrated. The lattice resolution is set to CuboidGeometry3D<T>::getMinDeltaR.
integrationIndicator	(non-)owning pointer or reference to SuperIndicatorF3D<T>. Describes the set of lattice points relevant for integration.
subplaneIndicator	(non-)owning pointer or reference to IndicatorF2D<T>. Describes the relevant subplane of the interpolated hyperplane.
mode	Defines how the values of the discrete hyperplane are determined. i.e. if they are interpolated or read directly from lattice points.

Definition at line 117 of file superPlaneIntegralF3D.hh.

  : SuperPlaneIntegralF3D(
      std::forward<decltype(f)>(f),
      geometry,
      HyperplaneLattice3D<T>(geometry.getCuboidGeometry(), hyperplane),
      std::forward<decltype(integrationIndicator)>(integrationIndicator),
      std::forward<decltype(subplaneIndicator)>(subplaneIndicator),
      mode)
{ }

SuperPlaneIntegralF3D() [3/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const Hyperplane3D< T > &	hyperplane,
		FunctorPtr< SuperIndicatorF3D< T > > &&	integrationIndicator,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Constructor providing automatic lattice generation and omitting subplane restriction.

i.e. the intersection between geometry and hyperplane is integrated wherever _integrationIndicatorF allows.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
hyperplane	Parametrization of the hyperplane to be integrated. The lattice resolution is set to the cuboid geometry's minDeltaR.
integrationIndicator	(non-)owning pointer or reference to SuperIndicatorF3D<T>. Describes the set of lattice points relevant for integration.
mode	Defines how the values of the discrete hyperplane are determined. i.e. if they are interpolated or read directly from lattice points.

Definition at line 134 of file superPlaneIntegralF3D.hh.

  : SuperPlaneIntegralF3D(
      std::forward<decltype(f)>(f),
      geometry,
      hyperplane,
      std::forward<decltype(integrationIndicator)>(integrationIndicator),
      nullptr,
      mode)
{ }

SuperPlaneIntegralF3D() [4/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const Vector< T, 3 > &	origin,
		const Vector< T, 3 > &	u,
		const Vector< T, 3 > &	v,
		std::vector< int >	materials,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Constructor providing automatic lattice and material indicator instantiation.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
origin	hyperplane origin
u	hyperplane span vector
v	hyperplane span vector
materials	material numbers relevant for hyperplane integration
mode	defines how the values of the discrete hyperplane are determined

Definition at line 150 of file superPlaneIntegralF3D.hh.

  : SuperPlaneIntegralF3D(
      std::forward<decltype(f)>(f),
      geometry,
      Hyperplane3D<T>().originAt(origin).spannedBy(u, v),
      geometry.getMaterialIndicator(std::forward<decltype(materials)>(materials)),
      mode)
{ }

SuperPlaneIntegralF3D() [5/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const Vector< T, 3 > &	origin,
		const Vector< T, 3 > &	u,
		const Vector< T, 3 > &	v,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Constructor providing automatic lattice parametrization, only interpolating material 1.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
origin	hyperplane origin
u	hyperplane span vector
v	hyperplane span vector
mode	Defines how the values of the discrete hyperplane are determined.

Definition at line 165 of file superPlaneIntegralF3D.hh.

  : SuperPlaneIntegralF3D(
      std::forward<decltype(f)>(f),
      geometry,
      origin, u, v,
      std::vector<int>(1,1),
      mode)
{ }

SuperPlaneIntegralF3D() [6/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const Vector< T, 3 > &	origin,
		const Vector< T, 3 > &	normal,
		std::vector< int >	materials,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Constructor providing automatic lattice and material indicator instantiation.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
origin	hyperplane origin
normal	hyperplane normal
materials	material numbers relevant for hyperplane integration
mode	defines how the values of the discrete hyperplane are determined

Definition at line 179 of file superPlaneIntegralF3D.hh.

  : SuperPlaneIntegralF3D(
      std::forward<decltype(f)>(f),
      geometry,
      Hyperplane3D<T>().originAt(origin).normalTo(normal),
      geometry.getMaterialIndicator(std::forward<decltype(materials)>(materials)),
      mode)
{ }

SuperPlaneIntegralF3D() [7/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const Vector< T, 3 > &	origin,
		const Vector< T, 3 > &	normal,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Constructor providing automatic lattice parametrization, only interpolating material 1.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
origin	hyperplane origin
normal	hyperplane normal
mode	defines how the values of the discrete hyperplane are determined

Definition at line 194 of file superPlaneIntegralF3D.hh.

  : SuperPlaneIntegralF3D(
      std::forward<decltype(f)>(f),
      geometry,
      origin, normal,
      std::vector<int>(1,1),
      mode)
{ }

SuperPlaneIntegralF3D() [8/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const Vector< T, 3 > &	normal,
		std::vector< int >	materials,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Constructor providing automatic lattice and material indicator instantiation.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
normal	hyperplane normal (centered in mother cuboid)
materials	material numbers relevant for hyperplane integration
mode	defines how the values of the discrete hyperplane are determined

Definition at line 208 of file superPlaneIntegralF3D.hh.

  : SuperPlaneIntegralF3D(
      std::forward<decltype(f)>(f),
      geometry,
      Hyperplane3D<T>()
      .centeredIn(geometry.getCuboidGeometry().getMotherCuboid())
      .normalTo(normal),
      geometry.getMaterialIndicator(std::forward<decltype(materials)>(materials)),
      mode)
{ }

SuperPlaneIntegralF3D() [9/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const Vector< T, 3 > &	normal,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Constructor providing automatic lattice parametrization, only interpolating material 1.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
normal	hyperplane normal (centered in mother cuboid)
mode	defines how the values of the discrete hyperplane are determined

Definition at line 225 of file superPlaneIntegralF3D.hh.

  : SuperPlaneIntegralF3D(
      std::forward<decltype(f)>(f),
      geometry,
      normal,
      std::vector<int>(1,1),
      mode)
{ }

SuperPlaneIntegralF3D() [10/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const IndicatorCircle3D< T > &	circle,
		std::vector< int >	materials,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Constructor providing automatic lattice parametrization to fit a given circle.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
circle	circle indicator to be used for hyperplane subset parametrization
materials	material numbers relevant for hyperplane interpolation
mode	defines how the values of the discrete hyperplane are determined

Definition at line 239 of file superPlaneIntegralF3D.hh.

  : SuperPlaneIntegralF3D(
      std::forward<decltype(f)>(f),
      geometry,
      Hyperplane3D<T>().originAt(circle.getCenter()).normalTo(circle.getNormal()),
      geometry.getMaterialIndicator(std::forward<std::vector<int>>(materials)),
      std::unique_ptr<IndicatorF2D<T>>(new IndicatorCircle2D<T>({0,0}, circle.getRadius())),
mode)
{ }

SuperPlaneIntegralF3D() [11/11]

template<typename T >

olb::SuperPlaneIntegralF3D< T >::SuperPlaneIntegralF3D	(	FunctorPtr< SuperF3D< T > > &&	f,
		SuperGeometry< T, 3 > &	geometry,
		const IndicatorCircle3D< T > &	circle,
		BlockDataReductionMode	mode = BlockDataReductionMode::Analytical )

Constructor providing automatic lattice parametrization to fit a given circle and only interpolating material 1.

Parameters

f	(non-)owning pointer or reference to SuperF3D<T>.
circle	circle indicator to be used for hyperplane subset parametrization
mode	defines how the values of the discrete hyperplane are determined

Definition at line 254 of file superPlaneIntegralF3D.hh.

  : SuperPlaneIntegralF3D(
      std::forward<decltype(f)>(f),
      geometry,
      circle,
      std::vector<int>(1,1),
      mode)
{ }

Member Function Documentation

isToBeIntegrated()

template<typename T >

bool olb::SuperPlaneIntegralF3D< T >::isToBeIntegrated ( const Vector< T, 3 > & physR, int iC )

protected

This is determined using the _integrationIndicatorF indicated subset of the 2d plane reduced by _reductionF.

Returns

true iff the given physical position is to be integrated

Definition at line 35 of file superPlaneIntegralF3D.hh.

{
  Vector<int,4> latticeR;
  //get nearest lattice point
  if ( _geometry.getCuboidGeometry().getFloorLatticeR(physR, latticeR) ) {
    const int& iX = latticeR[1];
    const int& iY = latticeR[2];
    const int& iZ = latticeR[3];
 
    // interpolation is possible iff all neighbours are within the indicated subset
    return _integrationIndicatorF->operator()(   iC, iX,   iY,   iZ  )
           && _integrationIndicatorF->operator()(iC, iX,   iY,   iZ+1)
           && _integrationIndicatorF->operator()(iC, iX,   iY+1, iZ  )
           && _integrationIndicatorF->operator()(iC, iX,   iY+1, iZ+1)
           && _integrationIndicatorF->operator()(iC, iX+1, iY,   iZ  )
           && _integrationIndicatorF->operator()(iC, iX+1, iY,   iZ+1)
           && _integrationIndicatorF->operator()(iC, iX+1, iY+1, iZ  )
           && _integrationIndicatorF->operator()(iC, iX+1, iY+1, iZ+1);
  }
  else {
    return false;
  }
}

Here is the caller graph for this function:

operator()()

template<typename T >

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

override

Returns the plane integral in the following structure:

output[0] = integral, e.g. flow[0] * h^2 for 1-dimensional target sizes
output[1] = #voxels * h^2 i.e. area
output[2..2+f.getTargetSize()] = flow

Note: output[0] contains the flux value if applicable

Parameters

input

irrelevant

Definition at line 268 of file superPlaneIntegralF3D.hh.

{
  this->getSuperStructure().communicate();
 
  _reductionF.update();
 
  const int flowDim = _reductionF.getTargetDim();
 
  std::vector<T> flow(flowDim,0.);
 
  for ( std::tuple<int,int>& pos : _rankLocalSubplane ) {
    T outputTmp[flowDim];
    const int inputTmp[2] { std::get<0>(pos), std::get<1>(pos) };
 
    _reductionF(outputTmp, inputTmp);
 
    for ( int j = 0; j < flowDim; j++ ) {
      flow[j] += outputTmp[j];
    }
  }
 
  int vox = _rankLocalSubplane.size();
 
#ifdef PARALLEL_MODE_MPI
  for ( int j = 0; j < flowDim; j++ ) {
    singleton::mpi().reduceAndBcast(flow[j], MPI_SUM);
  }
  singleton::mpi().reduceAndBcast(vox, MPI_SUM);
#endif
 
  const T h = _reductionF.getPhysSpacing();
 
  switch ( flowDim ) {
  case 1: {
    output[0] = flow[0] * h * h;
    break;
  }
  case 3: {
    output[0] = (h*h * Vector<T,3>(flow)) * _normal;
    break;
  }
  }
 
  // area
  output[1] = vox * h * h;
  // write flow to output[2..]
  std::copy_n(flow.cbegin(), flowDim, &output[2]);
 
  return true;
}

References olb::GenericF< T, S >::getTargetDim(), olb::singleton::mpi(), and olb::singleton::MpiManager::reduceAndBcast().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

_f

template<typename T >

FunctorPtr<SuperF3D<T> > olb::SuperPlaneIntegralF3D< T >::_f

protected

Functor to be integrated on the plane.

Definition at line 50 of file superPlaneIntegralF3D.h.

_geometry

template<typename T >

SuperGeometry<T,3>& olb::SuperPlaneIntegralF3D< T >::_geometry

protected

Definition at line 47 of file superPlaneIntegralF3D.h.

_integrationIndicatorF

template<typename T >

FunctorPtr<SuperIndicatorF3D<T> > olb::SuperPlaneIntegralF3D< T >::_integrationIndicatorF

protected

Indicator describing relevant discrete integration points.

Definition at line 52 of file superPlaneIntegralF3D.h.

_normal

template<typename T >

Vector<T,3> olb::SuperPlaneIntegralF3D< T >::_normal

protected

Orthogonal vector to _u and _v.

Definition at line 71 of file superPlaneIntegralF3D.h.

_origin

template<typename T >

Vector<T,3> olb::SuperPlaneIntegralF3D< T >::_origin

protected

Origin vector as given by hyperplane definition, (0,0) in respect to the subplane indicator _subplaneIndicatorF.

Note: The reduced plane _reductionF calculates its own origin based on _origin as its spans the maximum size possible given the span vectors, origin and geometry size.

Definition at line 65 of file superPlaneIntegralF3D.h.

_rankLocalSubplane

template<typename T >

std::vector<std::tuple<int, int> > olb::SuperPlaneIntegralF3D< T >::_rankLocalSubplane

protected

Subset of the discrete plane points given by _reductionF as indicated by _integrationIndicatorF.

i.e. the points used to interpolate the hyperplane

Definition at line 75 of file superPlaneIntegralF3D.h.

_reductionF

template<typename T >

BlockReduction3D2D<T> olb::SuperPlaneIntegralF3D< T >::_reductionF

protected

Functor describing plane to be interpolated and integrated.

Definition at line 56 of file superPlaneIntegralF3D.h.

_subplaneIndicatorF

template<typename T >

FunctorPtr<IndicatorF2D<T> > olb::SuperPlaneIntegralF3D< T >::_subplaneIndicatorF

protected

Indicator describing the relevant subset of the interpolated hyperplane.

Definition at line 54 of file superPlaneIntegralF3D.h.

_u

template<typename T >

Vector<T,3> olb::SuperPlaneIntegralF3D< T >::_u

protected

Span vector u as given by hyperplane definition, normalized to h.

Definition at line 67 of file superPlaneIntegralF3D.h.

_v

template<typename T >

Vector<T,3> olb::SuperPlaneIntegralF3D< T >::_v

protected

Span vector v as given by hyperplane definition, normalized to h.

Definition at line 69 of file superPlaneIntegralF3D.h.

---

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

• src/functors/lattice/integral/superPlaneIntegralF3D.h
• src/functors/lattice/integral/superPlaneIntegralF3D.hh