solutiongroupmodule Module Reference

Data Types
type	solutiongrouptype

Functions/Subroutines
subroutine, public	solutiongroup_create (sgp, id)
subroutine	sgp_ca (this)
subroutine	sgp_da (this)
subroutine	allocate_scalars (this)
subroutine	add_solution (this, isoln, sp)
class(solutiongrouptype) function, pointer, private	castassolutiongroupclass (obj)
subroutine, public	addsolutiongrouptolist (list, solutiongroup)
class(solutiongrouptype) function, pointer, public	getsolutiongroupfromlist (list, idx)

Function/Subroutine Documentation

add_solution()

subroutine solutiongroupmodule::add_solution ( class(solutiongrouptype)  this, integer(i4b), intent(in)  isoln, class(basesolutiontype), intent(in), pointer  sp  )

private

Definition at line 160 of file SolutionGroup.f90.

! ******************************************************************************
! add_solution
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    ! -- modules
    use arrayhandlersmodule, only: expandarray
    ! -- dummy
    class(SolutionGroupType) :: this
    integer(I4B), intent(in) :: isoln
    class(BaseSolutionType), pointer, intent(in) :: sp
    ! -- local
    integer(I4B) :: ipos
! ------------------------------------------------------------------------------
    !
    call expandarray(this%idsolutions)
    ipos = size(this%idsolutions)
    this%idsolutions(ipos) = isoln
    this%nsolutions = this%nsolutions + 1
    !
    ! -- return
    return

addsolutiongrouptolist()

subroutine, public solutiongroupmodule::addsolutiongrouptolist	(	type(listtype), intent(inout)	list,
		type(solutiongrouptype), intent(inout), pointer	solutiongroup
	)

Definition at line 201 of file SolutionGroup.f90.

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

allocate_scalars()

subroutine solutiongroupmodule::allocate_scalars ( class(solutiongrouptype)  this )

private

Definition at line 139 of file SolutionGroup.f90.

! ******************************************************************************
! allocate_scalars
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    class(SolutionGroupType) :: this
! ------------------------------------------------------------------------------
    !
    allocate (this%id)
    allocate (this%mxiter)
    allocate (this%nsolutions)
    this%id = 0
    this%mxiter = 1
    this%nsolutions = 0
    !
    ! -- return
    return

castassolutiongroupclass()

class(solutiongrouptype) function, pointer, private solutiongroupmodule::castassolutiongroupclass ( class(*), intent(inout), pointer  obj )

private

Definition at line 186 of file SolutionGroup.f90.

    implicit none
    class(*), pointer, intent(inout) :: obj
    class(SolutionGroupType), pointer :: res
    !
    res => null()
    if (.not. associated(obj)) return
    !
    select type (obj)
    class is (solutiongrouptype)
      res => obj
    end select
    return

Here is the caller graph for this function:

getsolutiongroupfromlist()

class(solutiongrouptype) function, pointer, public solutiongroupmodule::getsolutiongroupfromlist	(	type(listtype), intent(inout)	list,
		integer(i4b), intent(in)	idx
	)

Definition at line 215 of file SolutionGroup.f90.

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

Here is the call graph for this function:

Here is the caller graph for this function:

sgp_ca()

subroutine solutiongroupmodule::sgp_ca ( class(solutiongrouptype)  this )

private

Definition at line 47 of file SolutionGroup.f90.

! ******************************************************************************
! sgp_ca -- Calculate the solution group
!    Solve each solution group and each solution.  Start with converge
!    flag equal true and reset to zero if any non-convergence triggers
!    are encountered.
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    ! -- modules
    use constantsmodule, only: linelength
    use simvariablesmodule, only: iout, isimcnvg, laststepfailed
    use tdismodule, only: kstp, kper
    ! -- dummy
    class(SolutionGroupType) :: this
    ! -- local
    class(BaseSolutionType), pointer :: sp
    integer(I4B) :: kpicard, isgcnvg, isuppress_output
    integer(I4B) :: is, isoln
    ! -- formats
    character(len=*), parameter :: fmtnocnvg = &
      "(1X,'Solution Group ', i0, ' did not converge for stress period ', i0, &
       &' and time step ', i0)"
! ------------------------------------------------------------------------------
    !
    ! -- Suppress output during picard iterations
    if (this%mxiter > 1) then
      isuppress_output = 1
    else
      isuppress_output = 0
    end if
    !
    ! -- set failed flag
    laststepfailed = 0
    !
    ! -- Picard loop
    picardloop: do kpicard = 1, this%mxiter
      if (this%mxiter > 1) then
        write (iout, '(/a,i6/)') 'SOLUTION GROUP PICARD ITERATION: ', kpicard
      end if
      isgcnvg = 1
      do is = 1, this%nsolutions
        isoln = this%idsolutions(is)
        sp => getbasesolutionfromlist(basesolutionlist, isoln)
        call sp%sln_ca(isgcnvg, isuppress_output)
      end do
      if (isgcnvg == 1) exit picardloop
    end do picardloop
    !
    ! -- if a picard loop was used and the solution group converged
    !    then rerun the timestep and save the output.  Or if there
    !    is only one picard iteration, then do nothing as models
    !    are assumed to be explicitly coupled.
    if (isgcnvg == 1) then
      if (this%mxiter > 1) then
        isuppress_output = 0
        do is = 1, this%nsolutions
          isoln = this%idsolutions(is)
          sp => getbasesolutionfromlist(basesolutionlist, isoln)
          call sp%sln_ca(isgcnvg, isuppress_output)
        end do
      end if
    else
      isimcnvg = 0
      laststepfailed = 1
      write (iout, fmtnocnvg) this%id, kper, kstp
    end if
    !
    ! -- return
    return

Here is the call graph for this function:

sgp_da()

subroutine solutiongroupmodule::sgp_da

(

class(solutiongrouptype)

this

)

Definition at line 120 of file SolutionGroup.f90.

! ******************************************************************************
! deallocate
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    class(SolutionGroupType) :: this
! ------------------------------------------------------------------------------
    !
    deallocate (this%id)
    deallocate (this%mxiter)
    deallocate (this%nsolutions)
    deallocate (this%idsolutions)
    !
    ! -- return
    return

solutiongroup_create()

subroutine, public solutiongroupmodule::solutiongroup_create	(	type(solutiongrouptype), pointer	sgp,
		integer(i4b), intent(in)	id
	)

Definition at line 28 of file SolutionGroup.f90.

! ******************************************************************************
! solutiongroup_create -- Create a new solution group
! ******************************************************************************
!
!    SPECIFICATIONS:
! ------------------------------------------------------------------------------
    type(SolutionGroupType), pointer :: sgp
    integer(I4B), intent(in) :: id
! ------------------------------------------------------------------------------
    !
    allocate (sgp)
    call sgp%allocate_scalars()
    sgp%id = id
    !
    ! -- return
    return

Here is the caller graph for this function: