Xyce  6.1
Xyce::Nonlinear::MatrixFreeEpetraOperator Class Reference

#include <N_NLS_MatrixFreeEpetraOperator.h>

Inheritance diagram for Xyce::Nonlinear::MatrixFreeEpetraOperator:
Collaboration diagram for Xyce::Nonlinear::MatrixFreeEpetraOperator:

Public Member Functions

 MatrixFreeEpetraOperator ()
 
virtual ~MatrixFreeEpetraOperator ()
 
void initialize (RCP< NonLinearSolver > nonlinearSolver, RCP< Linear::Vector > solVector, RCP< Linear::Vector > rhsVector, RCP< const Epetra_Map > solutionMap)
 
int SetUseTranspose (bool UseTranspose)
 If set true, transpose of this operator will be applied. More...
 
int Apply (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y. More...
 
int Apply (const Linear::MultiVector &X, Linear::MultiVector &Y) const
 
int ApplyInverse (const Epetra_MultiVector &X, Epetra_MultiVector &Y) const
 Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y. More...
 
int ApplyInverse (const Linear::MultiVector &X, Linear::MultiVector &Y) const
 
double NormInf () const
 Returns the infinity norm of the global matrix. More...
 
const char * Label () const
 Returns a character string describing the operator. More...
 
bool UseTranspose () const
 Returns the current UseTranspose setting. More...
 
bool HasNormInf () const
 Returns true if the this object can provide an approximate Inf-norm, false otherwise. More...
 
const Epetra_Comm & Comm () const
 Returns a pointer to the Epetra_Comm communicator associated with this operator. More...
 
const Epetra_Map & OperatorDomainMap () const
 Returns the Epetra_Map object associated with the domain of this operator. More...
 
const Epetra_Map & OperatorRangeMap () const
 Returns the Epetra_Map object associated with the range of this operator. More...
 

Private Attributes

bool isInitialized_
 
Teuchos::RCP< Linear::Vector > solVectorRCPtr_
 
Teuchos::RCP< Linear::Vector > rhsVectorRCPtr_
 
Teuchos::RCP< NonLinearSolvernonlinearSolverRCPtr_
 
Teuchos::RCP< const Epetra_Map > solutionMap_
 

Detailed Description

Definition at line 79 of file N_NLS_MatrixFreeEpetraOperator.h.

Constructor & Destructor Documentation

Xyce::Nonlinear::MatrixFreeEpetraOperator::MatrixFreeEpetraOperator ( )

Definition at line 94 of file N_NLS_MatrixFreeEpetraOperator.C.

Xyce::Nonlinear::MatrixFreeEpetraOperator::~MatrixFreeEpetraOperator ( )
virtual

Definition at line 107 of file N_NLS_MatrixFreeEpetraOperator.C.

Member Function Documentation

int Xyce::Nonlinear::MatrixFreeEpetraOperator::Apply ( const Epetra_MultiVector &  X,
Epetra_MultiVector &  Y 
) const

Returns the result of a Epetra_Operator applied to a Epetra_MultiVector X in Y.

Definition at line 155 of file N_NLS_MatrixFreeEpetraOperator.C.

int Xyce::Nonlinear::MatrixFreeEpetraOperator::Apply ( const Linear::MultiVector &  X,
Linear::MultiVector &  Y 
) const

Definition at line 181 of file N_NLS_MatrixFreeEpetraOperator.C.

int Xyce::Nonlinear::MatrixFreeEpetraOperator::ApplyInverse ( const Epetra_MultiVector &  X,
Epetra_MultiVector &  Y 
) const

Returns the result of a Epetra_Operator inverse applied to an Epetra_MultiVector X in Y.

Definition at line 216 of file N_NLS_MatrixFreeEpetraOperator.C.

int Xyce::Nonlinear::MatrixFreeEpetraOperator::ApplyInverse ( const Linear::MultiVector &  X,
Linear::MultiVector &  Y 
) const

Definition at line 234 of file N_NLS_MatrixFreeEpetraOperator.C.

const Epetra_Comm & Xyce::Nonlinear::MatrixFreeEpetraOperator::Comm ( ) const

Returns a pointer to the Epetra_Comm communicator associated with this operator.

Definition at line 308 of file N_NLS_MatrixFreeEpetraOperator.C.

bool Xyce::Nonlinear::MatrixFreeEpetraOperator::HasNormInf ( ) const

Returns true if the this object can provide an approximate Inf-norm, false otherwise.

Definition at line 294 of file N_NLS_MatrixFreeEpetraOperator.C.

void Xyce::Nonlinear::MatrixFreeEpetraOperator::initialize ( RCP< NonLinearSolver nonlinearSolver,
RCP< Linear::Vector >  solVector,
RCP< Linear::Vector >  rhsVector,
RCP< const Epetra_Map >  solutionMap 
)

Definition at line 119 of file N_NLS_MatrixFreeEpetraOperator.C.

const char * Xyce::Nonlinear::MatrixFreeEpetraOperator::Label ( ) const

Returns a character string describing the operator.

Definition at line 267 of file N_NLS_MatrixFreeEpetraOperator.C.

double Xyce::Nonlinear::MatrixFreeEpetraOperator::NormInf ( ) const

Returns the infinity norm of the global matrix.

Definition at line 252 of file N_NLS_MatrixFreeEpetraOperator.C.

const Epetra_Map & Xyce::Nonlinear::MatrixFreeEpetraOperator::OperatorDomainMap ( ) const

Returns the Epetra_Map object associated with the domain of this operator.

Definition at line 326 of file N_NLS_MatrixFreeEpetraOperator.C.

const Epetra_Map & Xyce::Nonlinear::MatrixFreeEpetraOperator::OperatorRangeMap ( ) const

Returns the Epetra_Map object associated with the range of this operator.

Definition at line 344 of file N_NLS_MatrixFreeEpetraOperator.C.

int Xyce::Nonlinear::MatrixFreeEpetraOperator::SetUseTranspose ( bool  UseTranspose)

If set true, transpose of this operator will be applied.

This flag allows the transpose of the given operator to be used implicitly. Setting this flag affects only the Apply() and ApplyInverse() methods. If the implementation of this interface does not support transpose use, this method should return a value of -1.

Parameters
[in]UseTranspose-If true, multiply by the transpose of operator, otherwise just use operator.
Returns
Integer error code, set to 0 if successful. Set to -1 if this implementation does not support transpose.

Definition at line 141 of file N_NLS_MatrixFreeEpetraOperator.C.

bool Xyce::Nonlinear::MatrixFreeEpetraOperator::UseTranspose ( ) const

Returns the current UseTranspose setting.

Definition at line 280 of file N_NLS_MatrixFreeEpetraOperator.C.

Member Data Documentation

bool Xyce::Nonlinear::MatrixFreeEpetraOperator::isInitialized_
private

Definition at line 161 of file N_NLS_MatrixFreeEpetraOperator.h.

Teuchos::RCP<NonLinearSolver> Xyce::Nonlinear::MatrixFreeEpetraOperator::nonlinearSolverRCPtr_
private

Definition at line 164 of file N_NLS_MatrixFreeEpetraOperator.h.

Teuchos::RCP<Linear::Vector> Xyce::Nonlinear::MatrixFreeEpetraOperator::rhsVectorRCPtr_
private

Definition at line 163 of file N_NLS_MatrixFreeEpetraOperator.h.

Teuchos::RCP<const Epetra_Map> Xyce::Nonlinear::MatrixFreeEpetraOperator::solutionMap_
private

Definition at line 165 of file N_NLS_MatrixFreeEpetraOperator.h.

Teuchos::RCP<Linear::Vector> Xyce::Nonlinear::MatrixFreeEpetraOperator::solVectorRCPtr_
private

Definition at line 162 of file N_NLS_MatrixFreeEpetraOperator.h.


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