PyTrilinos.NOX.Epetra.Scaling Class Reference

Inheritance diagram for PyTrilinos.NOX.Epetra.Scaling:

Collaboration diagram for PyTrilinos.NOX.Epetra.Scaling:

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
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 

---

Constructor & Destructor Documentation

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

__init__(NOX::Epetra::Scaling self) -> Scaling

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

Constructor. 

---

Member Function Documentation

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

addColSumScaling(Scaling self, NOX::Epetra::Scaling::ScaleType type, Teuchos::RCP< Epetra_Vector > const & 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(Scaling self, NOX::Epetra::Scaling::ScaleType type, Teuchos::RCP< Epetra_Vector > const & 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(Scaling self, NOX::Epetra::Scaling::ScaleType type, Teuchos::RCP< Epetra_Vector > const & 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(Scaling 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(Scaling 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(Scaling self, 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(Scaling self, LinearProblem problem)

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

Scales the linear system. 

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

unscaleLinearSystem(Scaling self, 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 file:

• NOX/Epetra/__init__.py