baseexchangemodule Module Reference

Data Types
type	baseexchangetype
interface	exg_df
interface	exg_ar

Functions/Subroutines
subroutine	exg_rp (this)
	Read and prepare.
subroutine	exg_dt (this)
	Calculate time step length.
subroutine	exg_ot (this)
	Run output routines.
subroutine	exg_fp (this)
	Final processing.
subroutine	exg_da (this)
	Deallocate memory.
subroutine	exg_ad (this)
	Advance.
logical(lgp) function	connects_model (this, model)
	Should return true when the exchange should be added to the solution where the model resides.
class(baseexchangetype) function, pointer, private	castasbaseexchangeclass (obj)
	Cast the object passed in as BaseExchangeType and return it.
subroutine, public	addbaseexchangetolist (list, exchange)
	Add the exchange object (BaseExchangeType) to a list.
class(baseexchangetype) function, pointer, public	getbaseexchangefromlist (list, idx)
	Retrieve a specific BaseExchangeType object from a list.

Function/Subroutine Documentation

addbaseexchangetolist()

subroutine, public baseexchangemodule::addbaseexchangetolist	(	type(listtype), intent(inout)	list,
		class(baseexchangetype), intent(inout), pointer	exchange )

Definition at line 109 of file BaseExchange.f90.

    ! dummy
    type(ListType), intent(inout) :: list
    class(BaseExchangeType), pointer, intent(inout) :: exchange
    ! local
    class(*), pointer :: obj
 
    obj => exchange
    call list%Add(obj)

Here is the caller graph for this function:

castasbaseexchangeclass()

class(baseexchangetype) function, pointer, private baseexchangemodule::castasbaseexchangeclass ( class(*), intent(inout), pointer obj )

private

Definition at line 93 of file BaseExchange.f90.

    ! dummy
    class(*), pointer, intent(inout) :: obj
    ! return
    class(BaseExchangeType), pointer :: res
 
    res => null()
    if (.not. associated(obj)) return
 
    select type (obj)
    class is (baseexchangetype)
      res => obj
    end select

Here is the caller graph for this function:

connects_model()

logical(lgp) function baseexchangemodule::connects_model ( class(baseexchangetype) this, class(basemodeltype), intent(in), pointer model )

private

Parameters

	this	the instance of the exchange
[in]	model	the model to which the exchange might hold a connection

Returns

true, when connected

Definition at line 83 of file BaseExchange.f90.

    ! dummy
    class(BaseExchangeType) :: this !< the instance of the exchange
    class(BaseModelType), pointer, intent(in) :: model !< the model to which the exchange might hold a connection
    ! return
    logical(LGP) :: is_connected !< true, when connected
    is_connected = .false.

exg_ad()

subroutine baseexchangemodule::exg_ad ( class(baseexchangetype) this )

private

Definition at line 76 of file BaseExchange.f90.

    class(BaseExchangeType) :: this

exg_da()

subroutine baseexchangemodule::exg_da ( class(baseexchangetype) this )

private

Definition at line 71 of file BaseExchange.f90.

    class(BaseExchangeType) :: this

exg_dt()

subroutine baseexchangemodule::exg_dt ( class(baseexchangetype) this )

private

Definition at line 56 of file BaseExchange.f90.

    class(BaseExchangeType) :: this

exg_fp()

subroutine baseexchangemodule::exg_fp ( class(baseexchangetype) this )

private

Definition at line 66 of file BaseExchange.f90.

    class(BaseExchangeType) :: this

exg_ot()

subroutine baseexchangemodule::exg_ot ( class(baseexchangetype) this )

private

Definition at line 61 of file BaseExchange.f90.

    class(BaseExchangeType) :: this

exg_rp()

subroutine baseexchangemodule::exg_rp ( class(baseexchangetype) this )

private

Definition at line 51 of file BaseExchange.f90.

    class(BaseExchangeType) :: this

getbaseexchangefromlist()

class(baseexchangetype) function, pointer, public baseexchangemodule::getbaseexchangefromlist	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	idx )

Definition at line 121 of file BaseExchange.f90.

    ! dummy
    type(ListType), intent(inout) :: list
    integer(I4B), intent(in) :: idx
    class(BaseExchangeType), pointer :: res
    ! local
    class(*), pointer :: obj
 
    obj => list%GetItem(idx)
    res => castasbaseexchangeclass(obj)

Here is the call graph for this function:

Here is the caller graph for this function: