Velocity flux plane integral. More...

#include <superPlaneIntegralFluxF3D.h>

Inheritance diagram for olb::SuperPlaneIntegralFluxVelocity3D< T >:

Collaboration diagram for olb::SuperPlaneIntegralFluxVelocity3D< T >:

Public Member Functions
void	print (std::string regionName="", std::string fluxSiScaleName="m^3/s", std::string meanSiScaleName="m/s")

Public Member Functions inherited from olb::SuperPlaneIntegralFluxF3D< T, SuperLatticePhysVelocity3D >
	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, SuperGeometry< T, 3 > &geometry, const HyperplaneLattice3D< T > &hyperplaneLattice, FunctorPtr< SuperIndicatorF3D< T > > &&integrationIndicator, FunctorPtr< IndicatorF2D< T > > &&subplaneIndicator, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)

	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, SuperGeometry< T, 3 > &geometry, const Hyperplane3D< T > &hyperplane, FunctorPtr< SuperIndicatorF3D< T > > &&integrationIndicator, FunctorPtr< IndicatorF2D< T > > &&subplaneIndicator, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)

	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, SuperGeometry< T, 3 > &geometry, const Hyperplane3D< T > &hyperplane, FunctorPtr< SuperIndicatorF3D< T > > &&integrationIndicator, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)

	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, 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)

	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &origin, const Vector< T, 3 > &u, const Vector< T, 3 > &v, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)

	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &origin, const Vector< T, 3 > &normal, std::vector< int > materials, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)

	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &origin, const Vector< T, 3 > &normal, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)

	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &normal, std::vector< int > materials, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)

	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, SuperGeometry< T, 3 > &geometry, const Vector< T, 3 > &normal, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)

	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, SuperGeometry< T, 3 > &geometry, IndicatorCircle3D< T > &circle, std::vector< int > materials, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)

	SuperPlaneIntegralFluxF3D (SuperLattice< T, DESCRIPTOR > &sLattice, const UnitConverter< T, DESCRIPTOR > &converter, SuperGeometry< T, 3 > &geometry, IndicatorCircle3D< T > &circle, BlockDataReductionMode mode=BlockDataReductionMode::Analytical)

Public Member Functions inherited from 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.

	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)

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::SuperPlaneIntegralF3D< T >
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 inherited from olb::SuperPlaneIntegralF3D< T >
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.

Detailed Description

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

Velocity flux plane integral.

Only adds a print method. Calculation is implemented in SuperPlaneIntegralF3D which is constructed around SuperLatticePhysVelocity3D by SuperPlaneIntegralFluxF3D.

Definition at line 161 of file superPlaneIntegralFluxF3D.h.

Member Function Documentation

◆ print()

template<typename T >

void olb::SuperPlaneIntegralFluxVelocity3D< T >::print	(	std::string	regionName = "",
		std::string	fluxSiScaleName = "m^3/s",
		std::string	meanSiScaleName = "m/s" )

Definition at line 278 of file superPlaneIntegralFluxF3D.hh.

{
  OstreamManager clout("SuperPlaneIntegralFluxVelocity3D");
  int input[1] = { };
  T output[this->getTargetDim()];
  this->operator()(output, input);
  if ( regionName != "" ) {
    clout << "regionName=" << regionName << "; regionSize[m^2]=" << output[1]
          << std::flush;
  }
  else {
    clout << "regionSize[m^2]=" << output[1] << std::flush;
  }
  if ( singleton::mpi().isMainProcessor() ) {
    if ( fluxSiScaleName == "ml/s" ) {
      std::cout << "; volumetricFlowRate[ml/s]=" << output[0] * T(1.e6)
                << std::flush;
    }
    else if ( fluxSiScaleName == "l/s" ) {
      std::cout << "; volumetricFlowRate[l/s]=" << output[0] * T(1.e3)
                << std::flush;
    }
    else {
      std::cout << "; volumetricFlowRate[m^3/s]=" << output[0] << std::flush;
    }
    if ( meanSiScaleName == "mm/s" ) {
      std::cout << "; meanVelocity[mm/s]=" << output[0] / output[1] * T(1.e3)
                << std::endl;
    }
    else {
      std::cout << "; meanVelocity[m/s]=" << output[0] / output[1] << std::endl;
    }
  }
}

References olb::singleton::mpi().

Here is the call graph for this function:

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

src/functors/lattice/integral/superPlaneIntegralFluxF3D.h
src/functors/lattice/integral/superPlaneIntegralFluxF3D.hh

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ print()