Package _global.tri.oxidationstates.ion

Interface IIonFinder

All Known Implementing Classes:
CompositionIonFinder, KnownIonFinder, OxideIonFinder, ZintlIonFinder
public interface IIonFinder
This is a general interface for all ion finders

  • Method Summary

    Modifier and Type
    Method
    Description
    matsci.structure.Structure
    getFoundPolyatomicIon(int ionNum)
    Return the ionNum'th discovered polyatomic ion
    int
    numFoundPolyatomicIons()
    Returns the total number of found polyatomic ions.

  • Method Details

    • numFoundPolyatomicIons

      int numFoundPolyatomicIons()
      Returns the total number of found polyatomic ions. If more than one ion of the same type is found in a unit cell in different locations, they are all counted as separate found ions.
      Returns:
      the total number of found polyatomic ions. If more than one ion of the same type is found in a unit cell in different locations, they are all counted as separate found ions.

    • getFoundPolyatomicIon

      matsci.structure.Structure getFoundPolyatomicIon(int ionNum)
      Return the ionNum'th discovered polyatomic ion
      Parameters:
      ionNum - The number of the polyatomic ion to return
      Returns:
      the ionNum'th discovered ion