PyTrilinos::NOX::Epetra::Scaling Class Reference

Inheritance diagram for PyTrilinos::NOX::Epetra::Scaling:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def addUserScaling
def addRowSumScaling
def addColSumScaling
def computeScaling
def scaleLinearSystem
def unscaleLinearSystem
def applyRightScaling
def applyLeftScaling
def __init__
def addUserScaling
def addRowSumScaling
def addColSumScaling
def computeScaling
def scaleLinearSystem
def unscaleLinearSystem
def applyRightScaling
def applyLeftScaling

Public Attributes

 this

Static Public Attributes

 Scaling_None = ___init__.Scaling_Scaling_None
 RowSum = ___init__.Scaling_RowSum
 ColSum = ___init__.Scaling_ColSum
 UserDefined = ___init__.Scaling_UserDefined
 Left = ___init__.Scaling_Left
 Right = ___init__.Scaling_Right


Detailed Description

Object to control scaling of vectors and linear systems.

Currently this assumes a diagonal scaling only! Once epetra can do
matrix-matrix multiplies we will expand this class.

C++ includes: NOX_Epetra_Scaling.H 

Member Function Documentation

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

__init__(self) -> Scaling

NOX::Epetra::Scaling::Scaling()

Constructor. 

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

__init__(self) -> Scaling

NOX::Epetra::Scaling::Scaling()

Constructor. 

def PyTrilinos::NOX::Epetra::Scaling::addColSumScaling (   self,
  args 
)

addColSumScaling(self, ScaleType type, Teuchos::RCP<(Epetra_Vector)> D)

void
NOX::Epetra::Scaling::addColSumScaling(ScaleType type, const
Teuchos::RCP< Epetra_Vector > &D)

Add "Col Sum" scaling to the scaling object. The supplied vector is
used to store the current column sum vector. 

def PyTrilinos::NOX::Epetra::Scaling::addColSumScaling (   self,
  args 
)

addColSumScaling(self, ScaleType type, Teuchos::RCP<(Epetra_Vector)> D)

void
NOX::Epetra::Scaling::addColSumScaling(ScaleType type, const
Teuchos::RCP< Epetra_Vector > &D)

Add "Col Sum" scaling to the scaling object. The supplied vector is
used to store the current column sum vector. 

def PyTrilinos::NOX::Epetra::Scaling::addRowSumScaling (   self,
  args 
)

addRowSumScaling(self, ScaleType type, Teuchos::RCP<(Epetra_Vector)> D)

void
NOX::Epetra::Scaling::addRowSumScaling(ScaleType type, const
Teuchos::RCP< Epetra_Vector > &D)

Add "Row Sum" scaling to the scaling object. The supplied vector is
used to store the current row sum vector. 

def PyTrilinos::NOX::Epetra::Scaling::addRowSumScaling (   self,
  args 
)

addRowSumScaling(self, ScaleType type, Teuchos::RCP<(Epetra_Vector)> D)

void
NOX::Epetra::Scaling::addRowSumScaling(ScaleType type, const
Teuchos::RCP< Epetra_Vector > &D)

Add "Row Sum" scaling to the scaling object. The supplied vector is
used to store the current row sum vector. 

def PyTrilinos::NOX::Epetra::Scaling::addUserScaling (   self,
  args 
)

addUserScaling(self, ScaleType type, Teuchos::RCP<(Epetra_Vector)> D)

void
NOX::Epetra::Scaling::addUserScaling(ScaleType type, const
Teuchos::RCP< Epetra_Vector > &D)

Add a user supplied diagonal scale vector to the scaling object. 

def PyTrilinos::NOX::Epetra::Scaling::addUserScaling (   self,
  args 
)

addUserScaling(self, ScaleType type, Teuchos::RCP<(Epetra_Vector)> D)

void
NOX::Epetra::Scaling::addUserScaling(ScaleType type, const
Teuchos::RCP< Epetra_Vector > &D)

Add a user supplied diagonal scale vector to the scaling object. 

def PyTrilinos::NOX::Epetra::Scaling::applyLeftScaling (   self,
  args 
)

applyLeftScaling(self, Epetra_Vector input, Epetra_Vector result)

void
NOX::Epetra::Scaling::applyLeftScaling(const Epetra_Vector &input,
Epetra_Vector &result)

Applies any LEFT scaling vectors to an input vector. 

def PyTrilinos::NOX::Epetra::Scaling::applyLeftScaling (   self,
  args 
)

applyLeftScaling(self, Epetra_Vector input, Epetra_Vector result)

void
NOX::Epetra::Scaling::applyLeftScaling(const Epetra_Vector &input,
Epetra_Vector &result)

Applies any LEFT scaling vectors to an input vector. 

def PyTrilinos::NOX::Epetra::Scaling::applyRightScaling (   self,
  args 
)

applyRightScaling(self, Epetra_Vector input, Epetra_Vector result)

void
NOX::Epetra::Scaling::applyRightScaling(const Epetra_Vector &input,
Epetra_Vector &result)

Applies any RIGHT scaling vectors to an input vector. 

def PyTrilinos::NOX::Epetra::Scaling::applyRightScaling (   self,
  args 
)

applyRightScaling(self, Epetra_Vector input, Epetra_Vector result)

void
NOX::Epetra::Scaling::applyRightScaling(const Epetra_Vector &input,
Epetra_Vector &result)

Applies any RIGHT scaling vectors to an input vector. 

def PyTrilinos::NOX::Epetra::Scaling::computeScaling (   self,
  args 
)

computeScaling(self, Epetra_LinearProblem problem)

void
NOX::Epetra::Scaling::computeScaling(const Epetra_LinearProblem
&problem)

Computes Row Sum scaling diagonal vectors. Only needs to be called if
a row or column sum scaling has been requested. 

def PyTrilinos::NOX::Epetra::Scaling::computeScaling (   self,
  args 
)

computeScaling(self, Epetra_LinearProblem problem)

void
NOX::Epetra::Scaling::computeScaling(const Epetra_LinearProblem
&problem)

Computes Row Sum scaling diagonal vectors. Only needs to be called if
a row or column sum scaling has been requested. 

def PyTrilinos::NOX::Epetra::Scaling::scaleLinearSystem (   self,
  args 
)

scaleLinearSystem(self, Epetra_LinearProblem problem)

void
NOX::Epetra::Scaling::scaleLinearSystem(Epetra_LinearProblem &problem)

Scales the linear system. 

def PyTrilinos::NOX::Epetra::Scaling::scaleLinearSystem (   self,
  args 
)

scaleLinearSystem(self, Epetra_LinearProblem problem)

void
NOX::Epetra::Scaling::scaleLinearSystem(Epetra_LinearProblem &problem)

Scales the linear system. 

def PyTrilinos::NOX::Epetra::Scaling::unscaleLinearSystem (   self,
  args 
)

unscaleLinearSystem(self, Epetra_LinearProblem problem)

void NOX::Epetra::Scaling::unscaleLinearSystem(Epetra_LinearProblem
&problem)

Remove the scaling from the linear system. 

def PyTrilinos::NOX::Epetra::Scaling::unscaleLinearSystem (   self,
  args 
)

unscaleLinearSystem(self, Epetra_LinearProblem problem)

void NOX::Epetra::Scaling::unscaleLinearSystem(Epetra_LinearProblem
&problem)

Remove the scaling from the linear system. 


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