MFEM v4.8.0
Finite element discretization library
Loading...
Searching...
No Matches
mfem::Ginkgo::VectorWrapper Class Reference

#include <ginkgo.hpp>

Inheritance diagram for mfem::Ginkgo::VectorWrapper:
[legend]
Collaboration diagram for mfem::Ginkgo::VectorWrapper:
[legend]

Public Member Functions

 VectorWrapper (std::shared_ptr< const gko::Executor > exec, gko::size_type size, Vector *mfem_vec, bool ownership=false)
 
Vectorget_mfem_vec_ref ()
 
const Vectorget_mfem_vec_const_ref () const
 
std::unique_ptr< gko::matrix::Dense< real_t > > create_with_same_config () const override
 
std::unique_ptr< gko::matrix::Dense< real_t > > create_with_type_of_impl (std::shared_ptr< const gko::Executor > exec, const gko::dim< 2 > &size, gko::size_type stride) const override
 
std::unique_ptr< gko::matrix::Dense< real_t > > create_submatrix_impl (const gko::span &rows, const gko::span &columns, const gko::size_type stride) override
 

Static Public Member Functions

static std::unique_ptr< VectorWrappercreate (std::shared_ptr< const gko::Executor > exec, gko::size_type size, Vector *mfem_vec, bool ownership=false)
 

Detailed Description

This class wraps an MFEM vector object for Ginkgo's use. It allows Ginkgo and MFEM to operate directly on the same data, and is necessary to use MFEM Operators with Ginkgo solvers.

Definition at line 66 of file ginkgo.hpp.

Constructor & Destructor Documentation

◆ VectorWrapper()

mfem::Ginkgo::VectorWrapper::VectorWrapper ( std::shared_ptr< const gko::Executor > exec,
gko::size_type size,
Vector * mfem_vec,
bool ownership = false )
inline

Definition at line 69 of file ginkgo.hpp.

Member Function Documentation

◆ create()

static std::unique_ptr< VectorWrapper > mfem::Ginkgo::VectorWrapper::create ( std::shared_ptr< const gko::Executor > exec,
gko::size_type size,
Vector * mfem_vec,
bool ownership = false )
inlinestatic

Definition at line 102 of file ginkgo.hpp.

◆ create_submatrix_impl()

std::unique_ptr< gko::matrix::Dense< real_t > > mfem::Ginkgo::VectorWrapper::create_submatrix_impl ( const gko::span & rows,
const gko::span & columns,
const gko::size_type stride )
inlineoverride

Definition at line 172 of file ginkgo.hpp.

◆ create_with_same_config()

std::unique_ptr< gko::matrix::Dense< real_t > > mfem::Ginkgo::VectorWrapper::create_with_same_config ( ) const
inlineoverride

Definition at line 121 of file ginkgo.hpp.

◆ create_with_type_of_impl()

std::unique_ptr< gko::matrix::Dense< real_t > > mfem::Ginkgo::VectorWrapper::create_with_type_of_impl ( std::shared_ptr< const gko::Executor > exec,
const gko::dim< 2 > & size,
gko::size_type stride ) const
inlineoverride

Definition at line 142 of file ginkgo.hpp.

◆ get_mfem_vec_const_ref()

const Vector & mfem::Ginkgo::VectorWrapper::get_mfem_vec_const_ref ( ) const
inline

Definition at line 116 of file ginkgo.hpp.

◆ get_mfem_vec_ref()

Vector & mfem::Ginkgo::VectorWrapper::get_mfem_vec_ref ( )
inline

Definition at line 113 of file ginkgo.hpp.


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