Skip to content

Add advection operator convergence test #583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mark-petersen merged 3 commits into from
Jan 19, 2021
Merged

Add advection operator convergence test #583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a01d197
Adds cosine bell case and advection test case
vanroekel Aug 28, 2020
f3f049a
Correct comments and spacing
mark-petersen Jan 15, 2021
f17c5d0
Add to cmake
mark-petersen Jan 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/core_ocean/mode_init/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ TEST_CASES = mpas_ocn_init_baroclinic_channel.o \
mpas_ocn_init_isomip.o \
mpas_ocn_init_isomip_plus.o \
mpas_ocn_init_hurricane.o \
mpas_ocn_init_tidal_boundary.o
mpas_ocn_init_tidal_boundary.o \
mpas_ocn_init_cosine_bell.o
#mpas_ocn_init_TEMPLATE.o

all: init_mode
Expand Down
1 change: 1 addition & 0 deletions src/core_ocean/mode_init/Registry.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
#include "Registry_isomip_plus.xml"
#include "Registry_hurricane.xml"
#include "Registry_tidal_boundary.xml"
#include "Registry_cosine_bell.xml"
// #include "Registry_TEMPLATE.xml"


Expand Down
30 changes: 30 additions & 0 deletions src/core_ocean/mode_init/Registry_cosine_bell.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<nml_record name="cosine_bell" mode="init" configuration="cosine_bell">
<nml_option name="config_cosine_bell_temperature" type="real" default_value="15.0" units="deg C"
description="Temperature of the ocean."
possible_values="Any real number"
/>
<nml_option name="config_cosine_bell_salinity" type="real" default_value="35.0" units="PSU"
description="Salinity of the ocean."
possible_values="Any real number"
/>
<nml_option name="config_cosine_bell_lat_center" type="real" default_value="0.0" units="radians"
description="latitude center of cosine bell"
possible_values="Any real number between -pi/2 and pi/2"
/>
<nml_option name="config_cosine_bell_lon_center" type="real" default_value="3.141592" units="radians"
description="longitude center of cosine bell"
possible_values="Any non-negative real number between 0 and 2pi"
/>
<nml_option name="config_cosine_bell_psi0" type="real" default_value="1.0" units="unitless"
description="hill max of tracer"
possible_values="Any real number"
/>
<nml_option name="config_cosine_bell_radius" type="real" default_value="2123666.667" units="m"
description="radius of cosine bell"
possible_values="Any non-negative real number between 0 and 2pi"
/>
<nml_option name="config_cosine_bell_vel_pd" type="real" default_value="24.0" units="days"
description="time for bell to transit equator once"
possible_values="Any non-negative real number"
/>
</nml_record>
302 changes: 302 additions & 0 deletions src/core_ocean/mode_init/mpas_ocn_init_cosine_bell.F
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,302 @@
! Copyright (c) 2013, Los Alamos National Security, LLC (LANS)
! and the University Corporation for Atmospheric Research (UCAR).
!
! Unless noted otherwise source code is licensed under the BSD license.
! Additional copyright and license information can be found in the
! LICENSE file
! distributed with this code, or at
! http://mpas-dev.github.com/license.html
!
!|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
!
! ocn_init_cosine_bell
!
!> \brief MPAS ocean initialize case -- Cosine Bell
!> \author Luke Van Roekel
!> \date 09/01/2020
!> \details
!> This module contains the routines for initializing the
!> the cosine bell test case
!> Reference: Section 2a in Skamarock, W.C. and A. Gassmann, 2011: Conservative
!> Transport Schemes for Spherical Geodesic Grids: High-Order Flux Operators for
!> ODE-Based Time Integration. Mon. Wea. Rev., 139, 2962–2975,
!> https://doi.org/10.1175/MWR-D-10-05056.1
!
!-----------------------------------------------------------------------

module ocn_init_cosine_bell

use mpas_kind_types
use mpas_io_units
use mpas_derived_types
use mpas_pool_routines
use mpas_constants
use mpas_stream_manager
use mpas_dmpar

use ocn_init_cell_markers
use ocn_init_vertical_grids

implicit none
private
save

!--------------------------------------------------------------------
!
! Public parameters
!
!--------------------------------------------------------------------

!--------------------------------------------------------------------
!
! Public member functions
!
!--------------------------------------------------------------------

public :: ocn_init_setup_cosine_bell, &
ocn_init_validate_cosine_bell

!--------------------------------------------------------------------
!
! Private module variables
!
!--------------------------------------------------------------------

!***********************************************************************

contains

!***********************************************************************
!
! routine ocn_init_setup_cosine_bell
!
!> \brief Set-up for test case
!> \author Luke Van Roekel
!> \date 09/01/2020
!> \details
!> Reference: Section 2a in Skamarock, W.C. and A. Gassmann, 2011: Conservative
!> Transport Schemes for Spherical Geodesic Grids: High-Order Flux Operators for
!> ODE-Based Time Integration. Mon. Wea. Rev., 139, 2962–2975,
!> https://doi.org/10.1175/MWR-D-10-05056.1
!
!-----------------------------------------------------------------------

subroutine ocn_init_setup_cosine_bell(domain, iErr)!{{{

!--------------------------------------------------------------------

type (domain_type), intent(inout) :: domain
integer, intent(out) :: iErr
real (kind=RKIND) :: temperature, salinity

type (block_type), pointer :: block_ptr

type (mpas_pool_type), pointer :: meshPool, verticalMeshPool,statePool
type (mpas_pool_type), pointer :: diagnosticsPool, forcingPool

type (mpas_pool_type), pointer :: tracersPool

integer, pointer :: nVertLevels, nVertLevelsP1, nCellsSolve,nEdgesSolve, nEdge, nVerticesSolve
integer, pointer :: index_temperature, index_salinity,index_tracer1

integer, dimension(:), pointer :: maxLevelCell
real (kind=RKIND), dimension(:), pointer :: refBottomDepth,refZMid
real (kind=RKIND), dimension(:), pointer :: lonCell, latEdge, latCell, latVertex
real (kind=RKIND), dimension(:), pointer :: bottomDepth, angleEdge
real (kind=RKIND), dimension(:), pointer :: fCell, fEdge, fVertex,xCell, yCell
real (kind=RKIND), dimension(:, :), pointer :: layerThickness,restingThickness,normalVelocity
real (kind=RKIND), dimension(:, :, :), pointer :: activeTracers,debugTracers

real (kind=RKIND), dimension(:), pointer :: interfaceLocations

integer :: iCell, iEdge, iVertex, k, kML

real (kind=RKIND) :: temp, velocity

character (len=StrKIND), pointer :: config_init_configuration

real (kind=RKIND), pointer ::config_cosine_bell_temperature, &
config_cosine_bell_salinity, &
config_cosine_bell_radius, &
config_cosine_bell_lat_center, &
config_cosine_bell_lon_center, &
config_cosine_bell_psi0, &
config_cosine_bell_vel_pd, &
sphere_radius
! assume no error
iErr = 0

! get and test if this is the configuration specified
call mpas_pool_get_config(domain % configs,'config_init_configuration', config_init_configuration)
if(config_init_configuration .ne. trim('cosine_bell')) return

! load the remaining configuration parameters
call mpas_pool_get_config(domain % configs,'config_cosine_bell_temperature', &
config_cosine_bell_temperature)
call mpas_pool_get_config(domain % configs,'config_cosine_bell_salinity', &
config_cosine_bell_salinity)
call mpas_pool_get_config(domain % configs,'config_cosine_bell_radius', &
config_cosine_bell_radius)
call mpas_pool_get_config(domain % configs,'config_cosine_bell_psi0', &
config_cosine_bell_psi0)
call mpas_pool_get_config(domain % configs,'config_cosine_bell_vel_pd', &
config_cosine_bell_vel_pd)
call mpas_pool_get_config(domain % configs,'config_cosine_bell_lat_center', &
config_cosine_bell_lat_center)
call mpas_pool_get_config(domain % configs,'config_cosine_bell_lon_center', &
config_cosine_bell_lon_center)
!load data that required to initialize the ocean simulation
block_ptr => domain % blocklist
do while(associated(block_ptr))
call mpas_pool_get_subpool(block_ptr % structs, 'mesh',meshPool)
call mpas_pool_get_subpool(block_ptr % structs, 'verticalMesh',verticalMeshPool)
call mpas_pool_get_subpool(block_ptr % structs, 'state',statePool)
call mpas_pool_get_subpool(block_ptr % structs, 'diagnostics',diagnosticsPool)
call mpas_pool_get_subpool(block_ptr % structs, 'forcing',forcingPool)

call mpas_pool_get_subpool(statePool, 'tracers', tracersPool)

call mpas_pool_get_dimension(meshPool, 'nVertLevels',nVertLevels)
call mpas_pool_get_dimension(meshPool, 'nCellsSolve',nCellsSolve)
call mpas_pool_get_dimension(meshPool, 'nEdge', nEdge)
call mpas_pool_get_dimension(meshPool, 'nEdgesSolve',nEdgesSolve)
call mpas_pool_get_dimension(meshPool, 'nVerticesSolve',nVerticesSolve)
call mpas_pool_get_config(meshPool, 'sphere_radius', sphere_radius)

call mpas_pool_get_dimension(tracersPool, 'index_temperature',index_temperature)
call mpas_pool_get_dimension(tracersPool, 'index_salinity',index_salinity)
call mpas_pool_get_dimension(tracersPool, 'index_tracer1',index_tracer1)

call mpas_pool_get_array(meshPool, 'maxLevelCell', maxLevelCell)
call mpas_pool_get_array(meshPool, 'bottomDepth', bottomDepth)
call mpas_pool_get_array(meshPool, 'angleEdge', angleEdge)
call mpas_pool_get_array(meshPool, 'latCell', latCell)
call mpas_pool_get_array(meshPool, 'latEdge', latEdge)
call mpas_pool_get_array(meshPool, 'latVertex', latVertex)
call mpas_pool_get_array(meshPool, 'lonCell', lonCell)
call mpas_pool_get_array(meshPool, 'refBottomDepth', refBottomDepth)
call mpas_pool_get_array(meshPool, 'fCell', fCell)
call mpas_pool_get_array(meshPool, 'fEdge', fEdge)
call mpas_pool_get_array(meshPool, 'fVertex', fVertex)
call mpas_pool_get_array(meshPool, 'xCell', xCell)
call mpas_pool_get_array(meshPool, 'yCell', yCell)


call mpas_pool_get_array(verticalMeshPool, 'refZMid', refZMid)
call mpas_pool_get_array(verticalMeshPool, 'restingThickness',restingThickness)

call mpas_pool_get_array(statePool, 'normalVelocity', normalVelocity, 1)
call mpas_pool_get_array(tracersPool, 'activeTracers',activeTracers, 1)
call mpas_pool_get_array(tracersPool, 'debugTracers',debugTracers, 1)
call mpas_pool_get_array(statePool, 'layerThickness',layerThickness, 1)

! Set refBottomDepth and refBottomDepthTopOfCell
do k = 1, nVertLevels
refBottomDepth(k) = 100.0_RKIND
refZMid(k) = 50.0_RKIND
end do

do iCell = 1, nCellsSolve
if(associated(activeTracers) ) then

! Loop from surface through surface layer depth

activeTracers(index_temperature, :, iCell) = config_cosine_bell_temperature
activeTracers(index_salinity, :, iCell) = config_cosine_bell_salinity
endif

if(associated(debugTracers)) then
temp = sphere_radius*acos(sin(config_cosine_bell_lat_center)*sin(latCell(iCell)) + &
cos(config_cosine_bell_lat_center)*cos(latCell(iCell))*cos(lonCell(iCell) - &
config_cosine_bell_lon_center))

if( temp < config_cosine_bell_radius ) then
debugTracers(:,:,iCell) = config_cosine_bell_psi0/2.0_RKIND * ( 1.0_RKIND + &
cos(3.1415926_RKIND*temp/config_cosine_bell_radius))
else
debugTracers(:,:,iCell) = 0.0_RKIND
endif
endif
! Set layerThickness
do k = 1, nVertLevels
layerThickness(k, iCell) = 100.0_RKIND
restingThickness(k, iCell) = layerThickness(k, iCell)
end do

! Set Coriolis parameter
fCell(iCell) = 0.0_RKIND*omega*sin(latCell(iCell))

! Set bottomDepth
bottomDepth(iCell) = 100.0_RKIND

! Set maxLevelCell
maxLevelCell(iCell) = nVertLevels

end do ! do iCell

do iEdge = 1, nEdgesSolve
fEdge(iEdge) = 0.0_RKIND*omega*sin(latEdge(iEdge))
end do

do iVertex=1, nVerticesSolve
fVertex(iVertex) = 0.0_RKIND*omega*sin(latVertex(iVertex))
end do

!set normal velocity
do iEdge = 1,nEdgesSolve
velocity = 2.0*3.14159265*sphere_radius*cos(latEdge(iEdge)) / &
(86400.0_RKIND*config_cosine_bell_vel_pd)
normalVelocity(:,iEdge) = velocity*cos(angleEdge(iEdge))
enddo

block_ptr => block_ptr % next
end do

!--------------------------------------------------------------------

end subroutine ocn_init_setup_cosine_bell!}}}

