numericalexchangemodule Module Reference

Data Types
type	numericalexchangetype

Functions/Subroutines
subroutine	exg_df (this)
	Define the exchange. More...
subroutine	exg_ac (this, sparse)
	If an implicit exchange then add connections to sparse. More...
subroutine	exg_mc (this, matrix_sln)
	Map the connections in the global matrix. More...
subroutine	exg_ar (this)
	Allocate and read. More...
subroutine	exg_ad (this)
	Advance. More...
subroutine	exg_cf (this, kiter)
	Calculate conductance, and for explicit exchanges, set the conductance in the boundary package. More...
subroutine	exg_fc (this, kiter, matrix_sln, rhs_sln, inwtflag)
	Fill the matrix. More...
subroutine	exg_cc (this, icnvg)
	Additional convergence check. More...
subroutine	exg_cq (this, icnvg, isuppress_output, isolnid)
	Calculate flow. More...
subroutine	exg_bd (this, icnvg, isuppress_output, isolnid)
	Exchange budget. More...
subroutine	exg_ot (this)
	Output. More...
subroutine	exg_da (this)
	Deallocate memory. More...
integer(i4b) function	get_iasym (this)
class(numericalexchangetype) function, pointer	castasnumericalexchangeclass (obj)
subroutine, public	addnumericalexchangetolist (list, exchange)
	Add numerical exchange to a list. More...
class(numericalexchangetype) function, pointer, public	getnumericalexchangefromlist (list, idx)
	Retrieve a specific numerical exchange from a list. More...

Function/Subroutine Documentation

addnumericalexchangetolist()

subroutine, public numericalexchangemodule::addnumericalexchangetolist	(	type(listtype), intent(inout)	list,
		class(numericalexchangetype), intent(in), pointer	exchange
	)

Definition at line 219 of file NumericalExchange.f90.

    implicit none
    ! -- dummy
    type(ListType), intent(inout) :: list
    class(NumericalExchangeType), pointer, intent(in) :: exchange
    ! -- local
    class(*), pointer :: obj
    !
    obj => exchange
    call list%Add(obj)
    !
    ! -- Return
    return

Here is the caller graph for this function:

castasnumericalexchangeclass()

class(numericalexchangetype) function, pointer numericalexchangemodule::castasnumericalexchangeclass ( class(*), intent(inout), pointer  obj )

private

Definition at line 198 of file NumericalExchange.f90.

    implicit none
    ! -- dummy
    class(*), pointer, intent(inout) :: obj
    ! -- return
    class(NumericalExchangeType), pointer :: res
    !
    res => null()
    if (.not. associated(obj)) return
    !
    select type (obj)
    class is (numericalexchangetype)
      res => obj
    end select
    !
    ! -- Return
    return

Here is the caller graph for this function:

exg_ac()

subroutine numericalexchangemodule::exg_ac	(	class(numericalexchangetype)	this,
		type(sparsematrix), intent(inout)	sparse
	)

Definition at line 54 of file NumericalExchange.f90.

    ! -- modules
    use sparsemodule, only: sparsematrix
    ! -- dummy
    class(NumericalExchangeType) :: this
    type(sparsematrix), intent(inout) :: sparse
    !
    ! -- Return
    return

exg_ad()

subroutine numericalexchangemodule::exg_ad ( class(numericalexchangetype)  this )

private

Definition at line 89 of file NumericalExchange.f90.

    ! -- dummy
    class(NumericalExchangeType) :: this
    !
    ! -- Return
    return

exg_ar()

subroutine numericalexchangemodule::exg_ar

(

class(numericalexchangetype)

this

)

Definition at line 79 of file NumericalExchange.f90.

    !
    class(NumericalExchangeType) :: this
    !
    ! -- Return
    return

exg_bd()

subroutine numericalexchangemodule::exg_bd	(	class(numericalexchangetype)	this,
		integer(i4b), intent(inout)	icnvg,
		integer(i4b), intent(in)	isuppress_output,
		integer(i4b), intent(in)	isolnid
	)

Definition at line 151 of file NumericalExchange.f90.

    ! -- modules
    use constantsmodule, only: lenbudtxt
    ! -- dummy
    class(NumericalExchangeType) :: this
    integer(I4B), intent(inout) :: icnvg
    integer(I4B), intent(in) :: isuppress_output
    integer(I4B), intent(in) :: isolnid
    !
    ! -- Return
    return

exg_cc()

