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

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

#include <dualFunctors3D.h>

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

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

Public Member Functions
	RelativeDifferenceObjective3D (SuperLattice< T, DESCRIPTOR > &sLattice, FunctorPtr< SuperF3D< T, T > > &&f, FunctorPtr< AnalyticalF3D< T, T > > &&wantedF, FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF)
	RelativeDifferenceObjective3D (FunctorPtr< SuperLatticeF3D< T, DESCRIPTOR > > &&f, FunctorPtr< AnalyticalF3D< T, T > > &&wantedF, FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF)
	RelativeDifferenceObjective3D (SuperLattice< T, DESCRIPTOR > &sLattice, FunctorPtr< SuperF3D< T, T > > &&f, FunctorPtr< AnalyticalF3D< T, T > > &&wantedF, SuperGeometry< T, 3 > &geometry, std::vector< int > materials)
	RelativeDifferenceObjective3D (SuperLattice< T, DESCRIPTOR > &sLattice, FunctorPtr< SuperF3D< T, T > > &&f, FunctorPtr< AnalyticalF3D< T, T > > &&wantedF, SuperGeometry< T, 3 > &geometry, int material)
	RelativeDifferenceObjective3D (SuperLattice< T, DESCRIPTOR > &sLattice, FunctorPtr< SuperF3D< T, T > > &&f, FunctorPtr< SuperF3D< T, T > > &&wantedF, FunctorPtr< SuperIndicatorF3D< T > > &&indicatorF)
Public Member Functions inherited from olb::SuperIdentity3D< T, T >
	SuperIdentity3D (FunctorPtr< SuperF3D< T, T > > &&f)
bool	operator() (T output[], const int input[]) override
	has to be implemented for 'every' derived class
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)
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::SuperIdentity3D< T, T >
FunctorPtr< SuperF3D< T, T > >	_f
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::RelativeDifferenceObjective3D< T, DESCRIPTOR >

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

Definition at line 158 of file dualFunctors3D.h.

Constructor & Destructor Documentation

RelativeDifferenceObjective3D() [1/5]

template<typename T , typename DESCRIPTOR >

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

Definition at line 309 of file dualFunctors3D.hh.

  : SuperIdentity3D<T,T>([&]()
{
  using namespace functor_dsl;
 
  auto wantedLatticeF = restrictF(wantedF.toShared(), sLattice);
  auto relativeDifferenceF = norm<2>(f.toShared() - wantedLatticeF, indicatorF.toShared()) /
                             norm<2>(wantedLatticeF,                indicatorF.toShared());
 
  return pow(relativeDifferenceF, 2) / T(2.0);
}())
{
  this->getName() = "relativeDifferenceObjective";
}

References olb::norm().

Here is the call graph for this function:

RelativeDifferenceObjective3D() [2/5]

template<typename T , typename DESCRIPTOR >

olb::opti::RelativeDifferenceObjective3D< T, DESCRIPTOR >::RelativeDifferenceObjective3D	(	FunctorPtr< SuperLatticeF3D< T, DESCRIPTOR > > &&	f,
		FunctorPtr< AnalyticalF3D< T, T > > &&	wantedF,
		FunctorPtr< SuperIndicatorF3D< T > > &&	indicatorF )

Definition at line 329 of file dualFunctors3D.hh.

  : RelativeDifferenceObjective3D(
      f->getSuperLattice(),
      std::static_pointer_cast<SuperF3D<T,T>>(f.toShared()),
      std::forward<decltype(wantedF)>(wantedF),
      std::forward<decltype(indicatorF)>(indicatorF))
{ }

RelativeDifferenceObjective3D() [3/5]

template<typename T , typename DESCRIPTOR >

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

Definition at line 341 of file dualFunctors3D.hh.

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

RelativeDifferenceObjective3D() [4/5]

template<typename T , typename DESCRIPTOR >

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

Definition at line 355 of file dualFunctors3D.hh.

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

RelativeDifferenceObjective3D() [5/5]

template<typename T , typename DESCRIPTOR >

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

Definition at line 369 of file dualFunctors3D.hh.

  : SuperIdentity3D<T,T>([&]()
{
  using namespace functor_dsl;
 
  // auto wantedLatticeF = restrictF(wantedF.toShared(), sLattice);
  auto relativeDifferenceF = norm<2>(f.toShared() - wantedF.toShared(), indicatorF.toShared()) /
                             norm<2>(wantedF.toShared(),                indicatorF.toShared());
 
  return pow(relativeDifferenceF, 2) / T(2.0);
}())
{
  this->getName() = "relativeDifferenceObjective";
}

References olb::norm().

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