olb::BlockRoundingF3D< T > Class Template Reference

Block functor for rounding the value in a certain mode: None := No rounding NearestInteger := rounding to nearest integer Floor:= rounding to nearest lower integer Ceil := rounding to nearest higher integer. More...

#include <blockRoundingF3D.h>

Inheritance diagram for olb::BlockRoundingF3D< T >:

Collaboration diagram for olb::BlockRoundingF3D< T >:

Public Member Functions
	BlockRoundingF3D (BlockF3D< T > &f, RoundingMode rounding=RoundingMode::NearestInteger)
bool	operator() (T output[], const int input[])
	has to be implemented for 'every' derived class
Public Member Functions inherited from olb::BlockF3D< T >
	~BlockF3D () override
	virtual destructor for defined behaviour
virtual BlockStructureD< 3 > &	getBlockStructure () const
BlockF3D< T > &	operator- (BlockF3D< T > &rhs)
BlockF3D< T > &	operator+ (BlockF3D< T > &rhs)
BlockF3D< T > &	operator* (BlockF3D< T > &rhs)
BlockF3D< T > &	operator/ (BlockF3D< T > &rhs)
Public Member Functions inherited from olb::GenericF< T, int >
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
bool	operator() (T output[])
	wrapper that call the pure virtual operator() (T output[], const S input[]) from above
bool	operator() (T output[], int input0)
bool	operator() (T output[], int input0, int input1)
bool	operator() (T output[], int input0, int input1, int input2)
bool	operator() (T output[], int input0, int input1, int input2, int input3)

Additional Inherited Members
Public Types inherited from olb::GenericF< T, int >
using	targetType
using	sourceType
Public Attributes inherited from olb::GenericF< T, int >
std::shared_ptr< GenericF< T, int > >	_ptrCalcC
	memory management, frees resouces (calcClass)
Protected Member Functions inherited from olb::BlockF3D< T >
	BlockF3D (BlockStructureD< 3 > &blockStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< T, int >
	GenericF (int targetDim, int sourceDim)
Protected Attributes inherited from olb::BlockF3D< T >
BlockStructureD< 3 > &	_blockStructure

Detailed Description

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

Block functor for rounding the value in a certain mode: None := No rounding NearestInteger := rounding to nearest integer Floor:= rounding to nearest lower integer Ceil := rounding to nearest higher integer.

Definition at line 40 of file blockRoundingF3D.h.

Constructor & Destructor Documentation

BlockRoundingF3D()

template<typename T >

olb::BlockRoundingF3D< T >::BlockRoundingF3D	(	BlockF3D< T > &	f,
		RoundingMode	rounding = RoundingMode::NearestInteger )

Parameters

f	Block functor
rounding	Mode how the value shall be rounded

Definition at line 33 of file blockRoundingF3D.hh.

  :BlockF3D<T>(f.getBlockStructure(),f.getTargetDim()),_f(f),_rounding(rounding)
{
  this->getName() = "Rounding(" + _f.getName() + ")";
}

References olb::GenericF< T, int >::getName().

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T >

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

virtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, int >.

Definition at line 41 of file blockRoundingF3D.hh.

{
 
  _f(output, input);
 
  switch ( _rounding ) {
  case RoundingMode::NearestInteger:
    for ( int i=0; i < _f.getTargetDim(); i++ ) {
      output[i] = std::nearbyint(output[i]);
    }
    break;
  case RoundingMode::None:
    for ( int i=0; i < _f.getTargetDim(); i++ ) {
      output[i] = output[i];
    }
    break;
  case RoundingMode::Floor:
    for ( int i=0; i < _f.getTargetDim(); i++ ) {
      output[i] = util::floor(output[i]);
    }
    break;
  case RoundingMode::Ceil:
    for ( int i=0; i < _f.getTargetDim(); i++ ) {
      output[i] = util::ceil(output[i]);
    }
    break;
  }
 
  return true;
}

References olb::util::ceil(), olb::Ceil, olb::util::floor(), olb::Floor, olb::NearestInteger, and olb::None.

Here is the call graph for this function:

---

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

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