mcclatchey_profiles Module Reference

Functions/Subroutines
subroutine	read_mcclatchey_profiles (current_state, mcc)
subroutine	check_mcc_status (status)
	Will check for a NetCDF status of the McClatchey profile file and write to log_log error any decoded statuses. More...
subroutine	read_mcc_dimensions (ncid, plev_dim)
	Reads the dimensions from the NetCDF file. More...
subroutine	read_mcc_variables (filename, ncid, plev_dim, MCC_PROFILE_KEY, temp_mcc_3d, plev)
subroutine	read_single_mcc_variable (ncid, key, data1d, data3d)
	Reads a single variable out of a NetCDF file. More...
subroutine	calculate_radiation_levels (current_state, mcc)

Variables
character(len= *), parameter	pressure_key = "plev"
	NetCDF data plev key in McClatchey profile. More...
character(len= *), parameter	temperature_profile_key = "t"
	NetCDF data for temperature. More...
character(len= *), parameter	vapour_profile_key = "q"
	NetCDF data for vapour. More...
character(len= *), parameter	ozone_profile_key = "o3"
	NetCDF data for ozone. More...

Function/Subroutine Documentation

calculate_radiation_levels()

subroutine mcclatchey_profiles::calculate_radiation_levels	(	type(model_state_type), intent(inout), target	current_state,
		type(str_mcc_profiles), intent(inout)	mcc
	)

Definition at line 235 of file mcclatchey_profiles.F90.

    ! This routine calculates the total number of levels to be
    ! used in the radiation calcs (socrates). This includes the
    ! number of levels in the MONC testcase plus all the
    ! McClattchey levels which fill in the top of atmosphere.
    ! The number of levels is dependent on the McClattchey profile
    ! selected in the MONC configuration
    type(model_state_type), target, intent(inout) :: current_state
 
    type(str_mcc_profiles), intent(inout) :: mcc
    
    real(kind=default_precision), parameter ::       &
         fracdp = 0.75,        &
         ! fraction of to dp which the 1st rad leevl can be from top
         mindp = 2000.,        &
         ! Minimum values dp in Pa
         maxdp = 10000.
         ! Maximum dp we will allow from top
    real(kind=default_precision) :: pmindiff, pcutoff
    real(kind=default_precision), allocatable :: prefn_loc(:) !(current_state%local_grid%size(Z_INDEX))
    
    integer :: k
 
    allocate(prefn_loc(current_state%local_grid%size(z_index)))
    
    prefn_loc(:) = current_state%global_grid%configuration%vertical%prefn(:) 
    
    pmindiff = min(max(fracdp* &
         (prefn_loc(current_state%local_grid%size(z_index)-1) - &
         prefn_loc(current_state%local_grid%size(z_index))),    &
         mindp), maxdp)
    pcutoff = prefn_loc(current_state%local_grid%size(z_index)) - pmindiff
    
    mcc%cut = 0
    do k=1, mcc%levs
       if (mcc%p_n(k) .lt. pcutoff) mcc%cut = k
    enddo
 
    mcc%irad_levs = current_state%local_grid%size(z_index) + mcc%cut
    mcc%n_levels = mcc%irad_levs - 1
 
    deallocate(prefn_loc)
    

check_mcc_status()

subroutine mcclatchey_profiles::check_mcc_status

(

integer, intent(in)

status

)

Will check for a NetCDF status of the McClatchey profile file and write to log_log error any decoded statuses.

Parameters

status

The NetCDF status flag

