xgc_solver_module Module Reference

This module defines the data structure and global variables needed for the Poisson solvers (or generally PETSc ksp-solvers) More...

Data Types
type	xgc_solver

Functions/Subroutines
subroutine	delete_solver (this, ierr)
	Destroys all PETSc objects created for a solver object and deallocates all memory. More...
subroutine	myvecdestroy (vec, ierr)
	Checks if a PETSc vector is non-NULL and destroys it if necessary. More...
subroutine	mymatdestroy (amat, ierr)
	Checks if a PETSc matrix is non-NULL and destroys it if necessary. More...
subroutine	myvecscatterdestroy (vscat, ierr)
	Checks if a PETSc VecScatter is non-NULL and destroys it if necessary. More...

Detailed Description

This module defines the data structure and global variables needed for the Poisson solvers (or generally PETSc ksp-solvers)

Function/Subroutine Documentation

delete_solver()

subroutine xgc_solver_module::delete_solver	(	type(xgc_solver)	this,
			ierr
	)

Destroys all PETSc objects created for a solver object and deallocates all memory.

Parameters

[in,out]	this	XGC solver object, type(xgc_solver)
[in,out]	ierr	PETSc error code

Here is the call graph for this function:

mymatdestroy()

subroutine xgc_solver_module::mymatdestroy	(		amat,
			ierr
	)

Checks if a PETSc matrix is non-NULL and destroys it if necessary.

Parameters

[in,out]	amat	PETSc matrix
[in,out]	ierr	PETSc error code

Here is the caller graph for this function:

myvecdestroy()

subroutine xgc_solver_module::myvecdestroy	(		vec,
			ierr
	)

Checks if a PETSc vector is non-NULL and destroys it if necessary.

Parameters

[in,out]	vec	PETSc vector
[in,out]	ierr	PETSc error code

Here is the caller graph for this function:

myvecscatterdestroy()

subroutine xgc_solver_module::myvecscatterdestroy	(		vscat,
			ierr
	)

Checks if a PETSc VecScatter is non-NULL and destroys it if necessary.

Parameters

[in,out]	vscat	PETSc VecScatter
[in,out]	ierr	PETSc error code

Here is the caller graph for this function: