openCARP
Doxygen code documentation for the open cardiac electrophysiology simulator openCARP
Public Member Functions | Public Attributes | List of all members
SF::scattering Class Reference

Container for a PETSc VecScatter. More...

#include <SF_abstract_vector.h>

Collaboration diagram for SF::scattering:

Public Member Functions

 scattering ()
 Constructor. More...
 
 ~scattering ()
 Destructor. More...
 
template<class T , class S >
void forward (abstract_vector< T, S > &in, abstract_vector< T, S > &out, bool add=false)
 Forward scattering. More...
 
template<class T , class S >
void backward (abstract_vector< T, S > &in, abstract_vector< T, S > &out, bool add=false)
 Backward scattering. More...
 
template<class T , class S >
void operator() (abstract_vector< T, S > &v, bool fwd)
 Apply the scattering on a data vector. More...
 

Public Attributes

Vec b_buff
 A buffer vector which also defines the parallel layout of the "b" side. More...
 
VecScatter vec_sc
 The scatterer. More...
 
vector< SF_intidx_a
 
vector< SF_intidx_b
 

Detailed Description

Container for a PETSc VecScatter.

A VecScatter redistributes vector data from indexing "a" to indexing "b". Where the two indexings can have different parallel layouts.

Definition at line 669 of file SF_abstract_vector.h.

Constructor & Destructor Documentation

◆ scattering()

SF::scattering::scattering ( )
inline

Constructor.

Definition at line 678 of file SF_abstract_vector.h.

◆ ~scattering()

SF::scattering::~scattering ( )
inline

Destructor.

Definition at line 682 of file SF_abstract_vector.h.

Member Function Documentation

◆ backward()

template<class T , class S >
void SF::scattering::backward ( abstract_vector< T, S > &  in,
abstract_vector< T, S > &  out,
bool  add = false 
)
inline

Backward scattering.

Parameters
inScatter from.
outScatter to.

Definition at line 706 of file SF_abstract_vector.h.

Here is the caller graph for this function:

◆ forward()

template<class T , class S >
void SF::scattering::forward ( abstract_vector< T, S > &  in,
abstract_vector< T, S > &  out,
bool  add = false 
)
inline

Forward scattering.

Parameters
inScatter from.
outScatter to.

Definition at line 694 of file SF_abstract_vector.h.

Here is the caller graph for this function:

◆ operator()()

template<class T , class S >
void SF::scattering::operator() ( abstract_vector< T, S > &  v,
bool  fwd 
)
inline

Apply the scattering on a data vector.

Parameters
[in,out]vThe data vector.
[in]fwdTrue for forward, false for backward scatting.

Definition at line 718 of file SF_abstract_vector.h.

Member Data Documentation

◆ b_buff

Vec SF::scattering::b_buff

A buffer vector which also defines the parallel layout of the "b" side.

Definition at line 672 of file SF_abstract_vector.h.

◆ idx_a

vector<SF_int> SF::scattering::idx_a

Definition at line 675 of file SF_abstract_vector.h.

◆ idx_b

vector<SF_int> SF::scattering::idx_b

Definition at line 675 of file SF_abstract_vector.h.

◆ vec_sc

VecScatter SF::scattering::vec_sc

The scatterer.

Definition at line 673 of file SF_abstract_vector.h.


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