registry_require_index Function

private function registry_require_index(this, target, owner) result(idx)

Bound procedure to find the index of a species, raising a fatal error if it is missing.

Type Bound

species_registry_t

Arguments

Type IntentOptional Attributes Name
class(species_registry_t), intent(in) :: this

The species registry instance.
character(len=*), intent(in) :: target

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

The calling subsystem module name.

Return Value integer


Source Code

   integer function registry_require_index(this, target, owner) result(idx)
      class(species_registry_t), intent(in) :: this !< Registry object context.
      character(len=*), intent(in) :: target        !< Target species name.
      character(len=*), intent(in) :: owner         !< Subsystem name for traceback.
      if (.not. allocated(this%name)) then
         call fatal_error(trim(owner), 'species registry is not initialized')
      end if
      idx = species_require_index(this%name, this%nspecies, target, owner)
   end function registry_require_index