timestep_data.f90

Go to the documentation of this file.

!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!!! Time-stamp: <2016-10-18 15:00:41 pbrowne>
!!!
!!!    Module that stores information about timestepping
!!!    Copyright (C) 2015  Philip A. Browne
!!!
!!!    This program is free software: you can redistribute it and/or modify
!!!    it under the terms of the GNU General Public License as published by
!!!    the Free Software Foundation, either version 3 of the License, or
!!!    (at your option) any later version.
!!!
!!!    This program is distributed in the hope that it will be useful,
!!!    but WITHOUT ANY WARRANTY; without even the implied warranty of
!!!    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
!!!    GNU General Public License for more details.
!!!
!!!    You should have received a copy of the GNU General Public License
!!!    along with this program.  If not, see <http://www.gnu.org/licenses/>.
!!!
!!!    Email: p.browne @ reading.ac.uk
!!!    Mail:  School of Mathematical and Physical Sciences,
!!!           University of Reading,
!!!       Reading, UK
!!!       RG6 6BB
!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

Module timestep_data
  implicit none
  type, public :: timestep_data_type
     integer :: total_timesteps
     integer :: current_timestep
     integer :: completed_timesteps
     integer :: next_ob_timestep
     logical :: is_analysis
     logical :: do_analysis
     integer, allocatable, dimension(:) :: obs_times
     integer :: tau
  end type timestep_data_type
  type(timestep_data_type), save :: tsdata

  contains
    subroutine timestep_data_allocate_obs_times(n)
      use output_empire, only : emp_e
      implicit none
      integer, intent(in) :: n
      integer :: st
      allocate(tsdata%obs_times(n),stat=st)
      if(st .ne. 0) then
         write(emp_e,*) 'ERROR: allocation of obs_times in timestep data'
         write(emp_e,*) 'ERROR: STOPPING.'
         stop '-7'
      end if
      tsdata%obs_times = -1
    end subroutine timestep_data_allocate_obs_times

    subroutine timestep_data_deallocate_obs_times
      deallocate(tsdata%obs_times)
    end subroutine timestep_data_deallocate_obs_times

    subroutine timestep_data_set_obs_times(obs_num_in_time,timestep)
      implicit none
      integer, intent(in) :: obs_num_in_time
      integer, intent(in) :: timestep

      tsdata%obs_times(obs_num_in_time) = timestep
    end subroutine timestep_data_set_obs_times

    subroutine timestep_data_set_next_ob_time(ob_time)
      implicit none
      integer, intent(in) :: ob_time
      
      tsdata%next_ob_timestep = ob_time
    end subroutine timestep_data_set_next_ob_time
    
    subroutine timestep_data_get_obs_times(obs_num_in_time,timestep)
      implicit none
      integer, intent(in) :: obs_num_in_time
      integer, intent(out) :: timestep
      timestep = tsdata%obs_times(obs_num_in_time)
    end subroutine timestep_data_get_obs_times
    
    subroutine timestep_data_set_do_analysis
      implicit none
      tsdata%do_analysis = .true.
    end subroutine timestep_data_set_do_analysis

    subroutine timestep_data_set_do_no_analysis
      implicit none
      tsdata%do_analysis = .false.
    end subroutine timestep_data_set_do_no_analysis
    
    subroutine timestep_data_set_is_analysis
      implicit none
      tsdata%is_analysis = .true.
    end subroutine timestep_data_set_is_analysis
    
    subroutine timestep_data_set_no_analysis
      implicit none
      tsdata%is_analysis = .false.
    end subroutine timestep_data_set_no_analysis

    subroutine timestep_data_set_completed(t)
      implicit none
      integer, intent(in) :: t
      tsdata%completed_timesteps = t
    end subroutine timestep_data_set_completed

    subroutine timestep_data_set_current(t)
      implicit none
      integer, intent(in) :: t
      tsdata%current_timestep = t
    end subroutine timestep_data_set_current

    subroutine timestep_data_set_total(t)
      implicit none
      integer, intent(in) :: t
      tsdata%total_timesteps = t
    end subroutine timestep_data_set_total

    subroutine timestep_data_set_tau(pseudotimestep)
      implicit none
      integer, intent(in) :: pseudotimestep
      tsdata%tau = pseudotimestep
    end subroutine timestep_data_set_tau

    
End Module timestep_data