LOCA::Hopf::MooreSpence::ExtendedMultiVector Class Reference

Multi-vector class to hold solution vectors, Newton vectors, etc.for the Moore-Spence Hopf eqautions. More...

#include <LOCA_Hopf_MooreSpence_ExtendedMultiVector.H>

Inheritance diagram for LOCA::Hopf::MooreSpence::ExtendedMultiVector:

Inheritance graph
[legend]
Collaboration diagram for LOCA::Hopf::MooreSpence::ExtendedMultiVector:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ExtendedMultiVector (const Teuchos::RCP< LOCA::GlobalData > &global_data, const NOX::Abstract::Vector &cloneVec, int nColumns)
 Constructor.
 ExtendedMultiVector (const Teuchos::RCP< LOCA::GlobalData > &global_data, const NOX::Abstract::MultiVector &xVec, const NOX::Abstract::MultiVector &realEigenVec, const NOX::Abstract::MultiVector &imagEigenVec, const NOX::Abstract::MultiVector::DenseMatrix &freqs, const NOX::Abstract::MultiVector::DenseMatrix &bifParams)
 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 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 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 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.
virtual Teuchos::RCP< const
NOX::Abstract::MultiVector
getRealEigenMultiVec () const
 Returns the real part of the eigenvector component of extended multivector.
virtual Teuchos::RCP
< NOX::Abstract::MultiVector
getRealEigenMultiVec ()
 Returns the real part of the eigenvector component of extended multivector.
virtual Teuchos::RCP< const
NOX::Abstract::MultiVector
getImagEigenMultiVec () const
 Returns the imaginary part of the eigenvector component of extended multivector.
virtual Teuchos::RCP
< NOX::Abstract::MultiVector
getImagEigenMultiVec ()
 Returns the imaginary part of the eigenvector component of extended multivector.
virtual Teuchos::RCP< const
NOX::Abstract::MultiVector::DenseMatrix
getFrequencies () const
 Returns frequency component of extended multi vector.
virtual Teuchos::RCP
< NOX::Abstract::MultiVector::DenseMatrix
getFrequencies ()
 Returns frequency component of extended multi vector.
virtual Teuchos::RCP< const
NOX::Abstract::MultiVector::DenseMatrix
getBifParams () const
 Returns bifurcation parameter component of extended multi vector.
virtual Teuchos::RCP
< NOX::Abstract::MultiVector::DenseMatrix
getBifParams ()
 Returns bifurcation parameter component of extended multi vector.
virtual Teuchos::RCP
< LOCA::Hopf::MooreSpence::ExtendedVector
getColumn (int i)
 Returns ith column as an extended vector.
virtual Teuchos::RCP< const
LOCA::Hopf::MooreSpence::ExtendedVector
getColumn (int i) const
 Returns ith column as an extended vector.

Protected Member Functions

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

Friends

class ExtendedVector
 Declare LOCA::Hopf::MooreSpence::ExtendedVector as a friend class so it can call protected methods.


Detailed Description

Multi-vector class to hold solution vectors, Newton vectors, etc.for the Moore-Spence Hopf eqautions.

This class uses the LOCA::Extended::MultiVector implementation to store the solution, real and imaginary eigenvector, frequency and parameter components of the Hopf multi vector and merely provides an interface for naming which components of the multivector these quantities correspond to.

Definition at line 73 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.H.


Constructor & Destructor Documentation

LOCA::Hopf::MooreSpence::ExtendedMultiVector::ExtendedMultiVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const NOX::Abstract::Vector cloneVec,
int  nColumns 
)

Constructor.

Generates a multivector with nColumns columns from cloneVec

Definition at line 45 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

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

LOCA::Hopf::MooreSpence::ExtendedMultiVector::ExtendedMultiVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const NOX::Abstract::MultiVector xVec,
const NOX::Abstract::MultiVector realEigenVec,
const NOX::Abstract::MultiVector imagEigenVec,
const NOX::Abstract::MultiVector::DenseMatrix freqs,
const NOX::Abstract::MultiVector::DenseMatrix bifParams 
)

LOCA::Hopf::MooreSpence::ExtendedMultiVector::ExtendedMultiVector ( const ExtendedMultiVector source,
NOX::CopyType  type = NOX::DeepCopy 
)

Copy constructor.

Definition at line 78 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

LOCA::Hopf::MooreSpence::ExtendedMultiVector::ExtendedMultiVector ( const ExtendedMultiVector source,
int  nColumns 
)

Copy constructor that creates a new multivector with nColumns columns.

Definition at line 85 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

LOCA::Hopf::MooreSpence::ExtendedMultiVector::ExtendedMultiVector ( const ExtendedMultiVector source,
const vector< int > &  index,
bool  view 
)

Copy constructor that creates a sub copy or view of the given multivector.

Definition at line 92 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

LOCA::Hopf::MooreSpence::ExtendedMultiVector::~ExtendedMultiVector (  )  [virtual]

Destructor.

Definition at line 99 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

LOCA::Hopf::MooreSpence::ExtendedMultiVector::ExtendedMultiVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
int  nColumns 
) [protected]

