InnerProduct

About the InnerProduct class

The WaveBlocks Project

@author: R. Bourquin @copyright: Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015, 2016 R. Bourquin @license: Modified BSD License

Inheritance diagram

Inheritance diagram of InnerProduct

Class documentation

class WaveBlocksND.InnerProduct[source]

This class is an abstract interface to inner products in general.

build_matrix()[source]

Calculate the matrix elements of \langle\Psi|f|\Psi\rangle for a general function f(x) with x \in \mathbb{R}^D. Note that the arguments may vary through subclasses!

Raise:NotImplementedError Abstract interface.
get_delegate()[source]

Return the Quadrature subclass instance used for evaluation of this inner product.

Returns:The current instance of the quadrature.
get_description()[source]

Return a description of this inner product object. A description is a dict containing all key-value pairs necessary to reconstruct the current instance. A description never contains any data.

quadrature()[source]

Performs the quadrature of \langle\Psi|f|\Psi\rangle for a general function f(x) with x \in \mathbb{R}^D. Note that the arguments may vary through subclasses!

Raise:NotImplementedError Abstract interface.
set_delegate(delegate)[source]

Set the Quadrature subclass instance used for quadrature.

Parameters:delegate – The new Quadrature instance.
class WaveBlocksND.InnerProductException[source]

Exception to raise in case an inner product fails for whatever reason.