sisl.mixing.BaseHistoryWeightMixer

class sisl.mixing.BaseHistoryWeightMixer(weight: float | int = 0.2, history: int | History = 0)

Bases: BaseWeightMixer

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

Parameters:

• weight (TypeWeight)

• history (TypeArgHistory)

__call__(f: T, df: T, *args: Any, append: bool = True) → None

Append data to the history (omitting None values)!

Parameters:

• f (T)

• df (T)

• args (Any)

• append (bool)

Return type:

None

__init__(weight: float | int = 0.2, history: int | History = 0)

Parameters:

• weight (float | int)

• history (int | History)

property history: History

History object tracked by this mixer

set_history(history: int | History) → None

Replace the current history in the mixer with a new one

Parameters:

history (int | 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.

Return type:

None

set_weight(weight: float | int)

Set a new weight for this mixer

Parameters:

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

property weight: float | int

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