NOX Development
Public Member Functions | Protected Member Functions | Friends
LOCA::MultiContinuation::ExtendedMultiVector Class Reference

MultiVector class to hold solution vectors, Newton vectors, etc. for continuation equations. More...

#include <LOCA_MultiContinuation_ExtendedMultiVector.H>

Inheritance diagram for LOCA::MultiContinuation::ExtendedMultiVector:
Inheritance graph
[legend]
Collaboration diagram for LOCA::MultiContinuation::ExtendedMultiVector:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ExtendedMultiVector (const Teuchos::RCP< LOCA::GlobalData > &global_data, const NOX::Abstract::Vector &xVec, int nColumns, int nScalarRows, NOX::CopyType type=NOX::DeepCopy)
 Constructor.
 ExtendedMultiVector (const Teuchos::RCP< LOCA::GlobalData > &global_data, const NOX::Abstract::MultiVector &xVec, int nScalarRows)
 Constructor.
 ExtendedMultiVector (const Teuchos::RCP< LOCA::GlobalData > &global_data, const NOX::Abstract::MultiVector &xVec, const NOX::Abstract::MultiVector::DenseMatrix &params)
 Constructor.
 ExtendedMultiVector (const ExtendedMultiVector &source, NOX::CopyType type=NOX::DeepCopy)
 Copy constructor.
 ExtendedMultiVector (const ExtendedMultiVector &source, int nColumns)
 Copy constructor that creates a new multivector with nColumns columns.
 ExtendedMultiVector (const ExtendedMultiVector &source, const std::vector< int > &index, bool view)
 Copy constructor that creates a sub copy or view of the given multivector.
virtual ~ExtendedMultiVector ()
 Destructor.
virtual ExtendedMultiVectoroperator= (const ExtendedMultiVector &y)
 Assignment operator.
virtual
LOCA::Extended::MultiVector
operator= (const LOCA::Extended::MultiVector &y)
 Assignment operator.
virtual
NOX::Abstract::MultiVector
operator= (const NOX::Abstract::MultiVector &y)
 Assignment operator.
virtual Teuchos::RCP
< NOX::Abstract::MultiVector
clone (NOX::CopyType type=NOX::DeepCopy) const
 Create a new multi-vector of the same underlying type by cloning "this", and return a pointer to the new vector.
virtual Teuchos::RCP
< NOX::Abstract::MultiVector
clone (int numvecs) const
 Creates a new multi-vector with numvecs columns.
virtual Teuchos::RCP
< NOX::Abstract::MultiVector
subCopy (const std::vector< int > &index) const
 Creates a new multi-vector with index.size() columns whose columns are copies of the columns of *this given by index.
virtual Teuchos::RCP
< NOX::Abstract::MultiVector
subView (const std::vector< int > &index) const
 Creates a new multi-vector with index.size() columns that shares the columns of *this given by index.
virtual Teuchos::RCP< const
NOX::Abstract::MultiVector
getXMultiVec () const
 Returns the solution vector component of extended multivector.
virtual Teuchos::RCP
< NOX::Abstract::MultiVector
getXMultiVec ()
 Returns the solution vector component of extended multivector.

Protected Member Functions

 ExtendedMultiVector (const Teuchos::RCP< LOCA::GlobalData > &global_data, int nColumns, int nScalarRows)
 Constructor.
virtual Teuchos::RCP
< LOCA::Extended::Vector
generateVector (int nVecs, int nScalarRows) const
 Generate a derived extended vector.

Friends

class ExtendedVector
 Declare LOCA::Continuation::ExtendedVector as a friend class.

Detailed Description

MultiVector class to hold solution vectors, Newton vectors, etc. for continuation equations.

This class uses the LOCA::Extended::MultiVector implementation to store the solution and parameter components of the continuation vector and merely provides an interface for naming which components of the multivector these quantities correspond to.


Constructor & Destructor Documentation

LOCA::MultiContinuation::ExtendedMultiVector::ExtendedMultiVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const NOX::Abstract::Vector xVec,
int  nColumns,
int  nScalarRows,
NOX::CopyType  type = NOX::DeepCopy 
)

Constructor.

Generates a multivector with nColumns from xVec amd nScalarRows of zeros.

References NOX::Abstract::Vector::createMultiVector(), and LOCA::Extended::MultiVector::setMultiVectorPtr().

LOCA::MultiContinuation::ExtendedMultiVector::ExtendedMultiVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const NOX::Abstract::MultiVector xVec,
int  nScalarRows 
)

Constructor.

Initializes the scalar matrix to nScalarRows rows and xVec.numVectors() columns of zeros

References NOX::Abstract::MultiVector::clone(), NOX::DeepCopy, and LOCA::Extended::MultiVector::setMultiVectorPtr().

LOCA::MultiContinuation::ExtendedMultiVector::ExtendedMultiVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const NOX::Abstract::MultiVector xVec,
const NOX::Abstract::MultiVector::DenseMatrix params 
)
LOCA::MultiContinuation::ExtendedMultiVector::ExtendedMultiVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
int  nColumns,
int  nScalarRows 
) [protected]

Constructor.

Creates an empty multivector with nColumns columns and nScalarRows scalar rows


Member Function Documentation

Teuchos::RCP< LOCA::Extended::Vector > LOCA::MultiContinuation::ExtendedMultiVector::generateVector ( int  nVecs,
int  nScalarRows 
) const [protected, virtual]

Generate a derived extended vector.

Returns a vector of type LOCA::MultiContinuation::ExtendedVector

Reimplemented from LOCA::Extended::MultiVector.

References Teuchos::rcp().


Friends And Related Function Documentation

friend class ExtendedVector [friend]

Declare LOCA::Continuation::ExtendedVector as a friend class.

So it can call protected methods.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends