LOCA::Hopf::ComplexVector Class Reference

Vector class to hold two vectors to represent a complex vector. More...

#include <LOCA_Hopf_ComplexVector.H>

Inheritance diagram for LOCA::Hopf::ComplexVector:
Inheritance graph
[legend]
Collaboration diagram for LOCA::Hopf::ComplexVector:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ComplexVector (const Teuchos::RCP< LOCA::GlobalData > &global_data, const NOX::Abstract::Vector &realVec, const NOX::Abstract::Vector &imagVec)
 Constructor.
 ComplexVector (const ComplexVector &source, NOX::CopyType type=NOX::DeepCopy)
 Copy constructor.
virtual ~ComplexVector ()
 Destructor.
virtual NOX::Abstract::Vectoroperator= (const NOX::Abstract::Vector &y)
 Assignment operator.
virtual LOCA::Extended::Vectoroperator= (const LOCA::Extended::Vector &y)
 Assignment operator.
virtual ComplexVectoroperator= (const ComplexVector &y)
 Assignment operator.
virtual Teuchos::RCP
< NOX::Abstract::Vector
clone (NOX::CopyType type=NOX::DeepCopy) const
 Cloning function.
virtual void setVec (const NOX::Abstract::Vector &realVec, const NOX::Abstract::Vector &imagVec)
 Sets the vector by setting its components.
virtual Teuchos::RCP< const
NOX::Abstract::Vector
getRealVec () const
 Returns the real component of extended vector.
virtual Teuchos::RCP< const
NOX::Abstract::Vector
getImagVec () const
 Returns the imaginary component of extended vector.
virtual Teuchos::RCP
< NOX::Abstract::Vector
getRealVec ()
 Returns the real component of extended vector.
virtual Teuchos::RCP
< NOX::Abstract::Vector
getImagVec ()
 Returns the imaginary component of extended vector.

Protected Member Functions

 ComplexVector (const Teuchos::RCP< LOCA::GlobalData > &global_data)
 Default Constructor.
virtual Teuchos::RCP
< LOCA::Extended::MultiVector
generateMultiVector (int nColumns, int nVectorRows, int nScalarRows) const
 generate an extended multi-vector

Friends

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

Detailed Description

Vector class to hold two vectors to represent a complex vector.

This is not a true complex vector. Operations like innerProduct() are not correct for complex vectors. This class exists to make some aspects of the real-equivalent formulation of complex linear algebra simpler to implement.


Member Function Documentation

Teuchos::RCP< LOCA::Extended::MultiVector > LOCA::Hopf::ComplexVector::generateMultiVector ( int  nColumns,
int  nVectorRows,
int  nScalarRows 
) const [protected, virtual]

generate an extended multi-vector

Returns an empty multivector of type LOCA::Hopf::ComplexMultiVector

Reimplemented from LOCA::Extended::Vector.

References LOCA::Extended::Vector::globalData, and Teuchos::rcp().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Generated on Wed Apr 13 09:59:43 2011 for NOX by  doxygen 1.6.3