PyTrilinos::NOX::Abstract::MultiVector Class Reference

Inheritance diagram for PyTrilinos::NOX::Abstract::MultiVector:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::NOX::Abstract::MultiVector:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def init
def random
def setBlock
def augment
def scale
def update
def clone
def subCopy
def subView
def norm
def multiply
def length
def numVectors
def __init__
def init
def random
def setBlock
def augment
def scale
def update
def clone
def subCopy
def subView
def norm
def multiply
def length
def numVectors


Detailed Description

Abstract interface for multi-vectors used by NOX.

C++ includes: NOX_Abstract_MultiVector.H 

Member Function Documentation

def PyTrilinos::NOX::Abstract::MultiVector::augment (   self,
  args 
)

augment(self, MultiVector source) -> MultiVector

virtual
NOX::Abstract::MultiVector& NOX::Abstract::MultiVector::augment(const
NOX::Abstract::MultiVector &source)=0

Append the vectors in source to *this. 

def PyTrilinos::NOX::Abstract::MultiVector::augment (   self,
  args 
)

augment(self, MultiVector source) -> MultiVector

virtual
NOX::Abstract::MultiVector& NOX::Abstract::MultiVector::augment(const
NOX::Abstract::MultiVector &source)=0

Append the vectors in source to *this. 

def PyTrilinos::NOX::Abstract::MultiVector::clone (   self,
  args 
)

clone(self, CopyType type = DeepCopy) -> Teuchos::RCP<(NOX::Abstract::MultiVector)>

virtual
Teuchos::RCP<NOX::Abstract::MultiVector>
NOX::Abstract::MultiVector::clone(int numvecs) const =0

Creates a new multi-vector with numvecs columns. 

def PyTrilinos::NOX::Abstract::MultiVector::clone (   self,
  args 
)

clone(self, CopyType type = DeepCopy) -> Teuchos::RCP<(NOX::Abstract::MultiVector)>

virtual
Teuchos::RCP<NOX::Abstract::MultiVector>
NOX::Abstract::MultiVector::clone(int numvecs) const =0

Creates a new multi-vector with numvecs columns. 

def PyTrilinos::NOX::Abstract::MultiVector::init (   self,
  args 
)

init(self, double gamma) -> MultiVector

virtual
NOX::Abstract::MultiVector& NOX::Abstract::MultiVector::init(double
gamma)=0

Initialize every element of this multi-vector with gamma. 

def PyTrilinos::NOX::Abstract::MultiVector::init (   self,
  args 
)

init(self, double gamma) -> MultiVector

virtual
NOX::Abstract::MultiVector& NOX::Abstract::MultiVector::init(double
gamma)=0

Initialize every element of this multi-vector with gamma. 

def PyTrilinos::NOX::Abstract::MultiVector::length (   self,
  args 
)

length(self) -> int

virtual
int NOX::Abstract::MultiVector::length() const =0

Return the length of multi-vector. 

def PyTrilinos::NOX::Abstract::MultiVector::length (   self,
  args 
)

length(self) -> int

virtual
int NOX::Abstract::MultiVector::length() const =0

Return the length of multi-vector. 

def PyTrilinos::NOX::Abstract::MultiVector::multiply (   self,
  args 
)

multiply(self, double alpha, MultiVector y, DenseMatrix b)

virtual
void NOX::Abstract::MultiVector::multiply(double alpha, const
NOX::Abstract::MultiVector &y, DenseMatrix &b) const =0

Computes the matrix-matrix product $\\alpha * y^T * (*this)$. 

def PyTrilinos::NOX::Abstract::MultiVector::multiply (   self,
  args 
)

multiply(self, double alpha, MultiVector y, DenseMatrix b)

virtual
void NOX::Abstract::MultiVector::multiply(double alpha, const
NOX::Abstract::MultiVector &y, DenseMatrix &b) const =0

Computes the matrix-matrix product $\\alpha * y^T * (*this)$. 

def PyTrilinos::NOX::Abstract::MultiVector::norm (   self,
  args 
)

norm(self, vector<(double)> result, NormType type = TwoNorm)

virtual void
NOX::Abstract::MultiVector::norm(vector< double > &result,
NOX::Abstract::Vector::NormType type=NOX::Abstract::Vector::TwoNorm)
const =0

Norm. 

def PyTrilinos::NOX::Abstract::MultiVector::norm (   self,
  args 
)

norm(self, vector<(double)> result, NormType type = TwoNorm)

virtual void
NOX::Abstract::MultiVector::norm(vector< double > &result,
NOX::Abstract::Vector::NormType type=NOX::Abstract::Vector::TwoNorm)
const =0

Norm. 

def PyTrilinos::NOX::Abstract::MultiVector::numVectors (   self,
  args 
)

numVectors(self) -> int

virtual int NOX::Abstract::MultiVector::numVectors() const =0

Return the number of vectors in the multi-vector. 

def PyTrilinos::NOX::Abstract::MultiVector::numVectors (   self,
  args 
)

numVectors(self) -> int

virtual int NOX::Abstract::MultiVector::numVectors() const =0

Return the number of vectors in the multi-vector. 

def PyTrilinos::NOX::Abstract::MultiVector::random (   self,
  args 
)

random(self, bool useSeed = False, int seed = 1) -> MultiVector

virtual
NOX::Abstract::MultiVector& NOX::Abstract::MultiVector::random(bool
useSeed=false, int seed=1)=0

Initialize each element of this multi-vector with a random value. 

def PyTrilinos::NOX::Abstract::MultiVector::random (   self,
  args 
)

random(self, bool useSeed = False, int seed = 1) -> MultiVector

