OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
olb::SuperConst2D< T, W > Class Template Referencefinal

Functor returning a constant vector for all inputs. More...

#include <superConst2D.h>

+ Inheritance diagram for olb::SuperConst2D< T, W >:
+ Collaboration diagram for olb::SuperConst2D< T, W >:

Public Member Functions

 SuperConst2D (SuperStructure< T, 2 > &superStructure, std::vector< W > v)
 Constructor accepting std::vector.
 
 SuperConst2D (SuperStructure< T, 2 > &superStructure, W scalar)
 Constructor accepting single scalar.
 
template<unsigned Size>
 SuperConst2D (SuperStructure< T, 2 > &superStructure, Vector< W, Size > v)
 Constructor template accepting vectors.
 
bool operator() (W output[], const int input[]) override
 
- Public Member Functions inherited from olb::SuperF2D< T, W >
SuperF2D< T, W > & operator- (SuperF2D< T, W > &rhs)
 
SuperF2D< T, W > & operator+ (SuperF2D< T, W > &rhs)
 
SuperF2D< T, W > & operator* (SuperF2D< T, W > &rhs)
 
SuperF2D< T, W > & operator/ (SuperF2D< T, W > &rhs)
 
SuperStructure< T, 2 > & getSuperStructure ()
 
int getBlockFSize () const
 
BlockF2D< W > & getBlockF (int iCloc)
 
bool operator() (W output[], const int input[]) override
 
- 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)
 

Protected Attributes

const std::vector< W > _c
 
- Protected Attributes inherited from olb::SuperF2D< T, W >
SuperStructure< T, 2 > & _superStructure
 
std::vector< std::unique_ptr< BlockF2D< W > > > _blockF
 Super functors may consist of several BlockF2D<W> derived functors.
 

Additional Inherited Members

- Public Types inherited from olb::SuperF2D< T, W >
using identity_functor_type = SuperIdentity2D<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)
 
- Protected Member Functions inherited from olb::SuperF2D< T, W >
 SuperF2D (SuperStructure< T, 2 > &superStructure, int targetDim)
 
- Protected Member Functions inherited from olb::GenericF< T, S >
 GenericF (int targetDim, int sourceDim)
 

Detailed Description

template<typename T, typename W = T>
class olb::SuperConst2D< T, W >

Functor returning a constant vector for all inputs.

Note that outside of SuperCalcF2D you should never be required to instantiate this functor by itself. Functor arithmetic involving constant values only makes sense in conjunction with simulation dependent functors.

Instantiation of this functor is performed by SuperCalcF2D to compose normal functors with constant vectors. e.g. scalar multiplication

SuperCalcF2D handles compositions of blockified and non-blockified functors which is why SuperConst2D is explicitly not blockified.

Definition at line 47 of file superConst2D.h.

Constructor & Destructor Documentation

◆ SuperConst2D() [1/3]

template<typename T , typename W >
olb::SuperConst2D< T, W >::SuperConst2D ( SuperStructure< T, 2 > & superStructure,
std::vector< W > v )

Constructor accepting std::vector.

Parameters
superStructureOnly required to instantiate underlying SuperF2D
vstd::vector to be copied to output by operator. Size determines target dimension.

Definition at line 34 of file superConst2D.hh.

35 : SuperF2D<T,W>(superStructure, v.size()),
36 _c{std::move(v)}
37{
38 this->getName() = "const(" + std::to_string(_c.size()) + ")";
39}
std::string & getName()
read and write access to name
Definition genericF.hh:51
const std::vector< W > _c

References olb::SuperConst2D< T, W >::_c, and olb::GenericF< T, S >::getName().

+ Here is the call graph for this function:

◆ SuperConst2D() [2/3]

template<typename T , typename W >
olb::SuperConst2D< T, W >::SuperConst2D ( SuperStructure< T, 2 > & superStructure,
W scalar )

Constructor accepting single scalar.

Definition at line 42 of file superConst2D.hh.

43 : SuperConst2D(superStructure, std::vector<W>(1, scalar))
44{ }
SuperConst2D(SuperStructure< T, 2 > &superStructure, std::vector< W > v)
Constructor accepting std::vector.

◆ SuperConst2D() [3/3]

template<typename T , typename W = T>
template<unsigned Size>
olb::SuperConst2D< T, W >::SuperConst2D ( SuperStructure< T, 2 > & superStructure,
Vector< W, Size > v )
inline

Constructor template accepting vectors.

Definition at line 63 of file superConst2D.h.

64 : SuperConst2D(superStructure, v.toStdVector()) { };

Member Function Documentation

◆ operator()()

template<typename T , typename W >
bool olb::SuperConst2D< T, W >::operator() ( W output[],
const int input[] )
override

Definition at line 47 of file superConst2D.hh.

48{
49 for (int i = 0; i < this->getTargetDim(); ++i) {
50 output[i] = _c[i];
51 }
52 return true;
53}
int getTargetDim() const
read only access to member variable _n
Definition genericF.hh:45

Member Data Documentation

◆ _c

template<typename T , typename W = T>
const std::vector<W> olb::SuperConst2D< T, W >::_c
protected

Definition at line 49 of file superConst2D.h.


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