ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF > Struct Template Reference

#include <Preconditioner.h>

Inheritance diagram for ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >:

Collaboration diagram for ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >:

Public Types
using	mesh_type = typename Field::Mesh_t
using	layout_type = typename Field::Layout_t
Public Types inherited from ippl::preconditioner< Field >
using	mesh_type = typename Field::Mesh_t
using	layout_type = typename Field::Layout_t

Public Member Functions
	gs_preconditioner (LowerF &&lower, UpperF &&upper, InvDiagF &&inverse_diagonal, unsigned innerloops, unsigned outerloops)
void	operator() (Field &b, Field &result) override
void	init_fields (Field &b) override
Public Member Functions inherited from ippl::preconditioner< Field >
	preconditioner (std::string name)
std::string	get_type ()

Static Public Attributes
static constexpr unsigned	Dim = Field::dim
Static Public Attributes inherited from ippl::preconditioner< Field >
static constexpr unsigned	Dim = Field::dim

Protected Attributes
LowerF	lower_m
UpperF	upper_m
InvDiagF	inverse_diagonal_m
unsigned	innerloops_m
unsigned	outerloops_m
Field	UL_m
Field	r_m
bool	fields_initialized_m = false
Protected Attributes inherited from ippl::preconditioner< Field >
std::string	type_m

Detailed Description

template<typename Field, typename LowerF, typename UpperF, typename InvDiagF>
struct ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >

2-step Gauss-Seidel preconditioner

Member Function Documentation

init_fields()

template<typename Field , typename LowerF , typename UpperF , typename InvDiagF >

void ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::init_fields ( Field &  b )

inlineoverridevirtual

Reimplemented from ippl::preconditioner< Field >.

operator()()

template<typename Field , typename LowerF , typename UpperF , typename InvDiagF >

void ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >::operator() ( Field &  b, Field &  result  )

inlineoverridevirtual

Reimplemented from ippl::preconditioner< Field >.

---

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

• ippl-src/src/LinearSolvers/Preconditioner.h