OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
olb::IndicatorF1D< S > Class Template Reference

IndicatorF1D is an application from $ \Omega \subset R \to {0,1} $. More...

#include <indicatorBaseF2D.h>

+ Inheritance diagram for olb::IndicatorF1D< S >:
+ Collaboration diagram for olb::IndicatorF1D< S >:

Public Member Functions

virtual Vector< S, 1 > & getMin ()
 
virtual Vector< S, 1 > & getMax ()
 
IndicatorF1D< S > & operator+ (IndicatorF1D< S > &rhs)
 
IndicatorF1D< S > & operator- (IndicatorF1D< S > &rhs)
 
IndicatorF1D< S > & operator* (IndicatorF1D< S > &rhs)
 
virtual bool operator() (const S input[])
 Indicator specific function operator overload.
 
- Public Member Functions inherited from olb::GenericF< bool, 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() (bool output[], const S input[])=0
 has to be implemented for 'every' derived class
 
bool operator() (bool output[])
 wrapper that call the pure virtual operator() (T output[], const S input[]) from above
 
bool operator() (bool output[], S input0)
 
bool operator() (bool output[], S input0, S input1)
 
bool operator() (bool output[], S input0, S input1, S input2)
 
bool operator() (bool output[], S input0, S input1, S input2, S input3)
 

Protected Member Functions

 IndicatorF1D ()
 
- Protected Member Functions inherited from olb::GenericF< bool, S >
 GenericF (int targetDim, int sourceDim)
 

Protected Attributes

Vector< S, 1 > _myMin
 
Vector< S, 1 > _myMax
 

Additional Inherited Members

- Public Types inherited from olb::GenericF< bool, S >
using targetType
 
using sourceType
 
- Public Attributes inherited from olb::GenericF< bool, S >
std::shared_ptr< GenericF< bool, S > > _ptrCalcC
 memory management, frees resouces (calcClass)
 

Detailed Description

template<typename S>
class olb::IndicatorF1D< S >

IndicatorF1D is an application from $ \Omega \subset R \to {0,1} $.

Parameters
_myMinholds minimal(component wise) vector of the domain $ \Omega $.
_myMaxholds maximal(component wise) vector of the domain $ \Omega $.

Definition at line 42 of file indicatorBaseF2D.h.

Constructor & Destructor Documentation

◆ IndicatorF1D()

template<typename S >
olb::IndicatorF1D< S >::IndicatorF1D ( )
protected

Definition at line 39 of file indicatorBaseF2D.hh.

40 : GenericF<bool,S>(1, 1)
41{ }

Member Function Documentation

◆ getMax()

template<typename S >
Vector< S, 1 > & olb::IndicatorF1D< S >::getMax ( )
virtual

Definition at line 50 of file indicatorBaseF2D.hh.

51{
52 return _myMax;
53}
Vector< S, 1 > _myMax
+ Here is the caller graph for this function:

◆ getMin()

template<typename S >
Vector< S, 1 > & olb::IndicatorF1D< S >::getMin ( )
virtual

Definition at line 44 of file indicatorBaseF2D.hh.

45{
46 return _myMin;
47}
Vector< S, 1 > _myMin
+ Here is the caller graph for this function:

◆ operator()()

template<typename S >
bool olb::IndicatorF1D< S >::operator() ( const S input[])
virtual

Indicator specific function operator overload.

Returns
Domain indicator i.e. true iff the input lies within the described domain.

Definition at line 56 of file indicatorBaseF2D.hh.

57{
58 bool output{};
59 this->operator()(&output, input);
60 return output;
61}
virtual bool operator()(const S input[])
Indicator specific function operator overload.

◆ operator*()

template<typename S >
IndicatorF1D< S > & olb::IndicatorF1D< S >::operator* ( IndicatorF1D< S > & rhs)

Definition at line 114 of file indicCalc2D.hh.

115{
116 auto tmp = std::make_shared< IndicMultiplication1D<S> >(*this,rhs);
117 this->_ptrCalcC = tmp;
118 return *tmp;
119}
std::shared_ptr< GenericF< bool, S > > _ptrCalcC
memory management, frees resouces (calcClass)
Definition genericF.h:71

◆ operator+()

template<typename S >
IndicatorF1D< S > & olb::IndicatorF1D< S >::operator+ ( IndicatorF1D< S > & rhs)

Definition at line 98 of file indicCalc2D.hh.

99{
100 auto tmp = std::make_shared< IndicPlus1D<S> >(*this,rhs);
101 this->_ptrCalcC = tmp;
102 return *tmp;
103}

◆ operator-()

template<typename S >
IndicatorF1D< S > & olb::IndicatorF1D< S >::operator- ( IndicatorF1D< S > & rhs)

Definition at line 106 of file indicCalc2D.hh.

107{
108 auto tmp = std::make_shared< IndicMinus1D<S> >(*this,rhs);
109 this->_ptrCalcC = tmp;
110 return *tmp;
111}

Member Data Documentation

◆ _myMax

template<typename S >
Vector<S,1> olb::IndicatorF1D< S >::_myMax
protected

Definition at line 46 of file indicatorBaseF2D.h.

◆ _myMin

template<typename S >
Vector<S,1> olb::IndicatorF1D< S >::_myMin
protected

Definition at line 45 of file indicatorBaseF2D.h.


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