cachedgradientmodule Module Reference

Data Types
interface	cachedgradienttype
	Decorator that adds caching to any gradient computation implementation. More...

Functions/Subroutines
type(cachedgradienttype) function	constructor (gradient, dis)
subroutine	destructor (this)
real(dp) function, dimension(3)	get (this, n)
subroutine	set_field (this, phi)

Function/Subroutine Documentation

constructor()

type(cachedgradienttype) function cachedgradientmodule::constructor ( class(igradienttype), intent(inout), allocatable  gradient, class(disbasetype), intent(in), pointer  dis  )

private

Definition at line 50 of file CachedGradient.f90.

    ! --dummy
    class(IGradientType), allocatable, intent(inout) :: gradient
    class(DisBaseType), pointer, intent(in) :: dis
    !-- return
    type(CachedGradientType) :: cached_gradient
 
    cached_gradient%dis => dis
 
    call move_alloc(gradient, cached_gradient%gradient) ! Take ownership
    allocate (cached_gradient%cached_gradients(dis%nodes, 3))
 

Here is the caller graph for this function:

destructor()

subroutine cachedgradientmodule::destructor ( type(cachedgradienttype), intent(inout)  this )

private

Definition at line 64 of file CachedGradient.f90.

    ! -- dummy
    type(CachedGradientType), intent(inout) :: this
 
    deallocate (this%cached_gradients)

Here is the caller graph for this function:

get()

real(dp) function, dimension(3) cachedgradientmodule::get ( class(cachedgradienttype), target  this, integer(i4b), intent(in)  n  )

private

Definition at line 71 of file CachedGradient.f90.

    ! -- dummy
    class(CachedGradientType), target :: this
    integer(I4B), intent(in) :: n
    !-- return
    real(DP), dimension(3) :: grad_c
 
    grad_c = this%cached_gradients(n, :)

set_field()

subroutine cachedgradientmodule::set_field ( class(cachedgradienttype), target  this, real(dp), dimension(:), intent(in), pointer  phi  )

private

Definition at line 81 of file CachedGradient.f90.

    ! -- dummy
    class(CachedGradientType), target :: this
    real(DP), dimension(:), pointer, intent(in) :: phi
    ! -- local
    integer(I4B) :: n
 
    call this%gradient%set_field(phi)
    do n = 1, this%dis%nodes
      this%cached_gradients(n, :) = this%gradient%get(n)
    end do