!***********************************************************************
!
! routine ocn_init_validate_cosine_bell
!
!> \brief Validation for test case
!> \author Luke Van Roekel
!> \date 09/01/2020
!> \details
!
!-----------------------------------------------------------------------

subroutine ocn_init_validate_cosine_bell(configPool, packagePool,iocontext, iErr)!{{{

!--------------------------------------------------------------------

type (mpas_pool_type), intent(inout) :: configPool
type (mpas_pool_type), intent(inout) :: packagePool
type (mpas_io_context_type), intent(inout) :: iocontext

integer, intent(out) :: iErr

character (len=StrKIND), pointer :: config_init_configuration
integer, pointer :: config_vert_levels

iErr = 0

call mpas_pool_get_config(configPool, 'config_init_configuration',config_init_configuration)

if(config_init_configuration .ne. trim('cosine_bell')) return

call mpas_pool_get_config(configPool, 'config_vert_levels',config_vert_levels)

config_vert_levels = 3

!--------------------------------------------------------------------

end subroutine ocn_init_validate_cosine_bell!}}}

!***********************************************************************

end module ocn_init_cosine_bell

!|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
! vim: foldmethod=marker
5 changes: 4 additions & 1 deletion src/core_ocean/mode_init/mpas_ocn_init_mode.F
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ module ocn_init_mode
use ocn_config

