Interface UpdateScope

  • All Known Implementing Classes:
    DependentUpdate, IndependentUpdate, SemiDependentUpdate

    public interface UpdateScope
    The Update Scope determines the modules dependence on the rest of the simulation. The scope then determines half concentration storage behaviour used during numerical calculation and in which order deltas are computed.
    Author:
    cl
    • Method Detail

      • processAllUpdatables

        void processAllUpdatables​(Collection<? extends Updatable> updatables)
        Processes all given updatables. This includes calculating the delta functions of the corresponding module, calculating the current numerical error and pushing potential Deltas to the updatables, ready to be applied.
        Parameters:
        updatables - The updatables to be processed.
      • processUpdatable

        void processUpdatable​(Updatable updatable)
        Calculates the given updatable. If it is required to calculate other updatables to evaluate the state of this updatable this will be done depending on the implementation of the scope.
        Parameters:
        updatable - The updatable.
      • clearPotentialDeltas

        void clearPotentialDeltas()
        Clears all concentration deltas that may be assigned by this module
      • getHalfStepConcentration

        ConcentrationContainer getHalfStepConcentration​(Updatable updatable)
        Return the half step concentration of a node after the full update has been calculated for the full step and the resulting delta is known.
        Parameters:
        updatable - The updatable.
        Returns:
        A concentration container with the concentrations at the half time step.