Functions/Subroutines
type(component_descriptor_type) function, public	simplesetup_get_descriptor ()

subroutine	initialisation_callback (current_state)

subroutine	allocate_prognostics (current_state)

subroutine	allocate_prognostic (field, alloc_z, alloc_y, alloc_x, z_grid, y_grid, x_grid)

subroutine	decompose_grid (current_state)

subroutine	create_grid (current_state, specific_grid)

subroutine	read_configuration (current_state)

Variables
integer	x_size

integer	y_size

integer	z_size

real(kind=default_precision)	zztop

real(kind=default_precision)	dxx

real(kind=default_precision)	dyy

logical	enable_theta =.false.

Function/Subroutine Documentation

◆ allocate_prognostic()

subroutine simplesetup_mod::allocate_prognostic	(	type(prognostic_field_type), intent(inout)	field,
		integer, intent(in)	alloc_z,
		integer, intent(in)	alloc_y,
		integer, intent(in)	alloc_x,
		integer, intent(in)	z_grid,
		integer, intent(in)	y_grid,
		integer, intent(in)	x_grid
	)

private

Definition at line 96 of file simplesetup.F90.

     type(prognostic_field_type), intent(inout) :: field
     integer, intent(in) :: alloc_z, alloc_y, alloc_x, z_grid, y_grid, x_grid
 
     field%active=.true.
     field%grid(z_index) = z_grid
     field%grid(y_index) = y_grid
     field%grid(x_index) = x_grid
     allocate(field%data(alloc_z, alloc_y, alloc_x))
     field%data=0.0_default_precision

Here is the caller graph for this function:

◆ allocate_prognostics()

subroutine simplesetup_mod::allocate_prognostics ( type(model_state_type), intent(inout) current_state )

private

Definition at line 46 of file simplesetup.F90.

     type(model_state_type), intent(inout) :: current_state
 
     integer :: alloc_z, alloc_y, alloc_x, i
 
     alloc_z=current_state%local_grid%size(z_index) + current_state%local_grid%halo_size(z_index) * 2
     alloc_y=current_state%local_grid%size(y_index) + current_state%local_grid%halo_size(y_index) * 2
     alloc_x=current_state%local_grid%size(x_index) + current_state%local_grid%halo_size(x_index) * 2
     
 #ifdef U_ACTIVE
     call allocate_prognostic(current_state%u, alloc_z, alloc_y, alloc_x, dual_grid, dual_grid, primal_grid)
     call allocate_prognostic(current_state%zu, alloc_z, alloc_y, alloc_x, dual_grid, dual_grid, primal_grid)
     call allocate_prognostic(current_state%su, alloc_z, alloc_y, alloc_x, dual_grid, dual_grid, primal_grid)
     call allocate_prognostic(current_state%savu, alloc_z, alloc_y, alloc_x, dual_grid, dual_grid, primal_grid)
 #endif
 #ifdef V_ACTIVE
     call allocate_prognostic(current_state%v, alloc_z, alloc_y, alloc_x, dual_grid, primal_grid, dual_grid)
     call allocate_prognostic(current_state%zv, alloc_z, alloc_y, alloc_x, dual_grid, primal_grid, dual_grid)
     call allocate_prognostic(current_state%sv, alloc_z, alloc_y, alloc_x, dual_grid, primal_grid, dual_grid)
     call allocate_prognostic(current_state%savv, alloc_z, alloc_y, alloc_x, dual_grid, primal_grid, dual_grid)
 #endif
 #ifdef W_ACTIVE
     call allocate_prognostic(current_state%w, alloc_z, alloc_y, alloc_x, primal_grid, dual_grid, dual_grid)    
     call allocate_prognostic(current_state%zw, alloc_z, alloc_y, alloc_x, primal_grid, dual_grid, dual_grid)        
     call allocate_prognostic(current_state%sw, alloc_z, alloc_y, alloc_x, primal_grid, dual_grid, dual_grid)        
     call allocate_prognostic(current_state%savw, alloc_z, alloc_y, alloc_x, primal_grid, dual_grid, dual_grid)
 #endif
 
     if (enable_theta) then
       call allocate_prognostic(current_state%th, alloc_z, alloc_y, alloc_x, dual_grid, dual_grid, dual_grid)
       call allocate_prognostic(current_state%zth, alloc_z, alloc_y, alloc_x, dual_grid, dual_grid, dual_grid)
       call allocate_prognostic(current_state%sth, alloc_z, alloc_y, alloc_x, dual_grid, dual_grid, dual_grid)
     end if
     if (current_state%number_q_fields .gt. 0) then
       allocate(current_state%q(current_state%number_q_fields), &
            current_state%zq(current_state%number_q_fields), current_state%sq(current_state%number_q_fields))
       do i=1, current_state%number_q_fields
         call allocate_prognostic(current_state%q(i), alloc_z, alloc_y, alloc_x, dual_grid, dual_grid, dual_grid)
         call allocate_prognostic(current_state%zq(i), alloc_z, alloc_y, alloc_x, dual_grid, dual_grid, dual_grid)
         call allocate_prognostic(current_state%sq(i), alloc_z, alloc_y, alloc_x, dual_grid, dual_grid, dual_grid)
       end do
 
       ! Set standard q indices
       current_state%water_vapour_mixing_ratio_index=get_q_index(standard_q_names%VAPOUR, 'simplesetup')
       current_state%liquid_water_mixing_ratio_index=get_q_index(standard_q_names%CLOUD_LIQUID_MASS, 'simplesetup')
     end if
 
 

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create_grid()