use ocn_init_spherical_utils

use ocn_init_cosine_bell
!use ocn_init_TEMPLATE
use ocn_init_baroclinic_channel
use ocn_init_lock_exchange
Expand Down Expand Up @@ -287,6 +287,7 @@ function ocn_init_mode_run(domain) result(iErr)!{{{
call ocn_init_setup_isomip_plus(domain, ierr)
call ocn_init_setup_hurricane(domain, ierr)
call ocn_init_setup_tidal_boundary(domain, ierr)
call ocn_init_setup_cosine_bell(domain, ierr)
!call ocn_init_setup_TEMPLATE(domain, ierr)

call mpas_log_write( ' Completed setup of: ' // trim(config_init_configuration))
Expand Down Expand Up @@ -396,6 +397,8 @@ subroutine ocn_init_mode_validate_configuration(configPool, packagePool, ioconte
iErr = ior(iErr, err_tmp)
call ocn_init_validate_tidal_boundary(configPool, packagePool, iocontext, iErr=err_tmp)
iErr = ior(iErr, err_tmp)
call ocn_init_validate_cosine_bell(configPool, packagePool, iocontext, iErr=err_tmp)
iErr = ior(iErr, err_tmp)
! call ocn_init_validate_TEMPLATE(configPool, packagePool, iocontext, iErr=err_tmp)
! iErr = ior(iErr, err_tmp)
end subroutine ocn_init_mode_validate_configuration!}}}
Expand Down
1 change: 1 addition & 0 deletions src/core_ocean/ocean.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ list(APPEND RAW_SOURCES
core_ocean/mode_init/mpas_ocn_init_isomip_plus.F
core_ocean/mode_init/mpas_ocn_init_tidal_boundary.F
core_ocean/mode_init/mpas_ocn_init_smoothing.F
core_ocean/mode_init/mpas_ocn_init_cosine_bell.F

core_ocean/shared/mpas_ocn_init_routines.F
core_ocean/shared/mpas_ocn_gm.F
Expand Down