LOCA::Pitchfork::MooreSpence::ExtendedVector Class Reference

Vector class to hold solution vectors, Newton vectors, etc. for the Moore-Spence turning point formulation. More...

#include <LOCA_Pitchfork_MooreSpence_ExtendedVector.H>

Inheritance diagram for LOCA::Pitchfork::MooreSpence::ExtendedVector:

Inheritance graph
[legend]
Collaboration diagram for LOCA::Pitchfork::MooreSpence::ExtendedVector:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ExtendedVector (const Teuchos::RCP< LOCA::GlobalData > &global_data, const NOX::Abstract::Vector &xVec, const NOX::Abstract::Vector &nullVec, double slack, double bifParam)
 Constructor.
 ExtendedVector (const ExtendedVector &source, NOX::CopyType type=NOX::DeepCopy)
 Copy constructor.
virtual ~ExtendedVector ()
 Destructor.
virtual NOX::Abstract::Vectoroperator= (const NOX::Abstract::Vector &y)
 Assignment operator.
virtual LOCA::Extended::Vectoroperator= (const LOCA::Extended::Vector &y)
 Assignment operator.
virtual ExtendedVectoroperator= (const ExtendedVector &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 &xVec, const NOX::Abstract::Vector &nullVec, double slack, double bifPar)
 Sets the Vector by setting its three components.
virtual Teuchos::RCP< const
NOX::Abstract::Vector
getXVec () const
 Returns the solution vector component of extended vector.
virtual Teuchos::RCP< const
NOX::Abstract::Vector
getNullVec () const
 Returns the null vector component of extended vector.
virtual double getSlack () const
 Get slack component.
virtual double getBifParam () const
 Get Bifurcation parameter.
virtual Teuchos::RCP
< NOX::Abstract::Vector
getXVec ()
 Returns the solution vector component of extended vector.
virtual Teuchos::RCP
< NOX::Abstract::Vector
getNullVec ()
 Returns the null vector component of extended vector.
virtual double & getSlack ()
 Get slack component.
virtual double & getBifParam ()
 Get Bifurcation parameter.

Protected Member Functions

 ExtendedVector (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 ExtendedMultiVector
 Declare LOCA::Pitchfork::MooreSpence::ExtendedMultiVector as a friend class so it can call protected methods.


Detailed Description

Vector class to hold solution vectors, Newton vectors, etc. for the Moore-Spence turning point formulation.

This class uses the LOCA::Extended::Vector implementation to store the solution, null, and parameter components of the turning point vector and merely provides an interface for naming which components of the vector these quantities correspond to.

Definition at line 72 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.H.


Constructor & Destructor Documentation

LOCA::Pitchfork::MooreSpence::ExtendedVector::ExtendedVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data,
const NOX::Abstract::Vector xVec,
const NOX::Abstract::Vector nullVec,
double  slack,
double  bifParam 
)

LOCA::Pitchfork::MooreSpence::ExtendedVector::ExtendedVector ( const ExtendedVector source,
NOX::CopyType  type = NOX::DeepCopy 
)

Copy constructor.

Definition at line 59 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

LOCA::Pitchfork::MooreSpence::ExtendedVector::~ExtendedVector (  )  [virtual]

Destructor.

Definition at line 67 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

LOCA::Pitchfork::MooreSpence::ExtendedVector::ExtendedVector ( const Teuchos::RCP< LOCA::GlobalData > &  global_data  )  [protected]

Default Constructor.

Definition at line 165 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.


Member Function Documentation

NOX::Abstract::Vector & LOCA::Pitchfork::MooreSpence::ExtendedVector::operator= ( const NOX::Abstract::Vector y  )  [virtual]

Assignment operator.

Reimplemented from LOCA::Extended::Vector.

Definition at line 72 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

Referenced by operator=().

LOCA::Extended::Vector & LOCA::Pitchfork::MooreSpence::ExtendedVector::operator= ( const LOCA::Extended::Vector y  )  [virtual]

Assignment operator.

Reimplemented from LOCA::Extended::Vector.

Definition at line 80 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

References operator=().

LOCA::Pitchfork::MooreSpence::ExtendedVector & LOCA::Pitchfork::MooreSpence::ExtendedVector::operator= ( const ExtendedVector y  )  [virtual]

Assignment operator.

Definition at line 88 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

References operator=().

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

Cloning function.

Reimplemented from LOCA::Extended::Vector.

Definition at line 96 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

void LOCA::Pitchfork::MooreSpence::ExtendedVector::setVec ( const NOX::Abstract::Vector xVec,
const NOX::Abstract::Vector nullVec,
double  slack,
double  bifPar 
) [virtual]

Sets the Vector by setting its three components.

Definition at line 105 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

References LOCA::Extended::Vector::setScalar(), and LOCA::Extended::Vector::setVector().

Teuchos::RCP< const NOX::Abstract::Vector > LOCA::Pitchfork::MooreSpence::ExtendedVector::getXVec (  )  const [virtual]

Teuchos::RCP< const NOX::Abstract::Vector > LOCA::Pitchfork::MooreSpence::ExtendedVector::getNullVec (  )  const [virtual]

Returns the null vector component of extended vector.

Definition at line 124 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

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

Referenced by LOCA::Pitchfork::MooreSpence::ExtendedGroup::printSolution().

double LOCA::Pitchfork::MooreSpence::ExtendedVector::getSlack (  )  const [virtual]

double LOCA::Pitchfork::MooreSpence::ExtendedVector::getBifParam (  )  const [virtual]

Teuchos::RCP< NOX::Abstract::Vector > LOCA::Pitchfork::MooreSpence::ExtendedVector::getXVec (  )  [virtual]

Returns the solution vector component of extended vector.

Definition at line 142 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

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

Teuchos::RCP< NOX::Abstract::Vector > LOCA::Pitchfork::MooreSpence::ExtendedVector::getNullVec (  )  [virtual]

Returns the null vector component of extended vector.

Definition at line 148 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

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

double & LOCA::Pitchfork::MooreSpence::ExtendedVector::getSlack (  )  [virtual]

Get slack component.

Definition at line 154 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

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

double & LOCA::Pitchfork::MooreSpence::ExtendedVector::getBifParam (  )  [virtual]

Get Bifurcation parameter.

Definition at line 160 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

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

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

generate an extended multi-vector

Returns an empty multivector of type LOCA::Pitchfork::MooreSpence::ExtendedMultiVector

Reimplemented from LOCA::Extended::Vector.

Definition at line 172 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.C.

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


Friends And Related Function Documentation

friend class ExtendedMultiVector [friend]

Declare LOCA::Pitchfork::MooreSpence::ExtendedMultiVector as a friend class so it can call protected methods.

Definition at line 78 of file LOCA_Pitchfork_MooreSpence_ExtendedVector.H.


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

Generated on Wed Oct 21 14:28:40 2009 for Nonlinear Solver Project by  doxygen 1.5.9