subroutine simplesetup_mod::create_grid	(	type(model_state_type), intent(inout)	current_state,
		type(global_grid_type), intent(inout)	specific_grid
	)

private

Definition at line 118 of file simplesetup.F90.

     type(model_state_type), intent(inout) :: current_state
     type(global_grid_type), intent(inout) :: specific_grid
 
     integer, parameter :: kgd_size=20
     integer :: number_kgd, i, kgd(kgd_size)
     real(kind=DEFAULT_PRECISION) :: hgd(kgd_size)
 
     kgd=-1
 
     call options_get_integer_array(current_state%options_database, "kgd", kgd)
     call options_get_real_array(current_state%options_database, "hgd", hgd)  
 
     if (kgd(1)==1)then
       if (hgd(1)/=0.0_default_precision)then
         call log_log(log_error, "Lowest level is assumed to lie at the surface, check hgd(1)")
       else
         kgd(1:kgd_size-1) = kgd(2:)
         hgd(1:kgd_size-1) = hgd(2:)
       end if
     end if
 
     do i=1,size(kgd)
       if (kgd(i) == -1) exit      
     end do
     number_kgd=i-1
 
     if (number_kgd .gt. 0) then
       allocate(current_state%global_grid%configuration%vertical%kgd(number_kgd), &
            current_state%global_grid%configuration%vertical%hgd(number_kgd))
       current_state%global_grid%configuration%vertical%kgd=kgd(1:number_kgd)
       current_state%global_grid%configuration%vertical%hgd=hgd(1:number_kgd)
     end if
 
     specific_grid%bottom(z_index) = 0
     specific_grid%bottom(y_index) = 0
     specific_grid%bottom(x_index) = 0
 
     specific_grid%top(z_index) = zztop
     specific_grid%top(y_index) = dyy * y_size
     specific_grid%top(x_index) = dxx * x_size
 
     specific_grid%resolution(z_index) = zztop / z_size
     specific_grid%resolution(y_index) = dyy
     specific_grid%resolution(x_index) = dxx
 
     specific_grid%size(z_index) = z_size
     specific_grid%size(y_index) = y_size
     specific_grid%size(x_index) = x_size
 
     specific_grid%active(z_index) = .true.
     specific_grid%active(y_index) = .true.
     specific_grid%active(x_index) = .true.
 
     specific_grid%dimensions = 3

Here is the caller graph for this function:

◆ decompose_grid()

subroutine simplesetup_mod::decompose_grid ( type(model_state_type), intent(inout) current_state )

private

Definition at line 108 of file simplesetup.F90.

     type(model_state_type), intent(inout) :: current_state
 
     if (associated(current_state%parallel%decomposition_procedure)) then
       call current_state%parallel%decomposition_procedure(current_state)
     else
       call log_log(log_error, "No decomposition specified")
     end if

Here is the caller graph for this function:

◆ initialisation_callback()

subroutine simplesetup_mod::initialisation_callback ( type(model_state_type), intent(inout), target current_state )

private

Definition at line 30 of file simplesetup.F90.

     type(model_state_type), intent(inout), target :: current_state
 
     call read_configuration(current_state)
     if (.not. current_state%initialised) then
       current_state%dtm=options_get_real(current_state%options_database, "dtm")
       current_state%dtm_new=current_state%dtm
       call create_grid(current_state, current_state%global_grid)
       call decompose_grid(current_state)
       call allocate_prognostics(current_state)
       current_state%initialised=.true.
 
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read_configuration()

subroutine simplesetup_mod::read_configuration ( type(model_state_type), intent(inout), target current_state )

private

Definition at line 175 of file simplesetup.F90.

     type(model_state_type), intent(inout), target :: current_state
 
     current_state%rhobous=options_get_real(current_state%options_database, "rhobous")
     current_state%thref0=options_get_real(current_state%options_database, "thref0")
     current_state%number_q_fields=options_get_integer(current_state%options_database, "number_q_fields")
     current_state%surface_pressure=options_get_real(current_state%options_database, "surface_pressure")
     current_state%surface_reference_pressure=options_get_real(current_state%options_database, "surface_reference_pressure")
 
     current_state%use_anelastic_equations=options_get_logical(current_state%options_database, "use_anelastic_equations")
 
     current_state%origional_vertical_grid_setup=options_get_logical(current_state%options_database, &
          "origional_vertical_grid_setup")
     current_state%passive_q=options_get_logical(current_state%options_database, "passive_q")
     current_state%passive_th=options_get_logical(current_state%options_database, "passive_th")
     current_state%rmlmax=options_get_real(current_state%options_database, "rmlmax")
     current_state%calculate_th_and_q_init=options_get_logical(current_state%options_database, "calculate_th_and_q_init")
     current_state%use_viscosity_and_diffusion=options_get_logical(current_state%options_database, "use_viscosity_and_diffusion")
     current_state%backscatter=options_get_logical(current_state%options_database, "backscatter")
 
     x_size=options_get_integer(current_state%options_database, "x_size")
     y_size=options_get_integer(current_state%options_database, "y_size")
     z_size=options_get_integer(current_state%options_database, "z_size")
     dxx=options_get_real(current_state%options_database, "dxx")
     dyy=options_get_real(current_state%options_database, "dyy")
     zztop=options_get_real(current_state%options_database, "zztop")
     enable_theta=options_get_logical(current_state%options_database, "enable_theta")
 
     if (current_state%rmlmax<=0.0)current_state%rmlmax=0.23 * max(dxx, dyy)
 
     if (.not. enable_theta) current_state%passive_th=.true.
     if ( current_state%number_q_fields == 0) current_state%passive_q=.true.
 
     current_state%galilean_transformation=options_get_logical(current_state%options_database, "galilean_transformation")
     if (current_state%galilean_transformation)then
       current_state%fix_ugal=options_get_logical(current_state%options_database, "fix_ugal")
       current_state%fix_vgal=options_get_logical(current_state%options_database, "fix_vgal")
       if (current_state%fix_ugal)current_state%ugal=options_get_real(current_state%options_database, "ugal")
       if (current_state%fix_vgal)current_state%vgal=options_get_real(current_state%options_database, "vgal")
     end if
 

Here is the caller graph for this function:

◆ simplesetup_get_descriptor()

type(component_descriptor_type) function, public simplesetup_mod::simplesetup_get_descriptor ( )

Definition at line 24 of file simplesetup.F90.

     simplesetup_get_descriptor%name="simplesetup"
     simplesetup_get_descriptor%version=0.1
     simplesetup_get_descriptor%initialisation=>initialisation_callback

Here is the call graph for this function:

Variable Documentation

◆ dxx

real(kind=default_precision) simplesetup_mod::dxx

private

Definition at line 18 of file simplesetup.F90.

◆ dyy

real(kind=default_precision) simplesetup_mod::dyy

private

Definition at line 18 of file simplesetup.F90.

◆ enable_theta

logical simplesetup_mod::enable_theta =.false.

private

Definition at line 19 of file simplesetup.F90.

19 logical :: enable_theta=.false.

◆ x_size

integer simplesetup_mod::x_size

private

Definition at line 17 of file simplesetup.F90.

17 integer :: x_size, y_size, z_size

◆ y_size

integer simplesetup_mod::y_size

private

Definition at line 17 of file simplesetup.F90.

◆ z_size

integer simplesetup_mod::z_size

private

Definition at line 17 of file simplesetup.F90.

◆ zztop

real(kind=default_precision) simplesetup_mod::zztop

private

Definition at line 18 of file simplesetup.F90.

18 real(kind=DEFAULT_PRECISION) :: zztop, dxx, dyy

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ allocate_prognostic()

◆ allocate_prognostics()

◆ create_grid()

◆ decompose_grid()

◆ initialisation_callback()

◆ read_configuration()

◆ simplesetup_get_descriptor()

Variable Documentation

◆ dxx

◆ dyy

◆ enable_theta

◆ x_size

◆ y_size

◆ z_size

◆ zztop