get_z_damping Subroutine

public subroutine get_z_damping(param, method, error, s9, citation)

Load Z damping parameters from internal storage

Arguments

Type IntentOptional Attributes Name
type(d3_param), intent(out) :: param

Loaded parameter record

character(len=*), intent(in) :: method

Name of the method to look up

type(error_type), intent(out), allocatable :: error

Error handling

real(kind=wp), intent(in), optional :: s9

Overwrite s9

type(citation_type), intent(out), optional :: citation

Citation information


Source Code

subroutine get_z_damping(param, method, error, s9, citation)

   !> Loaded parameter record
   type(d3_param), intent(out) :: param

   !> Name of the method to look up
   character(len=*), intent(in) :: method

   !> Overwrite s9
   real(wp), intent(in), optional :: s9

   !> Citation information
   type(citation_type), intent(out), optional :: citation

   !> Error handling
   type(error_type), allocatable, intent(out) :: error

   select case(get_method_id(method))
   case default
      call fatal_error(error, "No entry for '"//method//"' present")
      return
   end select

   if (present(citation)) citation = get_citation(doi_z_damping)

   if (present(s9)) then
      param%s9 = s9
   end if

end subroutine get_z_damping