PyTrilinos::NOX::Epetra::FiniteDifference Class Reference

Inheritance diagram for PyTrilinos::NOX::Epetra::FiniteDifference:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::NOX::Epetra::FiniteDifference:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def Label
def SetUseTranspose
def Apply
def ApplyInverse
def UseTranspose
def HasNormInf
def OperatorDomainMap
def OperatorRangeMap
def Filled
def NumMyRowEntries
def MaxNumEntries
def ExtractMyRowCopy
def ExtractDiagonalCopy
def Multiply
def Solve
def InvRowSums
def LeftScale
def InvColSums
def RightScale
def NormInf
def NormOne
def NumGlobalNonzeros
def NumGlobalRows
def NumGlobalCols
def NumGlobalDiagonals
def NumMyNonzeros
def NumMyRows
def NumMyCols
def NumMyDiagonals
def LowerTriangular
def UpperTriangular
def Comm
def RowMatrixRowMap
def RowMatrixColMap
def RowMatrixImporter
def Map
def computeJacobian
def computePreconditioner
def setDifferenceMethod
def getUnderlyingMatrix
def Print
def setGroupForComputeF
def __init__
def Label
def SetUseTranspose
def Apply
def ApplyInverse
def UseTranspose
def HasNormInf
def OperatorDomainMap
def OperatorRangeMap
def Filled
def NumMyRowEntries
def MaxNumEntries
def ExtractMyRowCopy
def ExtractDiagonalCopy
def Multiply
def Solve
def InvRowSums
def LeftScale
def InvColSums
def RightScale
def NormInf
def NormOne
def NumGlobalNonzeros
def NumGlobalRows
def NumGlobalCols
def NumGlobalDiagonals
def NumMyNonzeros
def NumMyRows
def NumMyCols
def NumMyDiagonals
def LowerTriangular
def UpperTriangular
def Comm
def RowMatrixRowMap
def RowMatrixColMap
def RowMatrixImporter
def Map
def computeJacobian
def computePreconditioner
def setDifferenceMethod
def getUnderlyingMatrix
def Print
def setGroupForComputeF

Public Attributes

 this

Static Public Attributes

 Forward = ___init__.FiniteDifference_Forward
 Backward = ___init__.FiniteDifference_Backward
 Centered = ___init__.FiniteDifference_Centered


Detailed Description

Concrete implementation for creating an Epetra_RowMatrix Jacobian via
finite differencing of the residual.

The Jacobian entries are calculated via 1st order finite differencing.
This requires $ N + 1 $ calls to computeF() where $ N $ is the number
of unknowns in the problem.

\\[ J_{ij} = \\frac{\\partial F_i}{\\partial x_j} =
\\frac{F_i(x+\\delta\\mathbf{e}_j) - F_i(x)}{\\delta} \\]

where $J$ is the Jacobian, $F$ is the function evaluation, $x$ is the
solution vector, and $\\delta$ is a small perturbation to the $x_j$
entry.

The perturbation, $ \\delta $, is calculated based on one of the
following equations:

\\[ \\delta = \\alpha * | x_j | + \\beta \\] \\[ \\delta
= \\alpha * | x_j | + \\beta_j \\]

where $ \\alpha $ is a scalar value (defaults to 1.0e-4) and $
\\beta $ can be either a scalar or a vector (defaults to a scalar
value of 1.0e-6). The choice is defined by the type of constructor
used. All parameters are supplied in the constructor. In addition to
the forward difference derivative approximation, backward or centered
differences can be used via the setDifferenceMethod function. Note
that centered difference provides second order spatial accuracy but at
the cost of twice as many function evaluations.

Since this inherits from the Epetra_RowMatrix class, it can be used as
the preconditioning matrix for AztecOO preconditioners. This method is
very inefficient when computing the Jacobian and is not recommended
for large-scale systems but only for debugging purposes.

C++ includes: NOX_Epetra_FiniteDifference.H 

Member Function Documentation

def PyTrilinos::NOX::Epetra::FiniteDifference::__init__ (   self,
  args 
)

__init__(self, ParameterList printingParams, Teuchos::RCP<(NOX::Epetra::Interface::Required)> i, 
    Vector initialGuess, 
    double beta = 1.0e-6, double alpha = 1.0e-4) -> FiniteDifference
__init__(self, ParameterList printingParams, Teuchos::RCP<(NOX::Epetra::Interface::Required)> i, 
    Vector initialGuess, 
    Teuchos::RCP<(q(const).Epetra_Vector)> beta, 
    double alpha = 1.0e-4) -> FiniteDifference
