XGC1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Data Types | Public Member Functions | List of all members
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
 

Public Member Functions

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)

Member Function/Subroutine Documentation

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]thisXGC solver object, type(xgc_solver)
[in,out]ierrPETSc error code

Here is the call graph for this function:

Here is the caller graph for this function:

subroutine xgc_solver_module::mymatdestroy (   amat,
  ierr 
)

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

Parameters
[in,out]amatPETSc matrix
[in,out]ierrPETSc error code

Here is the caller graph for this function:

subroutine xgc_solver_module::myvecdestroy (   vec,
  ierr 
)

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

Parameters
[in,out]vecPETSc vector
[in,out]ierrPETSc error code

Here is the caller graph for this function:

subroutine xgc_solver_module::myvecscatterdestroy (   vscat,
  ierr 
)

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

Parameters
[in,out]vscatPETSc VecScatter
[in,out]ierrPETSc error code

Here is the caller graph for this function:


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