printsavemanagermodule Module Reference

Print/save manager module.

Data Types
type	printsavemanagertype
	Print/save manager type. More...

Functions/Subroutines
type(printsavemanagertype) function, pointer, public	create_psm ()
	Initialize or clear the print/save manager. More...
subroutine	allocate (this)
subroutine	deallocate (this)
subroutine	init (this)
subroutine	read (this, linein, iout)
	@ brief Read a line of input and prepare the manager. More...
subroutine	set (this, ocaction, ocsetting, iout)
	@ brief set data from an input record. More...
logical function	should_print (this, kstp, endofperiod)
	@ brief Determine if printing is enabled for this time step. More...
logical function	should_save (this, kstp, endofperiod)
	@ brief Determine if saving is enabled for this time step. More...

Function/Subroutine Documentation

allocate()

subroutine printsavemanagermodule::allocate ( class(printsavemanagertype)  this )

private

Definition at line 63 of file PrintSaveManager.f90.

    class(PrintSaveManagerType) :: this
    allocate (this%save_steps)
    allocate (this%print_steps)
    call this%save_steps%init()
    call this%print_steps%init()

create_psm()

type(printsavemanagertype) function, pointer, public printsavemanagermodule::create_psm

Returns

the print/save manager

Definition at line 57 of file PrintSaveManager.f90.

    type(PrintSaveManagerType), pointer :: psm !< the print/save manager
    allocate (psm)
    call psm%allocate()

Here is the caller graph for this function:

deallocate()

subroutine printsavemanagermodule::deallocate ( class(printsavemanagertype)  this )

private

Parameters

this	this instance

Definition at line 71 of file PrintSaveManager.f90.

    class(PrintSaveManagerType) :: this !< this instance
    if (associated(this%save_steps)) deallocate (this%save_steps)
    if (associated(this%print_steps)) deallocate (this%print_steps)

init()

subroutine printsavemanagermodule::init ( class(printsavemanagertype)  this )

private

Definition at line 77 of file PrintSaveManager.f90.

    class(PrintSaveManagerType) :: this
    call this%deallocate()
    call this%allocate()

read()

subroutine printsavemanagermodule::read ( class(printsavemanagertype)  this, character(len=*), intent(in)  linein, integer(i4b), intent(in)  iout  )

private

Parameters

	this	this instance
[in]	linein	input line
[in]	iout	output file unit

Definition at line 84 of file PrintSaveManager.f90.

    ! dummy
    class(PrintSaveManagerType) :: this !< this instance
    character(len=*), intent(in) :: linein !< input line
    integer(I4B), intent(in) :: iout !< output file unit
    ! local
    character(len=len(linein)) :: line
    integer(I4B) :: lloc, istart, istop, ival
    real(DP) :: rval
 
    line(:) = linein(:)
    lloc = 1
    call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
 
    select case (line(istart:istop))
    case ('PRINT')
      call this%print_steps%read(line(istop + 2:))
      if (iout > 0) &
        call this%print_steps%log(iout, verb="PRINTED")
    case ('SAVE')
      call this%save_steps%read(line(istop + 2:))
      if (iout > 0) &
        call this%save_steps%log(iout, verb="SAVED")
    case default
      call store_error( &
        'Looking for PRINT or SAVE. Found: '//trim(adjustl(line)), &
        terminate=.true.)
    end select

Here is the call graph for this function:

set()

subroutine printsavemanagermodule::set ( class(printsavemanagertype)  this, character(len=*)  ocaction, character(len=*)  ocsetting, integer(i4b), intent(in)  iout  )

private

Parameters

	this	this instance
[in]	iout	output file unit

Definition at line 115 of file PrintSaveManager.f90.

    ! dummy
    class(PrintSaveManagerType) :: this !< this instance
    character(len=*) :: ocaction
    character(len=*) :: ocsetting
    integer(I4B), intent(in) :: iout !< output file unit
    select case (ocaction)
    case ('PRINT')
      call this%print_steps%read(ocsetting)
      if (iout > 0) &
        call this%print_steps%log(iout, verb="PRINTED")
    case ('SAVE')
      call this%save_steps%read(ocsetting)
      if (iout > 0) &
        call this%save_steps%log(iout, verb="SAVED")
    case default
      call store_error( &
        'Looking for PRINT or SAVE. Found: '//trim(adjustl(ocaction)), &
        terminate=.true.)
    end select

Here is the call graph for this function:

should_print()

logical function printsavemanagermodule::should_print ( class(printsavemanagertype)  this, integer(i4b), intent(in)  kstp, logical(lgp), intent(in)  endofperiod  )

private

Parameters

	this	this instance
[in]	kstp	current time step
[in]	endofperiod	whether last step of stress period

Definition at line 138 of file PrintSaveManager.f90.

    class(PrintSaveManagerType) :: this !< this instance
    integer(I4B), intent(in) :: kstp !< current time step
    logical(LGP), intent(in) :: endofperiod !< whether last step of stress period
 
    should_print = this%print_steps%is_selected(kstp, endofperiod)

should_save()

logical function printsavemanagermodule::should_save ( class(printsavemanagertype)  this, integer(i4b), intent(in)  kstp, logical(lgp), intent(in)  endofperiod  )

private

Parameters

	this	this instance
[in]	kstp	current time step
[in]	endofperiod	whether last step of stress period

Definition at line 147 of file PrintSaveManager.f90.

    class(PrintSaveManagerType) :: this !< this instance
    integer(I4B), intent(in) :: kstp !< current time step
    logical(LGP), intent(in) :: endofperiod !< whether last step of stress period
 
    should_save = this%save_steps%is_selected(kstp, endofperiod)