#include <JacobiPC.H>

Inheritance diagram for JacobiPC< T, Ops >:

Public Types
using	RT = typename T::value_type

Public Types inherited from Preconditioner< T, Ops >
using	RT = typename T::value_type

Public Member Functions
	JacobiPC ()=default
	Default constructor.

	~JacobiPC () override=default
	Default destructor.

	JacobiPC (const JacobiPC &)=delete

JacobiPC &	operator= (const JacobiPC &)=delete

	JacobiPC (JacobiPC &&) noexcept=delete

JacobiPC &	operator= (JacobiPC &&) noexcept=delete

void	Define (const T &, Ops *const) override
	Define the preconditioner.

void	Update (const T &a_U) override
	Update the preconditioner.

void	Apply (T &, const T &) override
	Apply (solve) the preconditioner given a RHS.

void	printParameters () const override
	Print parameters.

bool	IsDefined () const override
	Check if the nonlinear solver has been defined.

Public Member Functions inherited from Preconditioner< T, Ops >
	Preconditioner ()=default
	Default constructor.

virtual	~Preconditioner ()=default
	Default destructor.

	Preconditioner (const Preconditioner &)=default

Preconditioner &	operator= (const Preconditioner &)=default

	Preconditioner (Preconditioner &&) noexcept=default

Preconditioner &	operator= (Preconditioner &&) noexcept=default

virtual void	getPCMatrix (amrex::Gpu::DeviceVector< int > &, amrex::Gpu::DeviceVector< int > &, amrex::Gpu::DeviceVector< int > &, amrex::Gpu::DeviceVector< RT > &, int &, int &)
	Get the sparse matrix form of the preconditioner.

virtual void	setName (const std::string &)
	Set the name for screen output and parsing inputs.

void	CurTime (const RT a_time)
	Set the current time.

void	CurTimeStep (const RT a_dt)
	Set the current time step size.

Protected Types
using	MFArr = amrex::Array<amrex::MultiFab,3>

Protected Member Functions
void	readParameters ()
	Read parameters.

Protected Attributes
bool	m_is_defined = false

bool	m_verbose = true

int	m_max_iter = 10

RT	m_atol = 1.0e-16

RT	m_rtol = 1.0e-4

Ops *	m_ops = nullptr

int	m_num_amr_levels = 0

amrex::Vector< amrex::Geometry >	m_geom

amrex::Vector< amrex::BoxArray >	m_grids

amrex::Vector< amrex::DistributionMapping >	m_dmap

amrex::IntVect	m_gv

const amrex::Vector< amrex::Array< amrex::MultiFab , 3 > >	m_bcoefs = nullptr

Protected Attributes inherited from Preconditioner< T, Ops >
RT	m_time = 0.0

RT	m_dt = 0.0

Detailed Description

template<class T, class Ops>
class JacobiPC< T, Ops >

Point-Jacobi Preconditioner.

Solve a given system using the Point-Jaocbi method

The equation solves for Eg in: A * Eg = b where

A is an operator
Eg is the electric field.
b is a specified RHS with the same layout as Eg

This class is templated on a solution-type class T and an operator class Ops.

The Ops class must have the following function:

Return number of AMR levels
Return the amrex::Geometry object given an AMR level
Return hi and lo linear operator boundaries
Return the time step factor (theta) for the time integration scheme

The T class must have the following functions:

Return underlying vector of amrex::MultiFab arrays

Member Typedef Documentation

◆ MFArr

template<class T, class Ops>

using JacobiPC< T, Ops >::MFArr = amrex::Array<amrex::MultiFab,3>

protected

◆ RT

template<class T, class Ops>

using JacobiPC< T, Ops >::RT = typename T::value_type

Constructor & Destructor Documentation

◆ JacobiPC() [1/3]

template<class T, class Ops>

JacobiPC< T, Ops >::JacobiPC ( )

default

Default constructor.

◆ ~JacobiPC()

template<class T, class Ops>

JacobiPC< T, Ops >::~JacobiPC ( )

overridedefault

Default destructor.

◆ JacobiPC() [2/3]

template<class T, class Ops>

JacobiPC< T, Ops >::JacobiPC ( const JacobiPC< T, Ops > & )

delete

◆ JacobiPC() [3/3]

template<class T, class Ops>

JacobiPC< T, Ops >::JacobiPC ( JacobiPC< T, Ops > && )