__init__(self, ParameterList printingParams, Teuchos::RCP<(NOX::Epetra::Interface::Required)> i, 
    Vector initialGuess, 
    Teuchos::RCP<(Epetra_CrsGraph)> g, double beta = 1.0e-6, 
    double alpha = 1.0e-4) -> FiniteDifference
__init__(self, ParameterList printingParams, Teuchos::RCP<(NOX::Epetra::Interface::Required)> i, 
    Vector initialGuess, 
    Teuchos::RCP<(Epetra_CrsGraph)> g, Teuchos::RCP<(q(const).Epetra_Vector)> beta, 
    double alpha = 1.0e-4) -> FiniteDifference

FiniteDifference::FiniteDifference(Teuchos::ParameterList
&printingParams, const Teuchos::RCP< NOX::Epetra::Interface::Required
> &i, const NOX::Epetra::Vector &initialGuess, const Teuchos::RCP<
Epetra_CrsGraph > &g, const Teuchos::RCP< const Epetra_Vector > &beta,
double alpha=1.0e-4)

Constructor with output control that takes a pre-constructed
Epetra_CrsGraph so it does not have to determine the non-zero entries
in the matrix. 

Reimplemented from PyTrilinos::NOX::Epetra::Interface::Jacobian.

Reimplemented in PyTrilinos::NOX::Epetra::FiniteDifferenceColoring, and PyTrilinos::NOX::Epetra::FiniteDifferenceColoring.

def PyTrilinos::NOX::Epetra::FiniteDifference::__init__ (   self,
  args 
)

__init__(self, ParameterList printingParams, Teuchos::RCP<(NOX::Epetra::Interface::Required)> i, 
    Vector initialGuess, 
    double beta = 1.0e-6, double alpha = 1.0e-4) -> FiniteDifference
__init__(self, ParameterList printingParams, Teuchos::RCP<(NOX::Epetra::Interface::Required)> i, 
    Vector initialGuess, 
    Teuchos::RCP<(q(const).Epetra_Vector)> beta, 
    double alpha = 1.0e-4) -> FiniteDifference
__init__(self, ParameterList printingParams, Teuchos::RCP<(NOX::Epetra::Interface::Required)> i, 
    Vector initialGuess, 
    Teuchos::RCP<(Epetra_CrsGraph)> g, double beta = 1.0e-6, 
    double alpha = 1.0e-4) -> FiniteDifference
__init__(self, ParameterList printingParams, Teuchos::RCP<(NOX::Epetra::Interface::Required)> i, 
    Vector initialGuess, 
    Teuchos::RCP<(Epetra_CrsGraph)> g, Teuchos::RCP<(q(const).Epetra_Vector)> beta, 
    double alpha = 1.0e-4) -> FiniteDifference

FiniteDifference::FiniteDifference(Teuchos::ParameterList
&printingParams, const Teuchos::RCP< NOX::Epetra::Interface::Required
> &i, const NOX::Epetra::Vector &initialGuess, const Teuchos::RCP<
Epetra_CrsGraph > &g, const Teuchos::RCP< const Epetra_Vector > &beta,
double alpha=1.0e-4)

Constructor with output control that takes a pre-constructed
Epetra_CrsGraph so it does not have to determine the non-zero entries
in the matrix. 

Reimplemented from PyTrilinos::NOX::Epetra::Interface::Jacobian.

Reimplemented in PyTrilinos::NOX::Epetra::FiniteDifferenceColoring, and PyTrilinos::NOX::Epetra::FiniteDifferenceColoring.

def PyTrilinos::NOX::Epetra::FiniteDifference::Apply (   self,
  args 
)

