#include <Preconditioner.h>

Inheritance diagram for ippl::polynomial_newton_preconditioner< Field, OperatorF >:

Collaboration diagram for ippl::polynomial_newton_preconditioner< Field, OperatorF >:

Public Types
using	mesh_type = typename Field::Mesh_t
using	layout_type = typename Field::Layout_t

Public Member Functions
	polynomial_newton_preconditioner (OperatorF &&op, double alpha, double beta, unsigned int max_level=6, double zeta=1e-3, double *eta=nullptr)
	~polynomial_newton_preconditioner ()
	polynomial_newton_preconditioner (const polynomial_newton_preconditioner &other)
polynomial_newton_preconditioner &	operator= (const polynomial_newton_preconditioner &other)
Field	recursive_preconditioner (Field &u, unsigned int level)
Field	operator() (Field &u) override
virtual void	init_fields (Field &b)
std::string	get_type ()

Static Public Attributes
static constexpr unsigned	Dim = Field::dim

Protected Attributes
OperatorF	op_m
double	alpha_m
double	beta_m
unsigned int	level_m
double	zeta_m
double *	eta_m = nullptr
std::string	type_m

Detailed Description

template<typename Field, typename OperatorF>
struct ippl::polynomial_newton_preconditioner< Field, OperatorF >

Polynomial Newton Preconditioner Computes iteratively approximations for A^-1

Definition at line 89 of file Preconditioner.h.

Member Typedef Documentation

◆ layout_type

template<typename Field, typename OperatorF>

using ippl::polynomial_newton_preconditioner< Field, OperatorF >::layout_type = typename Field::Layout_t

Definition at line 92 of file Preconditioner.h.

◆ mesh_type

template<typename Field, typename OperatorF>

using ippl::polynomial_newton_preconditioner< Field, OperatorF >::mesh_type = typename Field::Mesh_t

Definition at line 91 of file Preconditioner.h.

Constructor & Destructor Documentation

◆ polynomial_newton_preconditioner() [1/2]

template<typename Field, typename OperatorF>

ippl::polynomial_newton_preconditioner< Field, OperatorF >::polynomial_newton_preconditioner	(	OperatorF &&	op,
		double	alpha,
		double	beta,
		unsigned int	max_level = 6,
		double	zeta = 1e-3,
		double *	eta = nullptr )

inline

Definition at line 94 of file Preconditioner.h.

References alpha_m, beta_m, eta_m, level_m, op_m, ippl::preconditioner< Field >::preconditioner(), and zeta_m.

Referenced by operator=(), and polynomial_newton_preconditioner().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~polynomial_newton_preconditioner()

template<typename Field, typename OperatorF>

ippl::polynomial_newton_preconditioner< Field, OperatorF >::~polynomial_newton_preconditioner ( )

inline

Definition at line 107 of file Preconditioner.h.

References eta_m.

◆ polynomial_newton_preconditioner() [2/2]

template<typename Field, typename OperatorF>

ippl::polynomial_newton_preconditioner< Field, OperatorF >::polynomial_newton_preconditioner ( const polynomial_newton_preconditioner< Field, OperatorF > & other )

inline

Definition at line 114 of file Preconditioner.h.

References alpha_m, beta_m, eta_m, level_m, op_m, polynomial_newton_preconditioner(), ippl::preconditioner< Field >::preconditioner(), and zeta_m.

Here is the call graph for this function:

Member Function Documentation

◆ get_type()

template<typename Field>

std::string ippl::preconditioner< Field >::get_type ( )

inlineinherited

Definition at line 47 of file Preconditioner.h.

References type_m.

◆ init_fields()

template<typename Field>

virtual void ippl::preconditioner< Field >::init_fields ( Field & b )

inlinevirtualinherited

Reimplemented in ippl::gs_preconditioner< Field, LowerF, UpperF, InvDiagF >, ippl::richardson_preconditioner< Field, UpperAndLowerF, InvDiagF >, ippl::richardson_preconditioner_alt< Field, OperatorF, InvDiagF >, and ippl::ssor_preconditioner< Field, LowerF, UpperF, InvDiagF, DiagF >.

Definition at line 42 of file Preconditioner.h.

References ippl::Field< T, Dim, Mesh, Centering, ViewArgs >::deepCopy().

Here is the call graph for this function:

◆ operator()()

template<typename Field, typename OperatorF>

Field ippl::polynomial_newton_preconditioner< Field, OperatorF >::operator() ( Field & u )

inlineoverridevirtual

Reimplemented from ippl::preconditioner< Field >.

Definition at line 163 of file Preconditioner.h.

References level_m, and recursive_preconditioner().

Here is the call graph for this function:

◆ operator=()

template<typename Field, typename OperatorF>

polynomial_newton_preconditioner & ippl::polynomial_newton_preconditioner< Field, OperatorF >::operator= ( const polynomial_newton_preconditioner< Field, OperatorF > & other )