Skip to main content

Model

Base class: Object

Stores the interactions of a lattice Hamiltonian and associated observables in interactions of lattice coordinates and neighbourhoods.

Factories​

model(const Lattice lattice) -> Model​

Constructs a model containing a lattice.

Parameters​

  • lattice: A lattice that is stored inside the model

model(const string filename) -> Model​

Constructs a model from a .lattice_model file.

Parameters​

  • filename: The name of the .lattice_model file.

Constructors​

Model(const Model arg) -> Model​

Copy constructor for a Model.

Parameters​

  • arg: Model to be copied.

Symbols​

NameDescription
=Copy constructor for Model.

Members​

NameDescription
addAdds a coefficient to a model.
add_observableAdd an observable to the model with a given neighbourhood_name.
coefficientsReturns the coefficients in the model.
declare_labelDeclare a label to be registered later in the model
latticeReturns the Lattice in the given model
mpoConverts a Model into a complex representation.
neighbourhood_rulesReturns the neighbourhood rules stored in the model as a map.
observable_to_opsumConverts an observable to an operator sum. Assumes a complex OperatorSum.
observables_to_mpoConverts Model observables into complex MPO representations.
set_coefficientSets the named coefficient to the given value.
unresolved_labelsReturns a list of the unresolved coefficients in the model.