petsc_vector.py

Define the PETSc Vector classe.

class openmdao.vectors.petsc_vector.PETScVector(name, kind, system, root_vector=None, resize=False, alloc_complex=False, ncol=1, relevant=None)[source]

Bases: openmdao.vectors.default_vector.DefaultVector

PETSc Vector implementation for running in parallel.

Most methods use the DefaultVector’s implementation.

TRANSFER

alias of openmdao.vectors.petsc_transfer.PETScTransfer

__contains__(self, name)

Check if the variable is involved in the current mat-vec product.

Parameters
namestr

Promoted or relative variable name in the owning system’s namespace.

Returns
boolean

True or False.

__getitem__(self, name)

Get the variable value.

Parameters
namestr

Promoted or relative variable name in the owning system’s namespace.

Returns
float or ndarray

variable value.

__init__(self, name, kind, system, root_vector=None, resize=False, alloc_complex=False, ncol=1, relevant=None)[source]

Initialize all attributes.

Parameters
namestr

The name of the vector: ‘nonlinear’, ‘linear’, or right-hand side name.

kindstr

The kind of vector, ‘input’, ‘output’, or ‘residual’.

system<System>

Pointer to the owning system.

root_vector<Vector>

Pointer to the vector owned by the root system.

resizebool

If true, resize the root vector.

alloc_complexbool

Whether to allocate any imaginary storage to perform complex step. Default is False.

ncolint

Number of columns for multi-vectors.

relevantdict

Mapping of a VOI to a tuple containing dependent inputs, dependent outputs, and dependent systems.

__iter__(self)

Yield an iterator over variables involved in the current mat-vec product (relative names).

Returns
listiterator

iterator over the variable names.

__setitem__(self, name, value)

Set the variable value.

Parameters
namestr

Promoted or relative variable name in the owning system’s namespace.

valuefloat or list or tuple or ndarray

variable value to set

add_scal_vec(self, val, vec)

Perform in-place addition of a vector times a scalar.

Parameters
valint or float

scalar.

vec<Vector>

this vector times val is added to self.

cite = '@InProceedings{petsc-efficient,\n Author = "Satish Balay and William D. Gropp and Lois Curfman McInnes and Barry F. Smith",\n Title = "Efficient Management of Parallelism in Object Oriented Numerical Software Libraries",\n Booktitle = "Modern Software Tools in Scientific Computing",\n Editor = "E. Arge and A. M. Bruaset and H. P. Langtangen",\n Pages = "163--202",\n Publisher = "Birkh{"{a}}user Press",\n Year = "1997"\n}'
dot(self, vec)[source]

Compute the dot product of the real parts of the current vec and the incoming vec.

Parameters
vec<Vector>

The incoming vector being dotted with self.

Returns
float

The computed dot product value.

get_norm(self)[source]

Return the norm of this vector.

Returns
float

norm of this vector.

get_slice_dict(self)

Return a dict of var names mapped to their slice in the local data array.

Returns
dict

Mapping of var name to slice.

keys(self)

Return variable names of variables contained in this vector (relative names).

Returns
listiterator (Python 3.x) or list (Python 2.x)

the variable names.

scale(self, scale_to)

Scale this vector to normalized or physical form.

Parameters
scale_tostr

Values are “phys” or “norm” to scale to physical or normalized.

set_complex_step_mode(self, active, keep_real=False)

Turn on or off complex stepping mode.

When turned on, the default real ndarray is replaced with a complex ndarray and all pointers are updated to point to it.

Parameters
activebool

Complex mode flag; set to True prior to commencing complex step.

keep_realbool

When this flag is True, keep the real value when turning off complex step. You only need to do this when temporarily disabling complex step for guess_nonlinear.

set_const(self, val)

Set the value of this vector to a constant scalar value.

Parameters
valint or float

scalar to set self to.

set_vec(self, vec)

Set the value of this vector to that of the incoming vector.

Parameters
vec<Vector>

the vector whose values self is set to.

values(self)

Return values of variables contained in this vector.

Returns
list

the variable values.