olb::opti::DrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR > Class Template Reference

functor to compute 0.5(f-f_wanted)^2/f_wanted^2 on a lattice More...

#include <dualFunctors3D.h>

Inheritance diagram for olb::opti::DrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR >:

Collaboration diagram for olb::opti::DrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR >:

Public Member Functions
	DrelativeDifferenceObjectiveDf3D (SuperLattice< T, DESCRIPTOR > &sLattice, FunctorPtr< SuperF3D< T, T > > &&f, FunctorPtr< SuperF3D< T, T > > &&dFdF, FunctorPtr< SuperF3D< T, T > > &&wantedF, FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF)
	DrelativeDifferenceObjectiveDf3D (SuperLattice< T, DESCRIPTOR > &sLattice, FunctorPtr< SuperF3D< T, T > > &&f, FunctorPtr< SuperF3D< T, T > > &&dFdF, FunctorPtr< AnalyticalF3D< T, T > > &&wantedF, FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF)
	DrelativeDifferenceObjectiveDf3D (SuperLattice< T, DESCRIPTOR > &sLattice, FunctorPtr< SuperF3D< T, T > > &&f, FunctorPtr< SuperF3D< T, T > > &&dFdF, FunctorPtr< AnalyticalF3D< T, T > > &&wantedF, SuperGeometry< T, 3 > &geometry, std::vector< int > materials)
	DrelativeDifferenceObjectiveDf3D (SuperLattice< T, DESCRIPTOR > &sLattice, FunctorPtr< SuperF3D< T, T > > &&f, FunctorPtr< SuperF3D< T, T > > &&dFdF, FunctorPtr< AnalyticalF3D< T, T > > &&wantedF, SuperGeometry< T, 3 > &geometry, int material)
bool	operator() (T output[], const int input[])
Public Member Functions inherited from olb::SuperF3D< T, T >
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[])
	has to be implemented for 'every' derived class
Public Member Functions inherited from olb::GenericF< W, 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() (W output[])
	wrapper that call the pure virtual operator() (T output[], const S input[]) from above
bool	operator() (W output[], int input0)
bool	operator() (W output[], int input0, int input1)
bool	operator() (W output[], int input0, int input1, int input2)
bool	operator() (W output[], int input0, int input1, int input2, int input3)

