damping_mod Module Reference

Damping applied to the W field at some point to stop stuff flying up and off. More...

Functions/Subroutines
type(component_descriptor_type) function, public	damping_get_descriptor ()
	Descriptor of this component for registration. More...
subroutine	init_callback (current_state)
	On initialisation will set up data structures and field values. More...
subroutine	timestep_callback (current_state)
	For each data column will calculate the damping term and apply this to the source term for that field. More...

Variables
real(kind=default_precision)	dmptim
	Layer timescale. More...
real(kind=default_precision)	zdmp
	The point (m) where the damping starts. More...
real(kind=default_precision)	hdmp
	The height (m) of the damping layer. More...

Detailed Description

Damping applied to the W field at some point to stop stuff flying up and off.

Function/Subroutine Documentation

damping_get_descriptor()

type(component_descriptor_type) function, public damping_mod::damping_get_descriptor

(

)

Descriptor of this component for registration.

Returns

The damping component descriptor

Definition at line 28 of file damping.F90.

    damping_get_descriptor%name="damping"
    damping_get_descriptor%version=0.1
    damping_get_descriptor%initialisation=>init_callback
    damping_get_descriptor%timestep=>timestep_callback

Here is the call graph for this function:

init_callback()

subroutine damping_mod::init_callback ( type(model_state_type), intent(inout), target  current_state )

private

On initialisation will set up data structures and field values.

Parameters

current_state

The current model state_mod

Definition at line 37 of file damping.F90.

    type(model_state_type), target, intent(inout) :: current_state

    integer :: k

    if (.not. is_component_enabled(current_state%options_database, "mean_profiles")) then
      call log_master_log(log_error, "Damping requires the mean profiles component to be enabled")
    end if    

    dmptim=options_get_real(current_state%options_database, "dmptim")
    zdmp=options_get_real(current_state%options_database, "zdmp")
    hdmp=options_get_real(current_state%options_database, "hdmp")

    allocate(current_state%global_grid%configuration%vertical%dmpco(current_state%local_grid%size(z_index)), &
         current_state%global_grid%configuration%vertical%dmpcoz(current_state%local_grid%size(z_index)))
    current_state%global_grid%configuration%vertical%dmpco(:)=0.
    current_state%global_grid%configuration%vertical%dmpcoz(:)=0.
    do k=current_state%local_grid%size(z_index),1,-1
      current_state%global_grid%configuration%vertical%kdmpmin=k
      if (current_state%global_grid%configuration%vertical%zn(k) .ge. zdmp) then
        current_state%global_grid%configuration%vertical%dmpco(k)=dmptim*(exp((&
             current_state%global_grid%configuration%vertical%zn(k)-zdmp)/hdmp)-1.0)
      end if
      if (current_state%global_grid%configuration%vertical%z(k) .ge. zdmp) then
        current_state%global_grid%configuration%vertical%dmpcoz(k)=dmptim*(exp((&
             current_state%global_grid%configuration%vertical%z(k)-zdmp)/hdmp)-1.0)
      end if
      if(current_state%global_grid%configuration%vertical%zn(k).lt. zdmp) exit
    end do

Here is the caller graph for this function:

timestep_callback()

subroutine damping_mod::timestep_callback ( type(model_state_type), intent(inout), target  current_state )

private

For each data column will calculate the damping term and apply this to the source term for that field.

Parameters

current_state

The current model state_mod

Definition at line 70 of file damping.F90.

    type(model_state_type), target, intent(inout) :: current_state

    integer :: k, i

    if (current_state%halo_column .and. current_state%timestep <3) return
    
    do k=current_state%global_grid%configuration%vertical%kdmpmin,current_state%local_grid%size(z_index)
#ifdef U_ACTIVE
      current_state%su%data(k, current_state%column_local_y, current_state%column_local_x)=current_state%su%data(k, &
           current_state%column_local_y, current_state%column_local_x)-&
           current_state%global_grid%configuration%vertical%dmpco(k)*(current_state%zu%data(k, current_state%column_local_y, &
           current_state%column_local_x)- (current_state%global_grid%configuration%vertical%olzubar(k)-current_state%ugal))
#endif
#ifdef V_ACTIVE
      current_state%sv%data(k, current_state%column_local_y, current_state%column_local_x)=current_state%sv%data(k, &
           current_state%column_local_y, current_state%column_local_x)-&
           current_state%global_grid%configuration%vertical%dmpco(k)*(current_state%zv%data(k, current_state%column_local_y, &
           current_state%column_local_x)-(current_state%global_grid%configuration%vertical%olzvbar(k)-current_state%vgal))
#endif
      if (current_state%th%active) then
        current_state%sth%data(k, current_state%column_local_y, current_state%column_local_x)=current_state%sth%data(k, &
             current_state%column_local_y, current_state%column_local_x)-&
             current_state%global_grid%configuration%vertical%dmpco(k)*(current_state%zth%data(k, current_state%column_local_y, &
             current_state%column_local_x)-current_state%global_grid%configuration%vertical%olzthbar(k))
      end if
      
      do i=1,current_state%number_q_fields
        if (current_state%q(i)%active) then
          current_state%sq(i)%data(k, current_state%column_local_y, current_state%column_local_x)=current_state%sq(i)%data(k, &
               current_state%column_local_y, current_state%column_local_x)-&
               current_state%global_grid%configuration%vertical%dmpco(k)*&
               (current_state%zq(i)%data(k, current_state%column_local_y, current_state%column_local_x)-&
               current_state%global_grid%configuration%vertical%olzqbar(k,i))
        end if
      end do
    end do
#ifdef W_ACTIVE
    do k=current_state%global_grid%configuration%vertical%kdmpmin,current_state%local_grid%size(z_index)-1    
      current_state%sw%data(k, current_state%column_local_y, current_state%column_local_x)=current_state%sw%data(k, &
           current_state%column_local_y, current_state%column_local_x)-&
           current_state%global_grid%configuration%vertical%dmpcoz(k)*&
           current_state%zw%data(k, current_state%column_local_y, current_state%column_local_x)
    end do
#endif

Here is the caller graph for this function:

Variable Documentation

dmptim

real(kind=default_precision) damping_mod::dmptim

private

Layer timescale.

Definition at line 17 of file damping.F90.

  real(kind=DEFAULT_PRECISION) :: dmptim,& !< Layer timescale
       zdmp,& !< The point (m) where the damping starts
       hdmp

hdmp

real(kind=default_precision) damping_mod::hdmp

private

The height (m) of the damping layer.

Definition at line 17 of file damping.F90.

zdmp

real(kind=default_precision) damping_mod::zdmp

private

The point (m) where the damping starts.

Definition at line 17 of file damping.F90.