baseexchangemodule Module Reference

Data Types
type	baseexchangetype
interface	exg_df
interface	exg_ar

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

Function/Subroutine Documentation

addbaseexchangetolist()

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

Definition at line 145 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)
    !
    ! -- Return
    return

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 125 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
    !
    ! -- Return
    return

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 110 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.
    !
    ! -- Return
    return

exg_calculate_delt()

subroutine baseexchangemodule::exg_calculate_delt

(

class(baseexchangetype)

this

)

Definition at line 67 of file BaseExchange.f90.

    ! -- dummy
    class(BaseExchangeType) :: this
    !
    ! -- Nothing to do for TU
    !
    ! -- Return
    return

exg_da()

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

private

Definition at line 99 of file BaseExchange.f90.

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

exg_fp()

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

private

Definition at line 89 of file BaseExchange.f90.

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

exg_ot()

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

private

Definition at line 79 of file BaseExchange.f90.

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

exg_rp()

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

private

Definition at line 50 of file BaseExchange.f90.

    ! -- modules
    use tdismodule, only: readnewdata
    ! -- dummy
    class(BaseExchangeType) :: this
    !
    ! -- Check with TDIS on whether or not it is time to RP
    if (.not. readnewdata) return
    !
    ! -- Nothing to do for RP
    !
    ! -- Return
    return

getbaseexchangefromlist()

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

Definition at line 161 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)
    !
    ! -- Return
    return

Here is the call graph for this function:

Here is the caller graph for this function: