OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | List of all members
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
 
- 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::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::SuperIdentity3D< T, T >
FunctorPtr< SuperF3D< T, T > > _f
 
- 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, 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 374 of file dualFunctors3D.hh.

379 : SuperIdentity3D<T,T>([&]()
380{
381 using namespace functor_dsl;
382
383 auto wantedLatticeF = restrictF(wantedF.toShared(), sLattice);
384 auto relativeDifferenceF = norm<2>(f.toShared() - wantedLatticeF, indicatorF.toShared()) /
385 norm<2>(wantedLatticeF, indicatorF.toShared());
386
387 return pow(relativeDifferenceF, 2) / T(2.0);
388}())
389{
390 this->getName() = "relativeDifferenceObjective";
391}
std::string & getName()
read and write access to name
Definition genericF.hh:51
Pack< T > pow(Pack< T > base, Pack< T > exp)
Definition 256.h:395
std::shared_ptr< SuperF2D< T, W > > restrictF(std::shared_ptr< AnalyticalF2D< T, W > > f, SuperLattice< T, DESCRIPTOR > &sLattice)
Returns restriction of a analytical functor f to the lattice sLattice.

◆ 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 394 of file dualFunctors3D.hh.

399 f->getSuperLattice(),
400 std::static_pointer_cast<SuperF3D<T,T>>(f.toShared()),
401 std::forward<decltype(wantedF)>(wantedF),
402 std::forward<decltype(indicatorF)>(indicatorF))
403{ }
RelativeDifferenceObjective3D(SuperLattice< T, DESCRIPTOR > &sLattice, FunctorPtr< SuperF3D< T, T > > &&f, FunctorPtr< AnalyticalF3D< T, T > > &&wantedF, FunctorPtr< SuperIndicatorF3D< T > > &&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 406 of file dualFunctors3D.hh.

413 sLattice,
414 std::forward<decltype(f)>(f),
415 std::forward<decltype(wantedF)>(wantedF),
416 geometry.getMaterialIndicator(materials))
417{ }
std::unique_ptr< SuperIndicatorF< T, D > > getMaterialIndicator(std::vector< int > &&materials)
Returns a material indicator using the given vector of 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 420 of file dualFunctors3D.hh.

427 sLattice,
428 std::forward<decltype(f)>(f),
429 std::forward<decltype(wantedF)>(wantedF),
430 geometry.getMaterialIndicator(material))
431{ }

◆ 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 434 of file dualFunctors3D.hh.

439 : SuperIdentity3D<T,T>([&]()
440{
441 using namespace functor_dsl;
442
443 // auto wantedLatticeF = restrictF(wantedF.toShared(), sLattice);
444 auto relativeDifferenceF = norm<2>(f.toShared() - wantedF.toShared(), indicatorF.toShared()) /
445 norm<2>(wantedF.toShared(), indicatorF.toShared());
446
447 return pow(relativeDifferenceF, 2) / T(2.0);
448}())
449{
450 this->getName() = "relativeDifferenceObjective";
451}

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