sisl.mixing.BaseHistoryMixer

class sisl.mixing.BaseHistoryMixer(weight=0.2, history=0)

Bases: BaseMixer

Base class mixer with history

Methods

set_history(history)

Replace the current history in the mixer with a new one

set_weight(weight)

Set a new weight for this mixer

history

History object tracked by this mixer

weight

This mixers mixing weight, the weight is the fractional contribution of the derivative

__init__(weight=0.2, history=0)[source]
property history

History object tracked by this mixer

set_history(history)[source]

Replace the current history in the mixer with a new one

Parameters

history (int or History) – if an int a new History object will be created with that number of history elements Otherwise the object will be directly attached to the mixer.

set_weight(weight)

Set a new weight for this mixer

Parameters

weight (float) – the new weight for this mixer, it must be bigger than 0

property weight

This mixers mixing weight, the weight is the fractional contribution of the derivative