#include <Preconditioner.h>

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

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

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
	ssor_preconditioner (LowerF &&lower, UpperF &&upper, InvDiagF &&inverse_diagonal, DiagF &&diagonal, unsigned innerloops, unsigned outerloops, double omega)

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

DiagF	diagonal_m

unsigned	innerloops_m

unsigned	outerloops_m

double	omega_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, typename DiagF>
struct ippl::ssor_preconditioner< Field, LowerF, UpperF, InvDiagF, DiagF >

Symmetric successive over-relaxation

Member Function Documentation

◆ init_fields()

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

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

inlineoverridevirtual

Reimplemented from ippl::preconditioner< Field >.

◆ operator()()

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

void ippl::ssor_preconditioner< Field, LowerF, UpperF, InvDiagF, DiagF >::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

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Member Function Documentation

◆ init_fields()

◆ operator()()