#include <PetscSolver.H>

Inheritance diagram for PetscSolver< T >:

[legend]

Public Member Functions
	PetscSolver ()

virtual	~PetscSolver ()

void	destroy ()

virtual void	setHomogeneous (bool a_homogeneous)

virtual void	setFunctionAndJacobian (PetscErrorCode(f)(SNES, Vec, Vec, void ), PetscErrorCode(j)(SNES, Vec, Mat , Mat , MatStructure , void *))

virtual void	define (Real a_dx, bool a_homogeneous=true)

virtual void	define (LinearOp< T > *, bool a_homogeneous=true)

virtual void	solve (T &a_phi, const T &a_rhs)

int	solve_private (T &a_phi, const T &a_rhs)

virtual void	solve_mfree (T &a_phi, const T &a_rhs, LinearOp< T > *a_op)

int	solve_mfree_private (T &a_phi, const T &a_rhs, LinearOp< T > *a_op)

Real	computeResidual ()

virtual int	applyOp (T &a_phi, const T &a_rhs)

void	setInitialGuessNonzero (bool b=true)

void	setOptionsPrefix (const char prefix[])

KSP	getKSP ()

virtual int	getNNZPerRow () const

virtual bool	supportNNZExact () const

virtual void	rhsOperation (const T &a_rhs)

virtual Real	addBCdiagValue (const IntVect &a_iv, const IntVect &a_jv, const T &a_rhs, const DataIndex &a_datInd, const Real coeff=1)

int	resetOperator ()

Real	normInfinity (const T &a_phi) const

int	setup_solver (const T &a_phi)

int	create_mat_vec (const T &a_phi)

PetscErrorCode	putPetscInChombo (T &a_phi, const Vec xx)

PetscErrorCode	putChomboInPetsc (Vec out, const T &a_phi)

virtual int	formMatrix (Mat, const T =0, PetscInt my0=0, PetscInt nloc=0, PetscInt d=0, PetscInt *o=0)=0

virtual BaseFab< Real > &	getRegFab (T &a_fab, const DataIndex &a_datInd)=0

virtual const BaseFab< Real > &	getRegFab (const T &a_fab, const DataIndex &a_datInd) const =0

virtual const BaseFab< Real > &	getRegFab (const T &a_fab, const DataIndex &a_datInd, Box &a_box) const =0

void	setNull (bool n=true)

Public Member Functions inherited from LinearSolver< T >
virtual	~LinearSolver ()

virtual void	setConvergenceMetrics (Real a_metric, Real a_tolerance)
	Set a convergence metric, along with solver tolerance, if desired. More...

Static Public Member Functions
static PetscErrorCode	ksp_monitor_pout (KSP ksp, PetscInt it, PetscReal rnorm, void *ctx)

static PetscErrorCode	apply_mfree (Mat A, Vec x, Vec f)

Public Attributes
LinearOp< T > *	m_op_mfree

T	m_phi_mfree

T	m_Lphi_mfree

bool	m_mfree_homogeneous

bool	m_homogeneous

Real	m_dx

Mat	m_mat

void *	m_ctx

Vec	m_xx

Vec	m_rr

Vec	m_bb

SNES	m_snes

KSP	m_ksp

LevelData< BaseFab< PetscInt > >	m_gids

PetscInt	m_gid0

Protected Member Functions
virtual Real	addBCrhsValue (const IntVect &a_iv, const T &a_phi, const DataIndex &a_datInd, const Real &coeff=1)

Protected Attributes
PetscInt	m_defined

PetscErrorCode(*	m_function )(SNES, Vec, Vec, void *)

PetscErrorCode(*	m_jacobian )(SNES, Vec, Mat , Mat , MatStructure , void )

char	m_prestring [32]

bool	m_null

bool	m_nz_init_guess

LevelData< BaseFab< bool > >	m_bccode

Detailed Description

template<class T>
class PetscSolver< T >

Interface to PETSC linear solvers BC implementation hooks: addBCdiagValue (formMatrix) and addBCrhsValue (solveprivate) m_bccode should be encoded true for cells that are at the domain boundaries at formMatrix time.

Constructor & Destructor Documentation

◆ PetscSolver()

template<class T >

PetscSolver< T >::PetscSolver ( )

◆ ~PetscSolver()

template<class T >

PetscSolver< T >::~PetscSolver ( )

virtual

Member Function Documentation

◆ destroy()

template<class T >

void PetscSolver< T >::destroy ( )

Referenced by PetscSolver< LevelData< FArrayBox > >::~PetscSolver().

◆ setHomogeneous()

template<class T>

virtual void PetscSolver< T >::setHomogeneous ( bool a_homogeneous )

inlinevirtual

Set whether the solver uses only homogeneous boundary conditions

Implements LinearSolver< T >.

◆ setFunctionAndJacobian()

template<class T>

virtual void PetscSolver< T >::setFunctionAndJacobian	(	PetscErrorCode()(SNES, Vec, Vec, void )	f,
		PetscErrorCode()(SNES, Vec, Mat , Mat , MatStructure , void *)	j
	)

inlinevirtual

Set Function F(u) = 0 and Jacobian dF(u)/du for nonlinear solves

◆ ksp_monitor_pout()

template<class T>

static PetscErrorCode PetscSolver< T >::ksp_monitor_pout	(	KSP	ksp,
		PetscInt	it,
		PetscReal	rnorm,
		void *	ctx
	)

inlinestatic

Referenced by PetscSolver< LevelData< FArrayBox > >::setup_solver(), and PetscSolver< LevelData< FArrayBox > >::solve_mfree_private().

◆ define() [1/2]

template<class T >

void PetscSolver< T >::define	(	Real	a_dx,
		bool	a_homogeneous = `true`
	)

virtual

Reimplemented in PetscSolverPoisson< T >.

Referenced by PetscSolver< LevelData< FArrayBox > >::define(), PetscSolverPoisson< T >::define(), and PetscSolver< LevelData< FArrayBox > >::ksp_monitor_pout().

◆ define() [2/2]

template<class T>

void PetscSolver< T >::define	(	LinearOp< T > *	a_operator,
		bool	a_homogeneous = `true`
	)

virtual

Define the operator and whether it is a homogeneous solver or not. The LinearSolver does not take over ownership of this a_operator object. It does not call delete on it when the LinearSolver is deleted. It is meant to be like a late-binding reference. If you created a_operator with new, you should call delete on it after LinearSolver is deleted if you want to avoid memory leaks.

Implements LinearSolver< T >.

Reimplemented in PetscSolverPoisson< T >.

◆ solve()

template<class T>

void PetscSolver< T >::solve	(	T &	a_phi,
		const T &	a_rhs
	)

virtual

Solve

Implements LinearSolver< T >.

Referenced by PetscSolver< LevelData< FArrayBox > >::ksp_monitor_pout().

◆ solve_private()

template<class T>

int PetscSolver< T >::solve_private	(	T &	a_phi,
		const T &	a_rhs
	)

Referenced by PetscSolver< LevelData< FArrayBox > >::ksp_monitor_pout(), and PetscSolver< LevelData< FArrayBox > >::solve().

◆ solve_mfree()

template<class T>

void PetscSolver< T >::solve_mfree	(	T &	a_phi,
		const T &	a_rhs,
		LinearOp< T > *	a_op
	)

virtual

Solve a_op*a_phi = a_rhs using the PETSC matrix free functions The preconditioner (for which a matrix is formed) need not be the same as the actual operator.

Referenced by PetscSolver< LevelData< FArrayBox > >::ksp_monitor_pout().

◆ solve_mfree_private()

template<class T>

int PetscSolver< T >::solve_mfree_private	(	T &	a_phi,
		const T &	a_rhs,
		LinearOp< T > *	a_op
	)

Referenced by PetscSolver< LevelData< FArrayBox > >::ksp_monitor_pout(), and PetscSolver< LevelData< FArrayBox > >::solve_mfree().

◆ apply_mfree()

template<class T >

PetscErrorCode PetscSolver< T >::apply_mfree	(	Mat	A,
		Vec	x,
		Vec	f
	)

static

Referenced by PetscSolver< LevelData< FArrayBox > >::solve_mfree_private().

◆ computeResidual()

template<class T >

Real PetscSolver< T >::computeResidual ( )

viewResidual

◆ applyOp()

template<class T>

int PetscSolver< T >::applyOp	(	T &	a_phi,
		const T &	a_rhs
	)

virtual

apply

◆ setInitialGuessNonzero()

template<class T>

void PetscSolver< T >::setInitialGuessNonzero ( bool b = true )

inline

set initial guess non-zero

◆ setOptionsPrefix()

template<class T>

void PetscSolver< T >::setOptionsPrefix ( const char prefix[] )

inline

set initial guess non-zero

◆ getKSP()

template<class T>

KSP PetscSolver< T >::getKSP ( )

inline

◆ getNNZPerRow()

template<class T>

virtual int PetscSolver< T >::getNNZPerRow ( ) const

inlinevirtual

get an estimate of the number of nnz/row for matrix allocation

Reimplemented in PetscSolverViscousTensor< T >.

Referenced by PetscSolver< LevelData< FArrayBox > >::create_mat_vec().

◆ supportNNZExact()

template<class T>

virtual bool PetscSolver< T >::supportNNZExact ( ) const

inlinevirtual

do I support having formMatrix precompute exact NNZ/row

Referenced by PetscSolver< LevelData< FArrayBox > >::create_mat_vec().

◆ rhsOperation()

template<class T>

virtual void PetscSolver< T >::rhsOperation ( const T & a_rhs )

inlinevirtual

◆ addBCdiagValue()

template<class T>

virtual Real PetscSolver< T >::addBCdiagValue	(	const IntVect &	a_iv,
		const IntVect &	a_jv,
		const T &	a_rhs,
		const DataIndex &	a_datInd,
		const Real	coeff = `1`
	)

inlinevirtual

handling boundary conditions, turn it into a term to be added to the diag term this function coordinates with addBCrhsValue for Dirichlet BC for Neumann BC no RHS modification is required

◆ resetOperator()

template<class T>

int PetscSolver< T >::resetOperator ( )

inline

◆ normInfinity()

template<class T>

Real PetscSolver< T >::normInfinity ( const T & a_phi ) const

Infinity norm

Referenced by PetscSolver< LevelData< FArrayBox > >::resetOperator().

◆ addBCrhsValue()

template<class T>

virtual Real PetscSolver< T >::addBCrhsValue	(	const IntVect &	a_iv,
		const T &	a_phi,
		const DataIndex &	a_datInd,
		const Real &	coeff = `1`
	)

inlineprotectedvirtual

handling boundary conditions, turn it into a term to be added to the RHS this function coordinates with addBCdiagValue for Dirichlet BC, should return a term that is to be added to RHS

Referenced by PetscSolver< LevelData< FArrayBox > >::putChomboInPetsc(), PetscSolver< LevelData< FArrayBox > >::solve_mfree_private(), and PetscSolver< LevelData< FArrayBox > >::solve_private().