Constructor.

Creates an empty multivector with nColumns columns

Definition at line 217 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.


Member Function Documentation

LOCA::Hopf::MooreSpence::ExtendedMultiVector & LOCA::Hopf::MooreSpence::ExtendedMultiVector::operator= ( const ExtendedMultiVector y  )  [virtual]

Assignment operator.

Definition at line 120 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

Referenced by operator=().

LOCA::Extended::MultiVector & LOCA::Hopf::MooreSpence::ExtendedMultiVector::operator= ( const LOCA::Extended::MultiVector y  )  [virtual]

Assignment operator.

Reimplemented from LOCA::Extended::MultiVector.

Definition at line 104 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

References operator=().

NOX::Abstract::MultiVector & LOCA::Hopf::MooreSpence::ExtendedMultiVector::operator= ( const NOX::Abstract::MultiVector y  )  [virtual]

Assignment operator.

Reimplemented from LOCA::Extended::MultiVector.

Definition at line 112 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

References operator=().

Teuchos::RCP< NOX::Abstract::MultiVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::clone ( NOX::CopyType  type = NOX::DeepCopy  )  const [virtual]

Create a new multi-vector of the same underlying type by cloning "this", and return a pointer to the new vector.

Reimplemented from LOCA::Extended::MultiVector.

Definition at line 128 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

Teuchos::RCP< NOX::Abstract::MultiVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::clone ( int  numvecs  )  const [virtual]

Creates a new multi-vector with numvecs columns.

Reimplemented from LOCA::Extended::MultiVector.

Definition at line 135 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

Teuchos::RCP< NOX::Abstract::MultiVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::subCopy ( const vector< int > &  index  )  const [virtual]

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

Reimplemented from LOCA::Extended::MultiVector.

Definition at line 142 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

Teuchos::RCP< NOX::Abstract::MultiVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::subView ( const vector< int > &  index  )  const [virtual]

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

Reimplemented from LOCA::Extended::MultiVector.

Definition at line 150 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

Referenced by LOCA::Hopf::MooreSpence::ExtendedGroup::setupViews().

Teuchos::RCP< const NOX::Abstract::MultiVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getXMultiVec (  )  const [virtual]

Teuchos::RCP< NOX::Abstract::MultiVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getXMultiVec (  )  [virtual]

Returns the solution vector component of extended multivector.

Definition at line 164 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

References LOCA::Extended::MultiVector::getMultiVector().

Teuchos::RCP< const NOX::Abstract::MultiVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getRealEigenMultiVec (  )  const [virtual]

Teuchos::RCP< NOX::Abstract::MultiVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getRealEigenMultiVec (  )  [virtual]

Returns the real part of the eigenvector component of extended multivector.

Definition at line 176 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

References LOCA::Extended::MultiVector::getMultiVector().

Teuchos::RCP< const NOX::Abstract::MultiVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getImagEigenMultiVec (  )  const [virtual]

Teuchos::RCP< NOX::Abstract::MultiVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getImagEigenMultiVec (  )  [virtual]

Returns the imaginary part of the eigenvector component of extended multivector.

Definition at line 188 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

References LOCA::Extended::MultiVector::getMultiVector().

Teuchos::RCP< const NOX::Abstract::MultiVector::DenseMatrix > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getFrequencies (  )  const [virtual]

Teuchos::RCP< NOX::Abstract::MultiVector::DenseMatrix > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getFrequencies (  )  [virtual]

Returns frequency component of extended multi vector.

Definition at line 200 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

References LOCA::Extended::MultiVector::getScalarRows().

Teuchos::RCP< const NOX::Abstract::MultiVector::DenseMatrix > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getBifParams (  )  const [virtual]

Teuchos::RCP< NOX::Abstract::MultiVector::DenseMatrix > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getBifParams (  )  [virtual]

Returns bifurcation parameter component of extended multi vector.

Definition at line 212 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

References LOCA::Extended::MultiVector::getScalarRows().

Teuchos::RCP< LOCA::Hopf::MooreSpence::ExtendedVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getColumn ( int  i  )  [virtual]

Teuchos::RCP< const LOCA::Hopf::MooreSpence::ExtendedVector > LOCA::Hopf::MooreSpence::ExtendedMultiVector::getColumn ( int  i  )  const [virtual]

Returns ith column as an extended vector.

Definition at line 240 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

References LOCA::Extended::MultiVector::getVector().

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

Generate a derived extended vector.

Returns a vector of type LOCA::Hopf::MooreSpence::ExtendedVector

Reimplemented from LOCA::Extended::MultiVector.

Definition at line 225 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.C.

References LOCA::Extended::MultiVector::globalData.


Friends And Related Function Documentation

friend class ExtendedVector [friend]

Declare LOCA::Hopf::MooreSpence::ExtendedVector as a friend class so it can call protected methods.

Definition at line 79 of file LOCA_Hopf_MooreSpence_ExtendedMultiVector.H.


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

Generated on Thu Dec 17 11:02:52 2009 for Nonlinear Solver Project by  doxygen 1.5.9