MatrixTypeObject< VectorType > Struct Template Reference

Developer Documentation: MeltPoolDG::MatrixTypeObject< VectorType > Struct Template Reference
Developer Documentation
MeltPoolDG::MatrixTypeObject< VectorType > Struct Template Reference

#include <matrix_type_wrapper.h>

Public Member Functions

 MatrixTypeObject (const std::function< void(VectorType &, const VectorType &)> &alias_function)
 
void vmult (VectorType &dst, const VectorType &src) const
 

Private Attributes

const std::function< void(VectorType &, const VectorType &)> alias_function
 

Constructor & Destructor Documentation

◆ MatrixTypeObject()

template<typename VectorType >
MeltPoolDG::MatrixTypeObject< VectorType >::MatrixTypeObject ( const std::function< void(VectorType &, const VectorType &)> &  alias_function)
inlineexplicit

Constructor, setting the function computing the actual matrix vector product in the member function @f vmult().

Parameters
alias_functionFucntion to be called in @f vmult().

Member Function Documentation

◆ vmult()

template<typename VectorType >
void MeltPoolDG::MatrixTypeObject< VectorType >::vmult ( VectorType &  dst,
const VectorType &  src 
) const
inline

Apply the function passed to the constructor of this object. The exact functionality of this function therefore depends on the user.

Parameters
dstDestination, in which the result is stored.
srcAdditional vector used during the calculation.

Member Data Documentation

◆ alias_function

template<typename VectorType >
const std::function<void(VectorType &, const VectorType &)> MeltPoolDG::MatrixTypeObject< VectorType >::alias_function
private

The documentation for this struct was generated from the following file: