PCTwoLevelsBlockDiagonal Class Reference

#include <PCTwoLevelsBlockDiagonal.hpp>

Collaboration diagram for PCTwoLevelsBlockDiagonal:

Classes
struct	PCTwoLevelsBlockDiagonalContext
Public Member Functions
	PCTwoLevelsBlockDiagonal (KSP &rKspObject, std::vector< PetscInt > &rBathNodes)
	~PCTwoLevelsBlockDiagonal ()
Public Attributes
PCTwoLevelsBlockDiagonalContext	mPCContext
PC	mPetscPCObject
Private Member Functions
void	PCTwoLevelsBlockDiagonalCreate (KSP &rKspObject, std::vector< PetscInt > &rBathNodes)
void	PCTwoLevelsBlockDiagonalSetUp ()

Detailed Description

Todo:: : #1082 update this description

This class defines a PETSc-compliant purpose-build preconditioner.

Let A be a matrix arising in the FEM discretisation of the bidomain equations with the following block structure:

A = (A11 B') (B A22)

By creating an instance of this class, one will define the following preconditioner:

inv(M) = inv( (A11 0) = (inv(A11) 0) (0 A22) ) (0 inv(A22))

The inverses are approximate with one cycle of AMG.

Note: This class requires PETSc to be build including HYPRE library. If it's not available, it will throw the following error:

[0]PETSC ERROR: --------------------- Error Message ------------------------------------ [0]PETSC ERROR: Unknown type. Check for miss-spelling or missing external package needed for type! [0]PETSC ERROR: Unable to find requested PC type hypre!

and will approximate the inverse of the subblocks with PETSc's default preconditioner (bjacobi at the time of writing this).

Definition at line 79 of file PCTwoLevelsBlockDiagonal.hpp.

Constructor & Destructor Documentation

PCTwoLevelsBlockDiagonal::PCTwoLevelsBlockDiagonal	(	KSP &	rKspObject,
		std::vector< PetscInt > &	rBathNodes
	)

Constructor.

Parameters:

	rKspObject	KSP object where we want to install the block diagonal preconditioner.
	rBathNodes	a list of nodes defining the bath

Definition at line 34 of file PCTwoLevelsBlockDiagonal.cpp.

References PCTwoLevelsBlockDiagonalCreate(), and PCTwoLevelsBlockDiagonalSetUp().

PCTwoLevelsBlockDiagonal::~PCTwoLevelsBlockDiagonal ( )

Destructor.

Definition at line 40 of file PCTwoLevelsBlockDiagonal.cpp.

Member Function Documentation

void PCTwoLevelsBlockDiagonal::PCTwoLevelsBlockDiagonalCreate	(	KSP &	rKspObject,
		std::vector< PetscInt > &	rBathNodes
	)			`[private]`

Creates all the state data required by the preconditioner.

Parameters:

	rKspObject	KSP object where we want to install the block diagonal preconditioner.
	rBathNodes	a list of nodes defining the bath

Todo:: : #1082 won't work in parallel

Todo:: : #1082 won't work in parallel

Todo:: : #1082 assert size(x1) = size(x21) + size(x22)

Todo:: : #1082 legacy, no need to use the references

Todo:: : #1082 OK in parallel. Use as an example for the other two blocks

Definition at line 64 of file PCTwoLevelsBlockDiagonal.cpp.

Referenced by PCTwoLevelsBlockDiagonal().

void PCTwoLevelsBlockDiagonal::PCTwoLevelsBlockDiagonalSetUp ( ) [private]

Setups preconditioner.

Definition at line 241 of file PCTwoLevelsBlockDiagonal.cpp.

References PCTwoLevelsBlockDiagonal::PCTwoLevelsBlockDiagonalContext::A11_matrix_subblock, PCTwoLevelsBlockDiagonal::PCTwoLevelsBlockDiagonalContext::A22_B1_matrix_subblock, PCTwoLevelsBlockDiagonal::PCTwoLevelsBlockDiagonalContext::A22_B2_matrix_subblock, mPCContext, PCTwoLevelsBlockDiagonal::PCTwoLevelsBlockDiagonalContext::PC_amg_A11, PCTwoLevelsBlockDiagonal::PCTwoLevelsBlockDiagonalContext::PC_amg_A22_B1, and PCTwoLevelsBlockDiagonal::PCTwoLevelsBlockDiagonalContext::PC_amg_A22_B2.

Referenced by PCTwoLevelsBlockDiagonal().

Member Data Documentation

PCTwoLevelsBlockDiagonalContext PCTwoLevelsBlockDiagonal::mPCContext

PC context, this will be passed to PCTwoLevelsBlockDiagonalApply when PETSc returns control to our preconditioner subroutine. See PCShellSetContext().

Definition at line 105 of file PCTwoLevelsBlockDiagonal.hpp.

Referenced by PCTwoLevelsBlockDiagonalCreate(), PCTwoLevelsBlockDiagonalSetUp(), and ~PCTwoLevelsBlockDiagonal().

PC PCTwoLevelsBlockDiagonal::mPetscPCObject

Generic PETSc preconditioner object

Definition at line 106 of file PCTwoLevelsBlockDiagonal.hpp.

Referenced by PCTwoLevelsBlockDiagonalCreate().

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

linalg/src/PCTwoLevelsBlockDiagonal.hpp
linalg/src/PCTwoLevelsBlockDiagonal.cpp

PCTwoLevelsBlockDiagonal Class Reference

Classes

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation