one_equation_salt Function

private function one_equation_salt(this) result(salt)

Arguments

Type IntentOptional AttributesName
class(one_equation_melt), intent(in) :: this

Return Value class(scalar_field), pointer

The value of the contribution made by melting/thermal transfer to the salt equation for a plume


Contents

Source Code


Source Code

  function one_equation_salt(this) result(salt)
    class(one_equation_melt), intent(in) :: this
    class(scalar_field), pointer         :: salt
      !! The value of the contribution made by melting/thermal
      !! transfer to the salt equation for a [[plume]]
    if (.not. allocated(this%forcing_values) .and. this%sal_forcing /= 0._r8) then
      error stop ('Melt values not calculated')
    end if
    salt => this%sal_forcing * this%forcing_values
  end function one_equation_salt