deletenoexcept

Member Function Documentation

◆ Apply()

template<class T, class Ops>

void JacobiPC< T, Ops >::Apply	(	T &	a_x,
		const T &	a_b )

overridevirtual

Apply (solve) the preconditioner given a RHS.

Given a right-hand-side b, solve: A x = b where A is the linear operator.

Implements Preconditioner< T, Ops >.

◆ Define()

template<class T, class Ops>

void JacobiPC< T, Ops >::Define	(	const T &	a_U,
		Ops * const	a_ops )

overridevirtual

Define the preconditioner.

Implements Preconditioner< T, Ops >.

◆ IsDefined()

template<class T, class Ops>

bool JacobiPC< T, Ops >::IsDefined ( ) const

inlinenodiscardoverridevirtual

Check if the nonlinear solver has been defined.

Implements Preconditioner< T, Ops >.

◆ operator=() [1/2]

template<class T, class Ops>

JacobiPC & JacobiPC< T, Ops >::operator= ( const JacobiPC< T, Ops > & )

delete

◆ operator=() [2/2]

template<class T, class Ops>

JacobiPC & JacobiPC< T, Ops >::operator= ( JacobiPC< T, Ops > && )

deletenoexcept

◆ printParameters()

template<class T, class Ops>

void JacobiPC< T, Ops >::printParameters ( ) const

overridevirtual

Print parameters.

Reimplemented from Preconditioner< T, Ops >.

◆ readParameters()

template<class T, class Ops>

void JacobiPC< T, Ops >::readParameters ( )

protected

Read parameters.

◆ Update()

template<class T, class Ops>

void JacobiPC< T, Ops >::Update ( const T & a_U )

overridevirtual

Update the preconditioner.

Implements Preconditioner< T, Ops >.

Member Data Documentation

◆ m_atol

template<class T, class Ops>

RT JacobiPC< T, Ops >::m_atol = 1.0e-16

protected

◆ m_bcoefs

template<class T, class Ops>

const amrex::Vector<amrex::Array<amrex::MultiFab*,3> >* JacobiPC< T, Ops >::m_bcoefs = nullptr

protected

◆ m_dmap

template<class T, class Ops>

amrex::Vector<amrex::DistributionMapping> JacobiPC< T, Ops >::m_dmap

protected

◆ m_geom

template<class T, class Ops>

amrex::Vector<amrex::Geometry> JacobiPC< T, Ops >::m_geom

protected

◆ m_grids

template<class T, class Ops>

amrex::Vector<amrex::BoxArray> JacobiPC< T, Ops >::m_grids

protected

◆ m_gv

template<class T, class Ops>

amrex::IntVect JacobiPC< T, Ops >::m_gv

protected

◆ m_is_defined

template<class T, class Ops>

bool JacobiPC< T, Ops >::m_is_defined = false

protected

◆ m_max_iter

template<class T, class Ops>

int JacobiPC< T, Ops >::m_max_iter = 10

protected

◆ m_num_amr_levels

template<class T, class Ops>

int JacobiPC< T, Ops >::m_num_amr_levels = 0

protected

◆ m_ops

template<class T, class Ops>

Ops* JacobiPC< T, Ops >::m_ops = nullptr

protected

◆ m_rtol

template<class T, class Ops>

RT JacobiPC< T, Ops >::m_rtol = 1.0e-4

protected

◆ m_verbose

template<class T, class Ops>

bool JacobiPC< T, Ops >::m_verbose = true

protected

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

/home/docs/checkouts/readthedocs.org/user_builds/warpx/checkouts/6102/Source/NonlinearSolvers/JacobiPC.H

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ MFArr

◆ RT

Constructor & Destructor Documentation

◆ JacobiPC() [1/3]

◆ ~JacobiPC()

◆ JacobiPC() [2/3]

◆ JacobiPC() [3/3]

Member Function Documentation

◆ Apply()

◆ Define()

◆ IsDefined()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ printParameters()

◆ readParameters()

◆ Update()

Member Data Documentation

◆ m_atol

◆ m_bcoefs

◆ m_dmap

◆ m_geom

◆ m_grids

◆ m_gv

◆ m_is_defined

◆ m_max_iter

◆ m_num_amr_levels

◆ m_ops

◆ m_rtol

◆ m_verbose