desc.equilibrium.EquilibriaFamily
- class desc.equilibrium.EquilibriaFamily(*args)Source
EquilibriaFamily stores a list of Equilibria.
Has methods for solving complex equilibria using a multi-grid continuation method.
- Parameters:
args (Equilibrium, dict or list of dict) –
Should be either:
An Equilibrium (or several)
A dictionary of inputs (or several) to create a equilibria
A single list of dictionaries, one for each equilibrium in a continuation.
Nothing, to create an empty family.
For more information see inputs required by
'Equilibrium'
.
Methods
append
(value)S.append(value) -- append value to the end of the sequence
clear
()copy
([deepcopy])Return a (deep)copy of this object.
count
(value)equiv
(other)Compare equivalence between DESC objects.
extend
(values)S.extend(iterable) -- extend sequence by appending elements from the iterable
index
(value, [start, [stop]])Raises ValueError if the value is not present.
insert
(i, new_item)Insert a new Equilibrium into the family at position i.
load
(load_from[, file_format])Initialize from file.
pop
([index])Raise IndexError if list is empty or index is out of range.
remove
(value)S.remove(value) -- remove first occurrence of value.
reverse
()S.reverse() -- reverse IN PLACE
save
(file_name[, file_format, file_mode])Save the object.
solve_continuation
([objective, optimizer, ...])Solve for an equilibrium by continuation method.
solve_continuation_automatic
(eq[, ...])Solve for an equilibrium using an automatic continuation method.
Attributes
Equilibria contained in the family.