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.

Definition at line 67 of file LOCA_Hopf_ComplexVector.H.


Constructor & Destructor Documentation

LOCA::Hopf::ComplexVector::ComplexVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const NOX::Abstract::Vector realVec,
const NOX::Abstract::Vector imagVec 
)

Constructor.

Definition at line 45 of file LOCA_Hopf_ComplexVector.C.

References LOCA::Extended::Vector::setVector().

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

Copy constructor.

Definition at line 55 of file LOCA_Hopf_ComplexVector.C.

LOCA::Hopf::ComplexVector::~ComplexVector (  )  [virtual]

Destructor.

Definition at line 63 of file LOCA_Hopf_ComplexVector.C.

LOCA::Hopf::ComplexVector::ComplexVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data  )  [protected]

Default Constructor.

Definition at line 125 of file LOCA_Hopf_ComplexVector.C.


Member Function Documentation

NOX::Abstract::Vector & LOCA::Hopf::ComplexVector::operator= ( const NOX::Abstract::Vector y  )  [virtual]

Assignment operator.

Reimplemented from LOCA::Extended::Vector.

Definition at line 68 of file LOCA_Hopf_ComplexVector.C.

Referenced by operator=().

LOCA::Extended::Vector & LOCA::Hopf::ComplexVector::operator= ( const LOCA::Extended::Vector y  )  [virtual]

Assignment operator.

Reimplemented from LOCA::Extended::Vector.

Definition at line 74 of file LOCA_Hopf_ComplexVector.C.

References operator=().

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

Assignment operator.

Definition at line 80 of file LOCA_Hopf_ComplexVector.C.

References operator=().

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

Cloning function.

Reimplemented from LOCA::Extended::Vector.

Definition at line 87 of file LOCA_Hopf_ComplexVector.C.

void LOCA::Hopf::ComplexVector::setVec ( const NOX::Abstract::Vector realVec,
const NOX::Abstract::Vector imagVec 
) [virtual]

Sets the vector by setting its components.

Definition at line 94 of file LOCA_Hopf_ComplexVector.C.

References LOCA::Extended::Vector::setVector().

Teuchos::RCP< const NOX::Abstract::Vector > LOCA::Hopf::ComplexVector::getRealVec (  )  const [virtual]

Returns the real component of extended vector.

Definition at line 102 of file LOCA_Hopf_ComplexVector.C.

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

Teuchos::RCP< const NOX::Abstract::Vector > LOCA::Hopf::ComplexVector::getImagVec (  )  const [virtual]

Returns the imaginary component of extended vector.

Definition at line 108 of file LOCA_Hopf_ComplexVector.C.

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

Teuchos::RCP< NOX::Abstract::Vector > LOCA::Hopf::ComplexVector::getRealVec (  )  [virtual]

Returns the real component of extended vector.

Definition at line 114 of file LOCA_Hopf_ComplexVector.C.

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

Teuchos::RCP< NOX::Abstract::Vector > LOCA::Hopf::ComplexVector::getImagVec (  )  [virtual]

Returns the imaginary component of extended vector.

Definition at line 120 of file LOCA_Hopf_ComplexVector.C.

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

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.

Definition at line 132 of file LOCA_Hopf_ComplexVector.C.

References LOCA::Extended::Vector::globalData.


Friends And Related Function Documentation

friend class ComplexMultiVector [friend]

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

Definition at line 73 of file LOCA_Hopf_ComplexVector.H.


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

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