Apply(self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int
FiniteDifference::Apply(const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

Return the result on an Epetra_Operator applied to an
Epetra_MultiVector X in Y. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Apply (   self,
  args 
)

Apply(self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int
FiniteDifference::Apply(const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

Return the result on an Epetra_Operator applied to an
Epetra_MultiVector X in Y. 

def PyTrilinos::NOX::Epetra::FiniteDifference::ApplyInverse (   self,
  args 
)

ApplyInverse(self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int FiniteDifference::ApplyInverse(const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

Return the result on an Epetra_Operator inverse applied to an
Epetra_MultiVector X in Y. 

def PyTrilinos::NOX::Epetra::FiniteDifference::ApplyInverse (   self,
  args 
)

ApplyInverse(self, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int FiniteDifference::ApplyInverse(const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

Return the result on an Epetra_Operator inverse applied to an
Epetra_MultiVector X in Y. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Comm (   self,
  args 
)

Comm(self) -> Epetra_Comm

const
Epetra_Comm & FiniteDifference::Comm() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Comm (   self,
  args 
)

Comm(self) -> Epetra_Comm

const
Epetra_Comm & FiniteDifference::Comm() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::computeJacobian (   self,
  args 
)

computeJacobian(self, Epetra_Vector x, Epetra_Operator Jac) -> bool
computeJacobian(self, Epetra_Vector x) -> bool

bool FiniteDifference::computeJacobian(const Epetra_Vector &x)

Compute Jacobian given the specified input vector, x. Returns true if
computation was successful. 

Reimplemented from PyTrilinos::NOX::Epetra::Interface::Jacobian.

Reimplemented in PyTrilinos::NOX::Epetra::FiniteDifferenceColoring, and PyTrilinos::NOX::Epetra::FiniteDifferenceColoring.

def PyTrilinos::NOX::Epetra::FiniteDifference::computeJacobian (   self,
  args 
)

computeJacobian(self, Epetra_Vector x, Epetra_Operator Jac) -> bool
computeJacobian(self, Epetra_Vector x) -> bool

bool FiniteDifference::computeJacobian(const Epetra_Vector &x)

Compute Jacobian given the specified input vector, x. Returns true if
computation was successful. 

Reimplemented from PyTrilinos::NOX::Epetra::Interface::Jacobian.

Reimplemented in PyTrilinos::NOX::Epetra::FiniteDifferenceColoring, and PyTrilinos::NOX::Epetra::FiniteDifferenceColoring.

def PyTrilinos::NOX::Epetra::FiniteDifference::computePreconditioner (   self,
  args 
)

computePreconditioner(self, Epetra_Vector x, Epetra_Operator Prec, ParameterList precParams = None) -> bool

bool
FiniteDifference::computePreconditioner(const Epetra_Vector &x,
Epetra_Operator &Prec, Teuchos::ParameterList *precParams=0)

Compute an Epetra_RowMatrix to be used by Aztec preconditioners given
the specified input vector, x. Returns true if computation was
successful. 

Reimplemented from PyTrilinos::NOX::Epetra::Interface::Preconditioner.

def PyTrilinos::NOX::Epetra::FiniteDifference::computePreconditioner (   self,
  args 
)

computePreconditioner(self, Epetra_Vector x, Epetra_Operator Prec, ParameterList precParams = None) -> bool

bool
FiniteDifference::computePreconditioner(const Epetra_Vector &x,
Epetra_Operator &Prec, Teuchos::ParameterList *precParams=0)

Compute an Epetra_RowMatrix to be used by Aztec preconditioners given
the specified input vector, x. Returns true if computation was
successful. 

Reimplemented from PyTrilinos::NOX::Epetra::Interface::Preconditioner.

def PyTrilinos::NOX::Epetra::FiniteDifference::ExtractDiagonalCopy (   self,
  args 
)

ExtractDiagonalCopy(self, Epetra_Vector Diagonal) -> int

int
FiniteDifference::ExtractDiagonalCopy(Epetra_Vector &Diagonal) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::ExtractDiagonalCopy (   self,
  args 
)

ExtractDiagonalCopy(self, Epetra_Vector Diagonal) -> int

int
FiniteDifference::ExtractDiagonalCopy(Epetra_Vector &Diagonal) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::ExtractMyRowCopy (   self,
  args 
)

ExtractMyRowCopy(self, int MyRow, int Length, int NumEntries, double Values, 
    int Indices) -> int

int FiniteDifference::ExtractMyRowCopy(int MyRow, int Length, int
&NumEntries, double *Values, int *Indices) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::ExtractMyRowCopy (   self,
  args 
)

ExtractMyRowCopy(self, int MyRow, int Length, int NumEntries, double Values, 
    int Indices) -> int

int FiniteDifference::ExtractMyRowCopy(int MyRow, int Length, int
&NumEntries, double *Values, int *Indices) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Filled (   self,
  args 
)

Filled(self) -> bool

bool
FiniteDifference::Filled() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Filled (   self,
  args 
)

Filled(self) -> bool

bool
FiniteDifference::Filled() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::getUnderlyingMatrix (   self,
  args 
)

getUnderlyingMatrix(self) -> Epetra_CrsMatrix

Epetra_CrsMatrix
& FiniteDifference::getUnderlyingMatrix() const

An accessor method for the underlying Epetra_CrsMatrix. 

def PyTrilinos::NOX::Epetra::FiniteDifference::getUnderlyingMatrix (   self,
  args 
)

getUnderlyingMatrix(self) -> Epetra_CrsMatrix

Epetra_CrsMatrix
& FiniteDifference::getUnderlyingMatrix() const

An accessor method for the underlying Epetra_CrsMatrix. 

def PyTrilinos::NOX::Epetra::FiniteDifference::HasNormInf (   self,
  args 
)

HasNormInf(self) -> bool

bool FiniteDifference::HasNormInf() const

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

def PyTrilinos::NOX::Epetra::FiniteDifference::HasNormInf (   self,
  args 
)

HasNormInf(self) -> bool

bool FiniteDifference::HasNormInf() const

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

def PyTrilinos::NOX::Epetra::FiniteDifference::InvColSums (   self,
  args 
)

InvColSums(self, Epetra_Vector x) -> int

int
FiniteDifference::InvColSums(Epetra_Vector &x) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::InvColSums (   self,
  args 
)

InvColSums(self, Epetra_Vector x) -> int

int
FiniteDifference::InvColSums(Epetra_Vector &x) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::InvRowSums (   self,
  args 
)

InvRowSums(self, Epetra_Vector x) -> int

int
FiniteDifference::InvRowSums(Epetra_Vector &x) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::InvRowSums (   self,
  args 
)

InvRowSums(self, Epetra_Vector x) -> int

int
FiniteDifference::InvRowSums(Epetra_Vector &x) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Label (   self,
  args 
)

Label(self) -> char

const
char * FiniteDifference::Label() const

Returns a character string describing the name of the operator. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Label (   self,
  args 
)

Label(self) -> char

const
char * FiniteDifference::Label() const

Returns a character string describing the name of the operator. 

def PyTrilinos::NOX::Epetra::FiniteDifference::LeftScale (   self,
  args 
)

LeftScale(self, Epetra_Vector x) -> int

int
FiniteDifference::LeftScale(const Epetra_Vector &x)

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::LeftScale (   self,
  args 
)

LeftScale(self, Epetra_Vector x) -> int

int
FiniteDifference::LeftScale(const Epetra_Vector &x)

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::LowerTriangular (   self,
  args 
)

LowerTriangular(self) -> bool

bool FiniteDifference::LowerTriangular() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::LowerTriangular (   self,
  args 
)

LowerTriangular(self) -> bool

bool FiniteDifference::LowerTriangular() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Map (   self,
  args 
)

Map(self) -> Epetra_BlockMap

const
Epetra_BlockMap & FiniteDifference::Map() const

See Epetra_SrcDistObj documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Map (   self,
  args 
)

Map(self) -> Epetra_BlockMap

const
Epetra_BlockMap & FiniteDifference::Map() const

See Epetra_SrcDistObj documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::MaxNumEntries (   self,
  args 
)

MaxNumEntries(self) -> int

int FiniteDifference::MaxNumEntries() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::MaxNumEntries (   self,
  args 
)

MaxNumEntries(self) -> int

int FiniteDifference::MaxNumEntries() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Multiply (   self,
  args 
)

Multiply(self, bool TransA, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int
FiniteDifference::Multiply(bool TransA, const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Multiply (   self,
  args 
)

Multiply(self, bool TransA, Epetra_MultiVector X, Epetra_MultiVector Y) -> int

int
FiniteDifference::Multiply(bool TransA, const Epetra_MultiVector &X,
Epetra_MultiVector &Y) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NormInf (   self,
  args 
)

NormInf(self) -> double

double
FiniteDifference::NormInf() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NormInf (   self,
  args 
)

NormInf(self) -> double

double
FiniteDifference::NormInf() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NormOne (   self,
  args 
)

NormOne(self) -> double

double
FiniteDifference::NormOne() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NormOne (   self,
  args 
)

NormOne(self) -> double

double
FiniteDifference::NormOne() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumGlobalCols (   self,
  args 
)

NumGlobalCols(self) -> int

int FiniteDifference::NumGlobalCols() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumGlobalCols (   self,
  args 
)

NumGlobalCols(self) -> int

int FiniteDifference::NumGlobalCols() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumGlobalDiagonals (   self,
  args 
)

NumGlobalDiagonals(self) -> int

int
FiniteDifference::NumGlobalDiagonals() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumGlobalDiagonals (   self,
  args 
)

NumGlobalDiagonals(self) -> int

int
FiniteDifference::NumGlobalDiagonals() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumGlobalNonzeros (   self,
  args 
)

NumGlobalNonzeros(self) -> int

int
FiniteDifference::NumGlobalNonzeros() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumGlobalNonzeros (   self,
  args 
)

NumGlobalNonzeros(self) -> int

int
FiniteDifference::NumGlobalNonzeros() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumGlobalRows (   self,
  args 
)

NumGlobalRows(self) -> int

int FiniteDifference::NumGlobalRows() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumGlobalRows (   self,
  args 
)

NumGlobalRows(self) -> int

int FiniteDifference::NumGlobalRows() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumMyCols (   self,
  args 
)

NumMyCols(self) -> int

int
FiniteDifference::NumMyCols() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumMyCols (   self,
  args 
)

NumMyCols(self) -> int

int
FiniteDifference::NumMyCols() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumMyDiagonals (   self,
  args 
)

NumMyDiagonals(self) -> int

int FiniteDifference::NumMyDiagonals() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumMyDiagonals (   self,
  args 
)

NumMyDiagonals(self) -> int

int FiniteDifference::NumMyDiagonals() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumMyNonzeros (   self,
  args 
)

NumMyNonzeros(self) -> int

int FiniteDifference::NumMyNonzeros() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumMyNonzeros (   self,
  args 
)

NumMyNonzeros(self) -> int

int FiniteDifference::NumMyNonzeros() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumMyRowEntries (   self,
  args 
)

NumMyRowEntries(self, int MyRow, int NumEntries) -> int

int FiniteDifference::NumMyRowEntries(int MyRow, int &NumEntries)
const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumMyRowEntries (   self,
  args 
)

NumMyRowEntries(self, int MyRow, int NumEntries) -> int

int FiniteDifference::NumMyRowEntries(int MyRow, int &NumEntries)
const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumMyRows (   self,
  args 
)

NumMyRows(self) -> int

int
FiniteDifference::NumMyRows() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::NumMyRows (   self,
  args 
)

NumMyRows(self) -> int

int
FiniteDifference::NumMyRows() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::OperatorDomainMap (   self,
  args 
)

OperatorDomainMap(self) -> Epetra_Map

const Epetra_Map &
FiniteDifference::OperatorDomainMap() const

Returns the Epetra_BlockMap object associated with the domain of this
matrix operator. 

def PyTrilinos::NOX::Epetra::FiniteDifference::OperatorDomainMap (   self,
  args 
)

OperatorDomainMap(self) -> Epetra_Map

const Epetra_Map &
FiniteDifference::OperatorDomainMap() const

Returns the Epetra_BlockMap object associated with the domain of this
matrix operator. 

def PyTrilinos::NOX::Epetra::FiniteDifference::OperatorRangeMap (   self,
  args 
)

OperatorRangeMap(self) -> Epetra_Map

const Epetra_Map & FiniteDifference::OperatorRangeMap() const

Returns the Epetra_BlockMap object associated with the range of this
matrix operator. 

def PyTrilinos::NOX::Epetra::FiniteDifference::OperatorRangeMap (   self,
  args 
)

OperatorRangeMap(self) -> Epetra_Map

const Epetra_Map & FiniteDifference::OperatorRangeMap() const

Returns the Epetra_BlockMap object associated with the range of this
matrix operator. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Print (   self,
  args 
)

Print(self, ostream arg0)

void
FiniteDifference::Print(ostream &) const

Output the underlying matrix. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Print (   self,
  args 
)

Print(self, ostream arg0)

void
FiniteDifference::Print(ostream &) const

Output the underlying matrix. 

def PyTrilinos::NOX::Epetra::FiniteDifference::RightScale (   self,
  args 
)

RightScale(self, Epetra_Vector x) -> int

int
FiniteDifference::RightScale(const Epetra_Vector &x)

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::RightScale (   self,
  args 
)

RightScale(self, Epetra_Vector x) -> int

int
FiniteDifference::RightScale(const Epetra_Vector &x)

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::RowMatrixColMap (   self,
  args 
)

RowMatrixColMap(self) -> Epetra_Map

const Epetra_Map & FiniteDifference::RowMatrixColMap() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::RowMatrixColMap (   self,
  args 
)

RowMatrixColMap(self) -> Epetra_Map

const Epetra_Map & FiniteDifference::RowMatrixColMap() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::RowMatrixImporter (   self,
  args 
)

RowMatrixImporter(self) -> Epetra_Import

const Epetra_Import
* FiniteDifference::RowMatrixImporter() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::RowMatrixImporter (   self,
  args 
)

RowMatrixImporter(self) -> Epetra_Import

const Epetra_Import
* FiniteDifference::RowMatrixImporter() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::RowMatrixRowMap (   self,
  args 
)

RowMatrixRowMap(self) -> Epetra_Map

const Epetra_Map & FiniteDifference::RowMatrixRowMap() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::RowMatrixRowMap (   self,
  args 
)

RowMatrixRowMap(self) -> Epetra_Map

const Epetra_Map & FiniteDifference::RowMatrixRowMap() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::setDifferenceMethod (   self,
  args 
)

setDifferenceMethod(self, DifferenceType type)

void
FiniteDifference::setDifferenceMethod(DifferenceType type)

Set the type of perturbation method used (default is Forward). 

def PyTrilinos::NOX::Epetra::FiniteDifference::setDifferenceMethod (   self,
  args 
)

setDifferenceMethod(self, DifferenceType type)

void
FiniteDifference::setDifferenceMethod(DifferenceType type)

Set the type of perturbation method used (default is Forward). 

def PyTrilinos::NOX::Epetra::FiniteDifference::setGroupForComputeF (   self,
  args 
)

setGroupForComputeF(self, Group group)

void
FiniteDifference::setGroupForComputeF(NOX::Abstract::Group &group)

Register a NOX::Abstract::Group derived object and use the computeF()
method of that group for the perturbation instead of the
NOX::Epetra::Interface::Required::computeF() method. This is required
for LOCA to get the operators correct during homotopy. 

def PyTrilinos::NOX::Epetra::FiniteDifference::setGroupForComputeF (   self,
  args 
)

setGroupForComputeF(self, Group group)

void
FiniteDifference::setGroupForComputeF(NOX::Abstract::Group &group)

Register a NOX::Abstract::Group derived object and use the computeF()
method of that group for the perturbation instead of the
NOX::Epetra::Interface::Required::computeF() method. This is required
for LOCA to get the operators correct during homotopy. 

def PyTrilinos::NOX::Epetra::FiniteDifference::SetUseTranspose (   self,
  args 
)

SetUseTranspose(self, bool UseTranspose) -> int

int FiniteDifference::SetUseTranspose(bool UseTranspose)

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

def PyTrilinos::NOX::Epetra::FiniteDifference::SetUseTranspose (   self,
  args 
)

SetUseTranspose(self, bool UseTranspose) -> int

int FiniteDifference::SetUseTranspose(bool UseTranspose)

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

def PyTrilinos::NOX::Epetra::FiniteDifference::Solve (   self,
  args 
)

Solve(self, bool Upper, bool Trans, bool UnitDiagonal, Epetra_MultiVector X, 
    Epetra_MultiVector Y) -> int

int
FiniteDifference::Solve(bool Upper, bool Trans, bool UnitDiagonal,
const Epetra_MultiVector &X, Epetra_MultiVector &Y) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::Solve (   self,
  args 
)

Solve(self, bool Upper, bool Trans, bool UnitDiagonal, Epetra_MultiVector X, 
    Epetra_MultiVector Y) -> int

int
FiniteDifference::Solve(bool Upper, bool Trans, bool UnitDiagonal,
const Epetra_MultiVector &X, Epetra_MultiVector &Y) const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::UpperTriangular (   self,
  args 
)

UpperTriangular(self) -> bool

bool FiniteDifference::UpperTriangular() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::UpperTriangular (   self,
  args 
)

UpperTriangular(self) -> bool

bool FiniteDifference::UpperTriangular() const

See Epetra_RowMatrix documentation. 

def PyTrilinos::NOX::Epetra::FiniteDifference::UseTranspose (   self,
  args 
)

UseTranspose(self) -> bool

bool FiniteDifference::UseTranspose() const

Returns the current use transpose setting. 

def PyTrilinos::NOX::Epetra::FiniteDifference::UseTranspose (   self,
  args 
)

UseTranspose(self) -> bool

bool FiniteDifference::UseTranspose() const

Returns the current use transpose setting. 


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

Generated on Thu Dec 17 11:00:22 2009 for PyTrilinos by  doxygen 1.5.9