Additional Inherited Members
Public Types inherited from olb::SuperF3D< T, T >
using	identity_functor_type
Public Types inherited from olb::GenericF< W, int >
using	targetType
using	sourceType
Public Attributes inherited from olb::GenericF< W, int >
std::shared_ptr< GenericF< W, int > >	_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::SuperF3D< T, T >
	SuperF3D (SuperStructure< T, 3 > &superStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< W, int >
	GenericF (int targetDim, int sourceDim)
Protected Attributes inherited from olb::SuperF3D< T, T >
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, typename DESCRIPTOR>
class olb::opti::DrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR >

functor to compute 0.5(f-f_wanted)^2/f_wanted^2 on a lattice

Definition at line 218 of file dualFunctors3D.h.

Constructor & Destructor Documentation

DrelativeDifferenceObjectiveDf3D() [1/4]

template<typename T , typename DESCRIPTOR >

olb::opti::DrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR >::DrelativeDifferenceObjectiveDf3D	(	SuperLattice< T, DESCRIPTOR > &	sLattice,
		FunctorPtr< SuperF3D< T, T > > &&	f,
		FunctorPtr< SuperF3D< T, T > > &&	dFdF,
		FunctorPtr< SuperF3D< T, T > > &&	wantedF,
		FunctorPtr< SuperIndicatorF3D< T > > &&	indicatorF )

Definition at line 439 of file dualFunctors3D.hh.

  :  SuperF3D<T,T>(sLattice, DESCRIPTOR::q),
     _f(std::move(f)),
     _dFdF(std::move(dFdF)),
     _wantedF(std::move(wantedF)),
     _indicatorF(std::move(indicatorF))
{
  this->getName() = "dRelativeDifferenceObjectiveDf_Lattice";
 
  SuperL2Norm3D<T> wantedFlp(*_wantedF, *_indicatorF);
  T output[1] {};
  wantedFlp(output, nullptr);
 
  const T globalValue = util::pow(output[0], 2);
  const T weight = util::pow(sLattice.getCuboidDecomposition().getDeltaR(), 3);
  // util::pow(_f->getSuperStructure().getCuboidDecomposition().getDeltaR(), 3);
 
  for (int iC = 0; iC < sLattice.getLoadBalancer().size(); ++iC) {
    this->_blockF.emplace_back(
      new BlockDrelativeDifferenceObjectiveDf3D<T,DESCRIPTOR>(
        sLattice.getBlock(iC),
        _f->getBlockF(iC),
        _dFdF->getBlockF(iC),
        _wantedF->getBlockF(iC),
        _indicatorF->getBlockIndicatorF(iC),
        globalValue,
        weight)
    );
  }
}

References olb::SuperF3D< T, T >::_blockF, olb::SuperLattice< T, DESCRIPTOR >::getBlock(), olb::SuperStructure< T, D >::getCuboidDecomposition(), olb::SuperStructure< T, D >::getLoadBalancer(), olb::GenericF< W, int >::getName(), and olb::util::pow().

Here is the call graph for this function:

DrelativeDifferenceObjectiveDf3D() [2/4]

template<typename T , typename DESCRIPTOR >

olb::opti::DrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR >::DrelativeDifferenceObjectiveDf3D	(	SuperLattice< T, DESCRIPTOR > &	sLattice,
		FunctorPtr< SuperF3D< T, T > > &&	f,
		FunctorPtr< SuperF3D< T, T > > &&	dFdF,
		FunctorPtr< AnalyticalF3D< T, T > > &&	wantedF,
		FunctorPtr< SuperIndicatorF3D< T > > &&	indicatorF )

Definition at line 476 of file dualFunctors3D.hh.

  : DrelativeDifferenceObjectiveDf3D(sLattice,
                                     std::forward<decltype(f)>(f),
                                     std::forward<decltype(dFdF)>(dFdF),
                                     std::unique_ptr<SuperF3D<T,T>>(
                                       std::make_unique<SuperLatticeFfromAnalyticalF3D<T,DESCRIPTOR>>(
                                         std::forward<decltype(wantedF)>(wantedF), sLattice)),
                                     std::forward<decltype(indicatorF)>(indicatorF))
{ }

DrelativeDifferenceObjectiveDf3D() [3/4]

template<typename T , typename DESCRIPTOR >

olb::opti::DrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR >::DrelativeDifferenceObjectiveDf3D	(	SuperLattice< T, DESCRIPTOR > &	sLattice,
		FunctorPtr< SuperF3D< T, T > > &&	f,
		FunctorPtr< SuperF3D< T, T > > &&	dFdF,
		FunctorPtr< AnalyticalF3D< T, T > > &&	wantedF,
		SuperGeometry< T, 3 > &	geometry,
		std::vector< int >	materials )

Definition at line 492 of file dualFunctors3D.hh.

  : DrelativeDifferenceObjectiveDf3D(sLattice,
                                     std::forward<decltype(f)>(f),
                                     std::forward<decltype(dFdF)>(dFdF),
                                     std::forward<decltype(wantedF)>(wantedF),
                                     geometry.getMaterialIndicator(materials))
{ }

DrelativeDifferenceObjectiveDf3D() [4/4]

template<typename T , typename DESCRIPTOR >

olb::opti::DrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR >::DrelativeDifferenceObjectiveDf3D	(	SuperLattice< T, DESCRIPTOR > &	sLattice,
		FunctorPtr< SuperF3D< T, T > > &&	f,
		FunctorPtr< SuperF3D< T, T > > &&	dFdF,
		FunctorPtr< AnalyticalF3D< T, T > > &&	wantedF,
		SuperGeometry< T, 3 > &	geometry,
		int	material )

Definition at line 507 of file dualFunctors3D.hh.

  : DrelativeDifferenceObjectiveDf3D(sLattice,
                                     std::forward<decltype(f)>(f),
                                     std::forward<decltype(dFdF)>(dFdF),
                                     std::forward<decltype(wantedF)>(wantedF),
                                     geometry.getMaterialIndicator(material))
{ }

Member Function Documentation

operator()()

template<typename T , typename DESCRIPTOR >

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

Definition at line 522 of file dualFunctors3D.hh.

{
  for (int i=0; i < DESCRIPTOR::q; ++i) {
    dJdF[i] = T{};
  }
 
  auto& load = _f->getSuperStructure().getLoadBalancer();
 
  if (load.isLocal(latticeR[0])) {
    return this->getBlockF(load.loc(latticeR[0]))(dJdF, &latticeR[1]);
  }
  else {
    return true;
  }
}

References olb::SuperStructure< T, D >::getLoadBalancer(), and olb::SuperF3D< T, U >::getSuperStructure().

Here is the call graph for this function:

---

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

• src/optimization/functors/dualFunctors3D.h
• src/optimization/functors/dualFunctors3D.hh