species_require_index Function

public function species_require_index(names, nspecies, target, owner) result(idx)

Searches for a target name and returns its index, or halts simulation with a fatal error if not found.

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: names(:)
integer, intent(in) :: nspecies

Size of the names array.
character(len=*), intent(in) :: target

The target name to require.
character(len=*), intent(in) :: owner

The calling subsystem module name for traceback.

Return Value integer


Source Code

   integer function species_require_index(names, nspecies, target, owner) result(idx)
      character(len=*), intent(in) :: names(:) !< Array of species names.
      integer, intent(in) :: nspecies          !< Number of species.
      character(len=*), intent(in) :: target   !< Target name to search.
      character(len=*), intent(in) :: owner    !< Subsystem name for error traceback.

      idx = species_index_of(names, nspecies, target)
      if (idx <= 0) then
         call fatal_error(trim(owner), 'unknown species name "'//trim(target)//'"')
      end if
   end function species_require_index