olb::opti::BlockDrelativeDifferenceObjectiveDf3D< 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::BlockDrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR >:

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

Public Member Functions
	BlockDrelativeDifferenceObjectiveDf3D (BlockStructureD< 3 > &blockStructure, BlockF3D< T > &f, BlockF3D< T > &dFdF, BlockF3D< T > &wantedF, BlockIndicatorF3D< T > &indicatorF, T globalValue, T weight)
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, typename DESCRIPTOR>
class olb::opti::BlockDrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR >

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

Definition at line 194 of file dualFunctors3D.h.

Constructor & Destructor Documentation

BlockDrelativeDifferenceObjectiveDf3D()

template<typename T , typename DESCRIPTOR >

olb::opti::BlockDrelativeDifferenceObjectiveDf3D< T, DESCRIPTOR >::BlockDrelativeDifferenceObjectiveDf3D	(	BlockStructureD< 3 > &	blockStructure,
		BlockF3D< T > &	f,
		BlockF3D< T > &	dFdF,
		BlockF3D< T > &	wantedF,
		BlockIndicatorF3D< T > &	indicatorF,
		T	globalValue,
		T	weight )

Definition at line 390 of file dualFunctors3D.hh.

           :
  BlockF3D<T>(blockStructure, DESCRIPTOR::q),
  _f(f), _dFdF(dFdF), _wantedF(wantedF), _indicatorF(indicatorF),
  _globalValue(globalValue), _weight(weight)
{
  this->getName() = "BlockDrelativeDifferenceObjectiveDf";
}

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

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T , typename DESCRIPTOR >

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

virtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, int >.

Definition at line 406 of file dualFunctors3D.hh.

{
  for (int jPop=0; jPop < DESCRIPTOR::q; ++jPop) {
    dJdF[jPop] = T{};
  }
 
  if (_indicatorF(latticeR)) {
    const int nDim = DESCRIPTOR::d;
 
    T dJdD[nDim] {};
 
    T f[nDim] {};
    _f(f, latticeR);
 
    T wantedF[nDim] {};
    _wantedF(wantedF, latticeR);
 
    T dFdF[nDim*DESCRIPTOR::q] {};
    _dFdF(dFdF, latticeR);
 
    for (int iDim=0; iDim < nDim; ++iDim) {
      dJdD[iDim] = (f[iDim] - wantedF[iDim]) / _globalValue * _weight;
 
      for (int jPop=0; jPop < DESCRIPTOR::q; ++jPop) {
        dJdF[jPop] += dJdD[iDim] * dFdF[jPop*nDim + iDim];
      }
    }
  }
 
  return true;
}

---

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

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