from_svd()

from_svd()#

classmethod PODBasis.from_svd(leftvecs: ndarray, svdvals: ndarray, rightvecs: ndarray = None, num_vectors: int = None, svdval_threshold: float = None, residual_energy: float = None, cumulative_energy: float = None, projection_error: float = None, max_vectors: int = None, weights: ndarray = None, name: str = None)[source]#

Initialize a PODBasis from the singular value decomposition of an \(n\times k\) matrix.

Parameters:
leftvecs(n, r) ndarray

Left singular vectors.

svdvals(r,) ndarray

Singular values.

rightvecs(k, r) ndarray or None

Right singular vectors. Each column is a singular vector.

Returns:
Initialized PODBasis object.

Notes

See PODBasis for details on other arguments.