pymor.vectorarrays.block

Module Contents

class pymor.vectorarrays.block.BlockVectorArray(space, impl, base=None, ind=None, _len=None)

Bases: pymor.vectorarrays.interface.VectorArray

VectorArray where each vector is a direct sum of sub-vectors.

Given a list of equal length VectorArrays blocks, this VectorArray represents the direct sums of the vectors contained in the arrays. The associated VectorSpace is BlockVectorSpace.

BlockVectorArray can be used in conjunction with BlockOperator.

Methods

block	Return a copy of a single block or a sequence of blocks.
blocks
num_blocks

impl_type

block(ind)

Return a copy of a single block or a sequence of blocks.

property blocks

property num_blocks

class pymor.vectorarrays.block.BlockVectorArrayImpl(blocks, space)

Bases: pymor.vectorarrays.interface.VectorArrayImpl

Implementation of a VectorArray.

The VectorArray base class defers all calls to interface methods to an internal impl object of this type. Indexing, error checking or non-standard inner products are handled by VectorArray. Possible indices are passed to the methods of VectorArrayImpl as ind, oind or xind parameters. These can either be None, in case the array has not been indexed, a slice object, or a Python list of non-negative numbers.

Methods

amax
append
axpy
axpy_copy
conj
copy
delete
dofs
imag
inner
lincomb
norm2
pairwise_inner
real
scal
scal_copy
to_numpy

amax(ind)

append(other, remove_from_other, oind)

axpy(alpha, x, ind, xind)

axpy_copy(alpha, x, ind, xind)

conj(ind)

copy(deep, ind)

delete(ind)

dofs(dof_indices, ind)

imag(ind)

inner(other, ind, oind)

lincomb(coefficients, ind)

norm2(ind)

pairwise_inner(other, ind, oind)

real(ind)

scal(alpha, ind)

scal_copy(alpha, ind)

to_numpy(ensure_copy, ind)

class pymor.vectorarrays.block.BlockVectorSpace(subspaces)

Bases: pymor.vectorarrays.interface.VectorSpace

VectorSpace of BlockVectorArrays.

A BlockVectorSpace is defined by the VectorSpaces of the individual subblocks which constitute a given array. In particular for a given :class`BlockVectorArray` U, we have the identity

(U.blocks[0].space, U.blocks[1].space, ..., U.blocks[-1].space) == U.space.

Parameters

subspaces

The tuple defined above.

Methods

dim
from_numpy	Create a VectorArray from a NumPy array
make_array	Create a VectorArray from raw data.
make_block_diagonal_array
zeros	Create a VectorArray of null vectors

property dim

from_numpy(data, ensure_copy=False)

Create a VectorArray from a NumPy array

Note that this method will not be supported by all vector space implementations.

Parameters

data

NumPy array of shape (len, dim) where len is the number of vectors and dim their dimension.

ensure_copy

If False, modifying the returned VectorArray might alter the original NumPy array. If True always a copy of the array data is made.

Returns

A VectorArray with data as data.

make_array(obj)

Create a VectorArray from raw data.

This method is used in the implementation of Operators and Models to create new VectorArrays from raw data of the underlying solver backends. The ownership of the data is transferred to the newly created array.

The exact signature of this method depends on the wrapped solver backend.

make_block_diagonal_array(obj)

zeros(count=1, reserve=0)

Create a VectorArray of null vectors

Parameters

count

The number of vectors.

reserve

Hint for the backend to which length the array will grow.

Returns

A VectorArray containing count vectors with each component zero.