virtual
NOX::Abstract::MultiVector& NOX::Abstract::MultiVector::random(bool
useSeed=false, int seed=1)=0

Initialize each element of this multi-vector with a random value. 

def PyTrilinos::NOX::Abstract::MultiVector::scale (   self,
  args 
)

scale(self, double gamma) -> MultiVector

virtual
NOX::Abstract::MultiVector& NOX::Abstract::MultiVector::scale(double
gamma)=0

Scale each element of this multivector by gamma. 

def PyTrilinos::NOX::Abstract::MultiVector::scale (   self,
  args 
)

scale(self, double gamma) -> MultiVector

virtual
NOX::Abstract::MultiVector& NOX::Abstract::MultiVector::scale(double
gamma)=0

Scale each element of this multivector by gamma. 

def PyTrilinos::NOX::Abstract::MultiVector::setBlock (   self,
  args 
)

setBlock(self, MultiVector source, vector<(int)> index) -> MultiVector

virtual
NOX::Abstract::MultiVector& NOX::Abstract::MultiVector::setBlock(const
NOX::Abstract::MultiVector &source, const vector< int > &index)=0

Copy the vectors in source to a set of vectors in *this. The
index.size() vectors in source are copied to a subset of vectors in
*this indicated by the indices given in index. 

def PyTrilinos::NOX::Abstract::MultiVector::setBlock (   self,
  args 
)

setBlock(self, MultiVector source, vector<(int)> index) -> MultiVector

virtual
NOX::Abstract::MultiVector& NOX::Abstract::MultiVector::setBlock(const
NOX::Abstract::MultiVector &source, const vector< int > &index)=0

Copy the vectors in source to a set of vectors in *this. The
index.size() vectors in source are copied to a subset of vectors in
*this indicated by the indices given in index. 

def PyTrilinos::NOX::Abstract::MultiVector::subCopy (   self,
  args 
)

subCopy(self, vector<(int)> index) -> Teuchos::RCP<(NOX::Abstract::MultiVector)>

virtual
Teuchos::RCP<NOX::Abstract::MultiVector>
NOX::Abstract::MultiVector::subCopy(const vector< int > &index) const
=0

Creates a new multi-vector with index.size() columns whose columns are
copies of the columns of *this given by index. 

def PyTrilinos::NOX::Abstract::MultiVector::subCopy (   self,
  args 
)

subCopy(self, vector<(int)> index) -> Teuchos::RCP<(NOX::Abstract::MultiVector)>

virtual
Teuchos::RCP<NOX::Abstract::MultiVector>
NOX::Abstract::MultiVector::subCopy(const vector< int > &index) const
=0

Creates a new multi-vector with index.size() columns whose columns are
copies of the columns of *this given by index. 

def PyTrilinos::NOX::Abstract::MultiVector::subView (   self,
  args 
)

subView(self, vector<(int)> index) -> Teuchos::RCP<(NOX::Abstract::MultiVector)>

virtual
Teuchos::RCP<NOX::Abstract::MultiVector>
NOX::Abstract::MultiVector::subView(const vector< int > &index) const
=0

Creates a new multi-vector with ndex.size() columns that shares the
columns of *this given by index. 

def PyTrilinos::NOX::Abstract::MultiVector::subView (   self,
  args 
)

subView(self, vector<(int)> index) -> Teuchos::RCP<(NOX::Abstract::MultiVector)>

virtual
Teuchos::RCP<NOX::Abstract::MultiVector>
NOX::Abstract::MultiVector::subView(const vector< int > &index) const
=0

Creates a new multi-vector with ndex.size() columns that shares the
columns of *this given by index. 

def PyTrilinos::NOX::Abstract::MultiVector::update (   self,
  args 
)

update(self, double alpha, MultiVector a, double gamma = 0.0) -> MultiVector
update(self, double alpha, MultiVector a, double beta, MultiVector b, 
    double gamma = 0.0) -> MultiVector
update(self, Teuchos::ETransp transb, double alpha, MultiVector a, 
    DenseMatrix b, double gamma = 0.0) -> MultiVector

virtual
NOX::Abstract::MultiVector&
NOX::Abstract::MultiVector::update(Teuchos::ETransp transb, double
alpha, const NOX::Abstract::MultiVector &a, const DenseMatrix &b,
double gamma=0.0)=0

Compute x = (alpha * a * op(b)) + (gamma * x) where a is a
multivector, b is a dense matrix, x = *this, and op(b) = b if transb =
Teuchos::NO_TRANS and op(b) is b transpose if transb = Teuchos::TRANS.

def PyTrilinos::NOX::Abstract::MultiVector::update (   self,
  args 
)

update(self, double alpha, MultiVector a, double gamma = 0.0) -> MultiVector
update(self, double alpha, MultiVector a, double beta, MultiVector b, 
    double gamma = 0.0) -> MultiVector
update(self, Teuchos::ETransp transb, double alpha, MultiVector a, 
    DenseMatrix b, double gamma = 0.0) -> MultiVector

virtual
NOX::Abstract::MultiVector&
NOX::Abstract::MultiVector::update(Teuchos::ETransp transb, double
alpha, const NOX::Abstract::MultiVector &a, const DenseMatrix &b,
double gamma=0.0)=0

Compute x = (alpha * a * op(b)) + (gamma * x) where a is a
multivector, b is a dense matrix, x = *this, and op(b) = b if transb =
Teuchos::NO_TRANS and op(b) is b transpose if transb = Teuchos::TRANS.


The documentation for this class was generated from the following files:

Generated on Thu Dec 17 11:00:22 2009 for PyTrilinos by  doxygen 1.5.9