subroutine numericalexchangemodule::exg_cc ( class(numericalexchangetype)  this, integer(i4b), intent(inout)  icnvg  )

private

Definition at line 125 of file NumericalExchange.f90.

    ! -- dummy
    class(NumericalExchangeType) :: this
    integer(I4B), intent(inout) :: icnvg
    !
    ! -- Return
    return

exg_cf()

subroutine numericalexchangemodule::exg_cf ( class(numericalexchangetype)  this, integer(i4b), intent(in)  kiter  )

private

Definition at line 100 of file NumericalExchange.f90.

    ! -- dummy
    class(NumericalExchangeType) :: this
    integer(I4B), intent(in) :: kiter
    !
    ! -- Return
    return

exg_cq()

subroutine numericalexchangemodule::exg_cq ( class(numericalexchangetype)  this, integer(i4b), intent(inout)  icnvg, integer(i4b), intent(in)  isuppress_output, integer(i4b), intent(in)  isolnid  )

private

Definition at line 136 of file NumericalExchange.f90.

    ! -- modules
    use constantsmodule, only: lenbudtxt
    ! -- dummy
    class(NumericalExchangeType) :: this
    integer(I4B), intent(inout) :: icnvg
    integer(I4B), intent(in) :: isuppress_output
    integer(I4B), intent(in) :: isolnid
    !
    ! -- Return
    return

exg_da()

subroutine numericalexchangemodule::exg_da ( class(numericalexchangetype)  this )

private

Definition at line 176 of file NumericalExchange.f90.

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    ! -- dummy
    class(NumericalExchangeType) :: this
    !
    ! -- Return
    return

exg_df()

subroutine numericalexchangemodule::exg_df ( class(numericalexchangetype)  this )

private

Definition at line 41 of file NumericalExchange.f90.

    ! -- modules
    use basemodelmodule, only: basemodeltype
    use inputoutputmodule, only: getunit, openfile
    ! -- dummy
    class(NumericalExchangeType) :: this
    !
    ! -- Return
    return

Here is the call graph for this function:

exg_fc()

subroutine numericalexchangemodule::exg_fc ( class(numericalexchangetype)  this, integer(i4b), intent(in)  kiter, class(matrixbasetype), pointer  matrix_sln, real(dp), dimension(:), intent(inout)  rhs_sln, integer(i4b), intent(in), optional  inwtflag  )

private

Definition at line 111 of file NumericalExchange.f90.

    ! -- dummy
    class(NumericalExchangeType) :: this
    integer(I4B), intent(in) :: kiter
    class(MatrixBaseType), pointer :: matrix_sln
    real(DP), dimension(:), intent(inout) :: rhs_sln
    integer(I4B), optional, intent(in) :: inwtflag
    !
    ! -- Return
    return

exg_mc()

subroutine numericalexchangemodule::exg_mc	(	class(numericalexchangetype)	this,
		class(matrixbasetype), pointer	matrix_sln
	)

Definition at line 67 of file NumericalExchange.f90.

    ! -- module
    use sparsemodule, only: sparsematrix
    ! -- dummy
    class(NumericalExchangeType) :: this
    class(MatrixBaseType), pointer :: matrix_sln
    !
    ! -- Return

exg_ot()

subroutine numericalexchangemodule::exg_ot

(

class(numericalexchangetype)

this

)

Definition at line 166 of file NumericalExchange.f90.

    ! -- dummy
    class(NumericalExchangeType) :: this
    !
    ! -- Return
    return

get_iasym()

integer(i4b) function numericalexchangemodule::get_iasym

(

class(numericalexchangetype)

this

)

Definition at line 186 of file NumericalExchange.f90.

    ! -- dummy
    class(NumericalExchangeType) :: this
    ! -- return
    integer(I4B) :: iasym
    !
    iasym = 0
    !
    ! -- Return
    return

getnumericalexchangefromlist()

class(numericalexchangetype) function, pointer, public numericalexchangemodule::getnumericalexchangefromlist	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	idx
	)

Definition at line 236 of file NumericalExchange.f90.

    implicit none
    ! -- dummy
    type(ListType), intent(inout) :: list
    integer(I4B), intent(in) :: idx
    class(NumericalExchangeType), pointer :: res
    ! -- local
    class(*), pointer :: obj
    !
    obj => list%GetItem(idx)
    res => castasnumericalexchangeclass(obj)
    !
    ! -- Return
    return

Here is the call graph for this function:

Here is the caller graph for this function: