H.2.9 Get Value Ortho_Diffusion Functions

The main documentation of the Get Value Ortho_Diffusion Functions contains additional explanation of this code listing.

  define([CHARACTER_ACCESS_ROUTINE],[
    pushdef([VALUE], [$1])
    pushdef([VALUE_Result], expand(VALUE_Result))
    pushdef([Get_CHARACTER_VALUE_Ortho_Diffusion], dnl
             expand(Get_VALUE_Ortho_Diffusion))

    function Get_CHARACTER_VALUE_Ortho_Diffusion (Diff_Term) &
                                                 result(VALUE_Result)
  
      ! Input variables.

      type(Ortho_Diffusion_type), intent(in) :: Diff_Term   ! Diff_Term object.
  
      ! Output variables.
  
      type(character,80) :: VALUE_Result        ! Diff_Term value to be output.
  
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  
      ! Verify requirements.
  
      VERIFY(Valid_State(Diff_Term),5)               ! Diff_Term is valid.
  
      ! Set value.
  
      VALUE_Result = Diff_Term%Value

      ! Verify guarantees - none.
  
      return
    end function Get_CHARACTER_VALUE_Ortho_Diffusion

    popdef([VALUE])
    popdef([VALUE_Result])
    popdef([Get_CHARACTER_VALUE_Ortho_Diffusion])
  ])

  fortext([Value],
          [Locus Name],[
    CHARACTER_ACCESS_ROUTINE(Value)
  ])