Definition at line 144 of file mcclatchey_profiles.F90.

    integer, intent(in) :: status
    
    if (status /= nf90_noerr) then
       call log_log(log_error, "NetCDF returned error code of "//trim(nf90_strerror(status)))
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

read_mcc_dimensions()

subroutine mcclatchey_profiles::read_mcc_dimensions	(	integer, intent(in)	ncid,
		integer, intent(out)	plev_dim
	)

Reads the dimensions from the NetCDF file.

Parameters

ncid	The NetCDF file id
time_dim	Number of elements in the time dimension

Definition at line 158 of file mcclatchey_profiles.F90.

    integer, intent(in) :: ncid
    integer, intent(out) ::  plev_dim
    integer ::  plev_dimid
 
    call check_mcc_status(nf90_inq_dimid(ncid, pressure_key, plev_dimid))
 
    call check_mcc_status(nf90_inquire_dimension(ncid, plev_dimid, len=plev_dim))
 

Here is the call graph for this function:

Here is the caller graph for this function:

read_mcc_variables()

subroutine mcclatchey_profiles::read_mcc_variables	(	character(*), intent(in)	filename,
		integer, intent(in)	ncid,
		integer, intent(in)	plev_dim,
		character(*), intent(in)	MCC_PROFILE_KEY,
		real(kind=default_precision), dimension(:,:,:), intent(inout), allocatable	temp_mcc_3d,
		real(kind=default_precision), dimension(:), intent(inout), optional, allocatable	plev
	)

Definition at line 169 of file mcclatchey_profiles.F90.

 
    character(*), intent(in) :: filename
    character(*), intent(in) :: MCC_PROFILE_KEY
    
    real(kind=default_precision), dimension(:), allocatable, intent(inout), optional :: plev
    real(kind=default_precision), dimension(:,:,:), allocatable, intent(inout) :: temp_mcc_3d
 
    integer, intent(in) :: ncid, plev_dim
    integer :: status, variable_id
    
    ! Do some checking on the variable contents so that we can deal with different 
    ! variable names or missing variables
    
    ! pressure levels, only done once with the first call...
    if (present(plev)) then
       status=nf90_inq_varid(ncid, pressure_key, variable_id)
       if (status==nf90_noerr)then
          allocate(plev(plev_dim))
          call read_single_mcc_variable(ncid, pressure_key, data1d=plev)
       else
          call log_log(log_error, "No recognized pressure variable found in"//trim(filename))
       end if
    endif
    
    status=nf90_inq_varid(ncid, mcc_profile_key, variable_id)
    if (status==nf90_noerr)then
       call read_single_mcc_variable(ncid, mcc_profile_key, data3d=temp_mcc_3d)
    else
       call log_log(log_error, "No recognized pressure variable found in"//trim(filename))
    end if
 

Here is the call graph for this function:

Here is the caller graph for this function:

read_mcclatchey_profiles()

subroutine mcclatchey_profiles::read_mcclatchey_profiles	(	type(model_state_type), intent(inout), target	current_state,
		type(str_mcc_profiles), intent(inout)	mcc
	)

Definition at line 24 of file mcclatchey_profiles.F90.

    ! This routine is the top-level routine to read the
    ! McClatchey (mcc) data from the file. It is assumed the data is
    ! in netcdf format. In Socrates, the mcc data is in CDL format
    ! (netcdf ASCII), so it needs to be converted using ncgen
    !
    ! This routine also derives centre grid values for the McClatchey profiles
    ! It is assumed that the staggering of the grid is the same as MONC, but flipped
    ! 
    type(model_state_type), target, intent(inout) :: current_state
 
    type(str_mcc_profiles), intent(inout) :: mcc
 
    real(kind=default_precision), allocatable :: weight_upper, weight_lower
    
    real(kind=default_precision), allocatable :: temp_mcc_3d(:,:,:)
 
    integer, parameter :: MAX_FILE_LEN=200
    character(MAX_FILE_LEN) :: mcc_input_file
 
    integer :: ncid, plev_dim, k
    ! Read McClatchey profile from the global or user config. Seperate
    ! profile files required from temperature, vapour and ozone. Pressure
    ! is in all files. After each get_string, there is check status for each
    ! file.
 
    ! read pressure and temperature
    mcc_input_file =  &
         options_get_string(current_state%options_database, "mcc_temperature_profile")
    if (log_get_logging_level() .ge. log_debug) then
       call log_master_log(log_debug, &
            "Reading in McClatchey pressure and temperature from:"//trim(mcc_input_file) )
    endif
    call check_mcc_status(nf90_open(path = trim(mcc_input_file), mode = nf90_nowrite, ncid = ncid))
    call read_mcc_dimensions(ncid, plev_dim)
    ! set number of McClatchey levels
    mcc%levs = plev_dim
    ! check if temp_mcc_3d allocated and allocate if needed
    if(.not. allocated(temp_mcc_3d)) then
       allocate(temp_mcc_3d(1,1,plev_dim))
    endif
    call read_mcc_variables(trim(mcc_input_file), ncid, plev_dim, &
         temperature_profile_key, temp_mcc_3d, mcc%p_level)
    allocate(mcc%t_level(plev_dim))
    mcc%t_level(:)=temp_mcc_3d(1,1,:)   
    call check_mcc_status(nf90_close(ncid))
    
    ! work out the centre grid values of pressure (linear interpolation)
    allocate(mcc%p_n(plev_dim))
    do k = 2, mcc%levs
       mcc%p_n(k)=(0.5*(mcc%p_level(k-1)+(mcc%p_level(k))))
    enddo
    mcc%p_n(1)=mcc%p_level(1)+(0.5*(mcc%p_n(2)-mcc%p_level(1)))
    ! work out the centre grid values of using (log(p) weighting but linear interpolation t)
    allocate(mcc%t_n(plev_dim))
    do k = 2, mcc%levs
       weight_upper = log(mcc%p_level(k))-log(mcc%p_n(k-1))
       weight_lower = log(mcc%p_level(k))-log(mcc%p_level(k-1))
       mcc%t_n(k) = (((weight_upper*mcc%t_level(k))) + &
            (weight_lower*mcc%t_level(k-1)))/(weight_upper+weight_lower)
    enddo
    mcc%t_n(1)=mcc%t_level(1)+(0.5*(mcc%t_n(2)-mcc%t_level(1)))
 
    ! read mcc vapour field
    mcc_input_file =  &
         options_get_string(current_state%options_database, "mcc_vapour_profile")
    if (log_get_logging_level() .ge. log_debug) then
       call log_master_log(log_debug, &
            "Reading in McClatchey vapour profile from:"//trim(mcc_input_file) )
    endif
    call check_mcc_status(nf90_open(path = trim(mcc_input_file), mode = nf90_nowrite, ncid = ncid))
    call read_mcc_variables(trim(mcc_input_file), ncid, plev_dim, vapour_profile_key, temp_mcc_3d)
    allocate(mcc%q_level(plev_dim))
    mcc%q_level(:)=temp_mcc_3d(1,1,:)
    call check_mcc_status(nf90_close(ncid))
 
    ! work out the centre grid values of using (log(p) weighting but log interpolation q and o3)
    ! change to log of mixing ratio
    allocate(mcc%q_n(plev_dim))
    do k = 2, mcc%levs
       weight_upper = log(mcc%p_level(k))-log(mcc%p_n(k-1))
       weight_lower = log(mcc%p_level(k))-log(mcc%p_level(k-1))
       mcc%q_n(k) = (((weight_upper*log(mcc%q_level(k)))) + &
            (weight_lower*log(mcc%q_level(k-1))))/(weight_upper+weight_lower)
       mcc%q_n(k) = exp(mcc%q_n(k))
    enddo
    mcc%q_n(1)=mcc%q_level(1)+(0.5*((mcc%q_n(2)-mcc%q_level(1))))
 
    ! read mcc ozone field
    mcc_input_file =  &
         options_get_string(current_state%options_database, "mcc_ozone_profile")
    if (log_get_logging_level() .ge. log_debug) then
       call log_master_log(log_debug, &
            "Reading in McClatchey ozone profile from:"//trim(mcc_input_file) )
    endif
    call check_mcc_status(nf90_open(path = trim(mcc_input_file), mode = nf90_nowrite, ncid = ncid))
    call read_mcc_variables(trim(mcc_input_file), ncid, plev_dim, ozone_profile_key, temp_mcc_3d)
    allocate(mcc%o3_level(plev_dim))
    mcc%o3_level(:)=temp_mcc_3d(1,1,:)
    call check_mcc_status(nf90_close(ncid))
 
    ! work out the centre grid values of using (log(p) weighting but log interpolation q and o3)
    ! change to log of mixing ratio
    allocate(mcc%o3_n(plev_dim))
    do k = 2, mcc%levs
       weight_upper = log(mcc%p_level(k))-log(mcc%p_n(k-1))
       weight_lower = log(mcc%p_level(k))-log(mcc%p_level(k-1))
       mcc%o3_n(k) = (((weight_upper*log(mcc%o3_level(k)))) + &
            (weight_lower*log(mcc%o3_level(k-1))))/(weight_upper+weight_lower)
       mcc%o3_n(k) = exp(mcc%o3_n(k))
    enddo
    mcc%o3_n(1)=mcc%o3_level(1)+(0.5*(mcc%o3_n(2)-mcc%o3_level(1)))
    
    deallocate(temp_mcc_3d)
    

Here is the call graph for this function:

read_single_mcc_variable()

subroutine mcclatchey_profiles::read_single_mcc_variable	(	integer, intent(in)	ncid,
		character(len=*), intent(in)	key,
		real(kind=default_precision), dimension(:), intent(inout), optional	data1d,
		real(kind=default_precision), dimension(:,:,:), intent(inout), optional	data3d
	)

Reads a single variable out of a NetCDF file.

Parameters

ncid	The NetCDF file id
key	The variable key (name) to access
data1d	Optional one dimensional data to read into
data3d	Optional three dimensional data to read into

Definition at line 211 of file mcclatchey_profiles.F90.

    integer, intent(in) :: ncid
    character(len=*), intent(in) :: key
    real(kind=default_precision), dimension(:), intent(inout), optional :: data1d
    real(kind=default_precision), dimension(:,:,:), intent(inout), optional :: data3d
 
    integer :: variable_id
    real(kind=default_precision), dimension(:,:,:), allocatable :: sdata
 
    call check_mcc_status(nf90_inq_varid(ncid, key, variable_id))
 
    if (.not. present(data1d) .and. .not. present(data3d)) return
 
    if (present(data1d)) then
      call check_mcc_status(nf90_get_var(ncid, variable_id, data1d))
    else
      ! 3D will reshape the data to take account of the column-row major C-F transposition
      allocate(sdata(size(data3d,1),size(data3d,2), size(data3d,3)))
      call check_mcc_status(nf90_get_var(ncid, variable_id, sdata))
      data3d(:,:,:)=reshape(sdata(:,:,:),(/size(data3d,1),size(data3d,2),size(data3d,3)/))
      deallocate(sdata)
    end if

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ozone_profile_key

character(len=*), parameter mcclatchey_profiles::ozone_profile_key = "o3"

NetCDF data for ozone.

Definition at line 16 of file mcclatchey_profiles.F90.

pressure_key

character(len=*), parameter mcclatchey_profiles::pressure_key = "plev"

NetCDF data plev key in McClatchey profile.

Definition at line 16 of file mcclatchey_profiles.F90.

  character(len=*), parameter ::                     &
       PRESSURE_KEY =                  "plev" ,       &  !<  NetCDF data plev key in McClatchey profile
       temperature_profile_key =       "t"    ,       &  
       vapour_profile_key =            "q"    ,       &  
       ozone_profile_key =             "o3"              

temperature_profile_key

character(len=*), parameter mcclatchey_profiles::temperature_profile_key = "t"

NetCDF data for temperature.

Definition at line 16 of file mcclatchey_profiles.F90.

vapour_profile_key

character(len=*), parameter mcclatchey_profiles::vapour_profile_key = "q"

NetCDF data for vapour.

Definition at line 16 of file mcclatchey_profiles.F90.