isothermfactorymodule Module Reference

Functions/Subroutines
class(isothermtype) function, pointer, public	create_isotherm (isotherm_type, distcoef, sp2)
	Create an isotherm object based on type and parameters. More...

Function/Subroutine Documentation

create_isotherm()

class(isothermtype) function, pointer, public isothermfactorymodule::create_isotherm	(	integer(i4b), intent(in)	isotherm_type,
		real(dp), dimension(:), pointer, contiguous	distcoef,
		real(dp), dimension(:), pointer, contiguous	sp2
	)

Returns a pointer to a concrete IsothermType (or null() if sorption is off). Uses isotherm_type to select Linear, Freundlich, or Langmuir, passing distcoef and sp2 as required by the chosen model.

Returns

allocated concrete isotherm or null()

Parameters

[in]	isotherm_type	enumerator from IsothermEnumModule
	distcoef	primary coefficient (Kd, Kf, or Kl)
	sp2	secondary parameter (a for Freundlich, Sbar for Langmuir)

Definition at line 24 of file IsothermFactory.f90.

    ! -- result
    class(IsothermType), pointer :: isotherm !< allocated concrete isotherm or null()
    ! -- dummy
    integer(I4B), intent(in) :: isotherm_type !< enumerator from `IsothermEnumModule`
    real(DP), dimension(:), pointer, contiguous :: distcoef !< primary coefficient (Kd, Kf, or Kl)
    real(DP), dimension(:), pointer, contiguous :: sp2 !< secondary parameter (a for Freundlich, Sbar for Langmuir)
 
    select case (isotherm_type)
    case (sorption_off)
      nullify (isotherm)
    case (sorption_linear)
      allocate (isotherm, source=linearisothermtype(distcoef))
    case (sorption_freund)
      allocate (isotherm, source=freundlichisothermtype(distcoef, sp2))
    case (sorption_lang)
      allocate (isotherm, source=langmuirisothermtype(distcoef, sp2))
    case default
      call store_error('Sorption type not implemented.')
    end select
 

Here is the call graph for this function:

Here is the caller graph for this function: