explicitsolutionmodule Module Reference

Explicit solutions for solving explicit models. More...

Data Types
type	explicitsolutiontype
	Manages and solves explicit models. More...

Functions/Subroutines
subroutine, public	create_explicit_solution (exp_sol, filename, id)
	Create a new solution. More...
subroutine	allocate_scalars (this)
	Allocate scalars. More...
subroutine	sln_df (this)
	Define the solution. More...
subroutine	sln_ar (this)
	Allocate and read. More...
subroutine	sln_dt (this)
	Calculate time step length. More...
subroutine	sln_ad (this)
	Advance the solution. More...
subroutine	sln_ot (this)
	Output. More...
subroutine	sln_fp (this)
subroutine	sln_da (this)
	Deallocate. More...
subroutine	sln_ca (this, isgcnvg, isuppress_output)
	Calculate. More...
subroutine	preparesolve (this)
	Prepare to solve. More...
subroutine	solve (this, kiter)
	Solve models. More...
subroutine	finalizesolve (this, kiter, isgcnvg, isuppress_output)
	Finalize solve. More...
subroutine	save (this, filename)
	Save output. More...
subroutine	add_model (this, mp)
	Add explicit model to list. More...
type(listtype) function, pointer	get_models (this)
	Get a pointer to a list of models in the solution. More...
subroutine	add_exchange (this, exchange)
	Add exchange to list of exchanges. More...
type(listtype) function, pointer	get_exchanges (this)
	Get list of exchanges. More...

Detailed Description

Explicit solutions manage and solve explicit models. An explicit model solves itself, as opposed to a numerical model which requires a numerical solution procedure. An explicit solution involves a double loop: an outer loop that continues until no model has pending work, as well as an inner loop that scrolls through the models in the solution and tells each to solve itself. The outer loop is necessary because the explicit models may be coupled by exchanges; models may send work during each solve to other models. The outer loop continues until all models have completed all work.

Function/Subroutine Documentation

add_exchange()

subroutine explicitsolutionmodule::add_exchange ( class(explicitsolutiontype)  this, class(baseexchangetype), intent(in), pointer  exchange  )

private

Definition at line 338 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this
    class(BaseExchangeType), pointer, intent(in) :: exchange
    class(*), pointer :: obj
    obj => exchange
    call this%exchangelist%Add(obj)

add_model()

subroutine explicitsolutionmodule::add_model ( class(explicitsolutiontype)  this, class(basemodeltype), intent(in), pointer  mp  )

private

Parameters

	this	ExplicitSolutionType instance
[in]	mp	model instance

Definition at line 319 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
    class(BaseModelType), pointer, intent(in) :: mp !< model instance
    class(ExplicitModelType), pointer :: m => null()
    select type (mp)
    class is (explicitmodeltype)
      m => mp
      call addexplicitmodeltolist(this%modellist, m)
    end select

Here is the call graph for this function:

allocate_scalars()

subroutine explicitsolutionmodule::allocate_scalars

(

class(explicitsolutiontype)

this

)

Parameters

this	ExplicitSolutionType instance

Definition at line 119 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
 
    ! allocate
    call mem_allocate(this%id, 'ID', this%memoryPath)
    call mem_allocate(this%iu, 'IU', this%memoryPath)
    call mem_allocate(this%ttsoln, 'TTSOLN', this%memoryPath)
    call mem_allocate(this%icnvg, 'ICNVG', this%memoryPath)
 
    ! initialize
    this%id = 0
    this%iu = 0
    this%ttsoln = dzero
    this%icnvg = 0

create_explicit_solution()

subroutine, public explicitsolutionmodule::create_explicit_solution	(	class(explicitsolutiontype), pointer	exp_sol,
		character(len=*), intent(in)	filename,
		integer(i4b), intent(in)	id
	)

Create a new solution using the data in filename, assign this new solution an id number and store the solution in the basesolutionlist. Also open the filename for later reading.

Parameters

	exp_sol	the create solution
[in]	filename	solution input file name
[in]	id	solution id

Definition at line 82 of file ExplicitSolution.f90.

    ! modules
    use inputoutputmodule, only: getunit, openfile
    ! dummy
    class(ExplicitSolutionType), pointer :: exp_sol !< the create solution
    character(len=*), intent(in) :: filename !< solution input file name
    integer(I4B), intent(in) :: id !< solution id
    ! local
    integer(I4B) :: inunit
    class(BaseSolutionType), pointer :: solbase => null()
    character(len=LENSOLUTIONNAME) :: solutionname
 
    ! Create a new solution and add it to the basesolutionlist container
    solbase => exp_sol
    write (solutionname, '(a, i0)') 'SLN_', id
    exp_sol%name = solutionname
    exp_sol%memoryPath = create_mem_path(solutionname)
    allocate (exp_sol%modellist)
    allocate (exp_sol%exchangelist)
    call exp_sol%allocate_scalars()
    call addbasesolutiontolist(basesolutionlist, solbase)
    exp_sol%id = id
 
    ! Open solution input file for reading later after problem size is known
    ! Check to see if the file is already opened, which can happen when
    ! running in single model mode
    inquire (file=filename, number=inunit)
    if (inunit < 0) inunit = getunit()
    exp_sol%iu = inunit
    write (iout, '(/a,a/)') ' Creating explicit solution (EMS): ', exp_sol%name
    call openfile(exp_sol%iu, iout, filename, 'EMS')
 
    ! Initialize block parser
    call exp_sol%parser%Initialize(exp_sol%iu, iout)

Here is the call graph for this function:

Here is the caller graph for this function:

finalizesolve()

subroutine explicitsolutionmodule::finalizesolve ( class(explicitsolutiontype)  this, integer(i4b), intent(in)  kiter, integer(i4b), intent(inout)  isgcnvg, integer(i4b), intent(in)  isuppress_output  )

private

Parameters

	this	ExplicitSolutionType instance
[in]	kiter	Picard iteration number (always 1 for explicit)
[in,out]	isgcnvg	solution group convergence flag
[in]	isuppress_output	flag for suppressing output

Definition at line 284 of file ExplicitSolution.f90.

    ! dummy
    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
    integer(I4B), intent(in) :: kiter !< Picard iteration number (always 1 for explicit)
    integer(I4B), intent(inout) :: isgcnvg !< solution group convergence flag
    integer(I4B), intent(in) :: isuppress_output !< flag for suppressing output
    ! local
    integer(I4B) :: im
    class(ExplicitModelType), pointer :: mp => null()
 
    ! Calculate flow for each model
    do im = 1, this%modellist%Count()
      mp => getexplicitmodelfromlist(this%modellist, im)
      call mp%model_cq(this%icnvg, isuppress_output)
    end do
 
    ! Budget terms for each model
    do im = 1, this%modellist%Count()
      mp => getexplicitmodelfromlist(this%modellist, im)
      call mp%model_bd(this%icnvg, isuppress_output)
    end do

Here is the call graph for this function:

get_exchanges()

type(listtype) function, pointer explicitsolutionmodule::get_exchanges ( class(explicitsolutiontype)  this )

private

Definition at line 347 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this
    type(ListType), pointer :: exchanges
    exchanges => this%exchangelist

get_models()

type(listtype) function, pointer explicitsolutionmodule::get_models ( class(explicitsolutiontype)  this )

private

Returns

pointer to the model list

Parameters

this	ExplicitSolutionType instance

Definition at line 331 of file ExplicitSolution.f90.

    type(ListType), pointer :: models !< pointer to the model list
    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
    models => this%modellist

preparesolve()

subroutine explicitsolutionmodule::preparesolve ( class(explicitsolutiontype)  this )

private

Parameters

this	ExplicitSolutionType instance

Definition at line 222 of file ExplicitSolution.f90.

    ! dummy
    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
    ! local
    integer(I4B) :: i
    class(ExplicitModelType), pointer :: mp => null()
    class(BaseExchangeType), pointer :: ep => null()
 
    ! advance exchanges
    do i = 1, this%exchangelist%Count()
      ep => getbaseexchangefromlist(this%exchangelist, i)
      call ep%exg_ad()
    end do
 
    ! advance models
    do i = 1, this%modellist%Count()
      mp => getexplicitmodelfromlist(this%modellist, i)
      call mp%model_ad()
    end do
 
    ! advance solution
    call this%sln_ad()

Here is the call graph for this function:

save()

subroutine explicitsolutionmodule::save ( class(explicitsolutiontype)  this, character(len=*), intent(in)  filename  )

private

Parameters

	this	ExplicitSolutionType instance
[in]	filename	filename to save solution data

Definition at line 308 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
    character(len=*), intent(in) :: filename !< filename to save solution data
    integer(I4B) :: inunit
    inunit = getunit()
    open (unit=inunit, file=filename, status='unknown')
    write (inunit, *) 'The save routine currently writes nothing'
    close (inunit)

Here is the call graph for this function:

sln_ad()

subroutine explicitsolutionmodule::sln_ad ( class(explicitsolutiontype)  this )

private

Parameters

this	ExplicitSolutionType instance

Definition at line 153 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
 
    ! reset convergence flag
    this%icnvg = 0

sln_ar()

subroutine explicitsolutionmodule::sln_ar ( class(explicitsolutiontype)  this )

private

Parameters

this	ExplicitSolutionType instance

Definition at line 141 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
    ! close ems input file
    call this%parser%Clear()

sln_ca()

subroutine explicitsolutionmodule::sln_ca ( class(explicitsolutiontype)  this, integer(i4b), intent(inout)  isgcnvg, integer(i4b), intent(in)  isuppress_output  )

private

Parameters

	this	ExplicitSolutionType instance
[in,out]	isgcnvg	solution group convergence flag
[in]	isuppress_output	flag for suppressing output

Definition at line 187 of file ExplicitSolution.f90.

    ! dummy
    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
    integer(I4B), intent(inout) :: isgcnvg !< solution group convergence flag
    integer(I4B), intent(in) :: isuppress_output !< flag for suppressing output
    ! local
    class(ExplicitModelType), pointer :: mp => null()
    character(len=LINELENGTH) :: line
    character(len=LINELENGTH) :: fmt
    integer(I4B) :: im
    integer(I4B) :: kiter
 
    kiter = 1
 
    call this%prepareSolve()
 
    select case (isim_mode)
    case (mvalidate)
      line = 'mode="validation" -- Skipping assembly and solution.'
      fmt = "(/,1x,a,/)"
      do im = 1, this%modellist%Count()
        mp => getexplicitmodelfromlist(this%modellist, im)
        call mp%model_message(line, fmt=fmt)
      end do
    case (mnormal)
 
      ! solve the models
      call this%solve(kiter)
 
      ! finish up
      call this%finalizeSolve(kiter, isgcnvg, isuppress_output)
    end select

Here is the call graph for this function:

sln_da()

subroutine explicitsolutionmodule::sln_da ( class(explicitsolutiontype)  this )

private

Parameters

this	ExplicitSolutionType instance

Definition at line 170 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
 
    ! lists
    call this%modellist%Clear()
    deallocate (this%modellist)
    call this%exchangelist%Clear()
    deallocate (this%exchangelist)
 
    ! scalars
    call mem_deallocate(this%id)
    call mem_deallocate(this%iu)
    call mem_deallocate(this%ttsoln)
    call mem_deallocate(this%icnvg)

sln_df()

subroutine explicitsolutionmodule::sln_df ( class(explicitsolutiontype)  this )

private

Definition at line 136 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this

sln_dt()

subroutine explicitsolutionmodule::sln_dt ( class(explicitsolutiontype)  this )

private

Parameters

this	ExplicitSolutionType instance

Definition at line 148 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance

sln_fp()

subroutine explicitsolutionmodule::sln_fp ( class(explicitsolutiontype)  this )

private

Parameters

this	ExplicitSolutionType instance

Definition at line 165 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance

sln_ot()

subroutine explicitsolutionmodule::sln_ot ( class(explicitsolutiontype)  this )

private

Parameters

this	ExplicitSolutionType instance

Definition at line 161 of file ExplicitSolution.f90.

    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance

solve()

subroutine explicitsolutionmodule::solve ( class(explicitsolutiontype)  this, integer(i4b), intent(in)  kiter  )

private

Parameters

	this	ExplicitSolutionType instance
[in]	kiter	Picard iteration (1 for explicit)

Definition at line 247 of file ExplicitSolution.f90.

    ! dummy
    class(ExplicitSolutionType) :: this !< ExplicitSolutionType instance
    integer(I4B), intent(in) :: kiter !< Picard iteration (1 for explicit)
    ! local
    class(ExplicitModelType), pointer :: mp => null()
    integer(I4B) :: im
    logical :: any_pending
    real(DP) :: ttsoln
 
    call code_timer(0, ttsoln, this%ttsoln)
 
    ! Outer loop: repeat until no model has pending work
    do
      ! Solve every model in the solution
      do im = 1, this%modellist%Count()
        mp => getexplicitmodelfromlist(this%modellist, im)
        call mp%model_solve()
      end do
 
      ! Continue if any have pending work
      any_pending = .false.
      do im = 1, this%modellist%Count()
        mp => getexplicitmodelfromlist(this%modellist, im)
        if (mp%has_pending()) then
          any_pending = .true.
          exit
        end if
      end do
      if (.not. any_pending) exit
    end do
 
    call code_timer(1, ttsoln, this%ttsoln)
    this%icnvg = 1

Here is the call graph for this function: