PyTrilinos.NOX.Utils Class Reference

Inheritance diagram for PyTrilinos.NOX.Utils:

Collaboration diagram for PyTrilinos.NOX.Utils:

List of all members.

Public Member Functions
def	fill
def	__init__
def	reset
def	isPrintType
def	out
def	pout
def	err
def	perr
def	sciformat
Public Attributes
	this
Static Public Attributes
	Error = ___init__.Utils_Error
	Warning = ___init__.Utils_Warning
	OuterIteration = ___init__.Utils_OuterIteration
	InnerIteration = ___init__.Utils_InnerIteration
	Parameters = ___init__.Utils_Parameters
	Details = ___init__.Utils_Details
	OuterIterationStatusTest = ___init__.Utils_OuterIterationStatusTest
	LinearSolverDetails = ___init__.Utils_LinearSolverDetails
	TestDetails = ___init__.Utils_TestDetails
	StepperIteration = ___init__.Utils_StepperIteration
	StepperDetails = ___init__.Utils_StepperDetails
	StepperParameters = ___init__.Utils_StepperParameters
	Debug = ___init__.Utils_Debug

---

Detailed Description

Provides printing utilities.

The following parameters are valid for this class and should be
defined in the "Printing" sublist of the solver parameter list.

"Output Information" - Can be a sublist or an integer. If it is an
integer, this value is a sum of MsgType's to specify how much
information to show. Defaults to NOX::Utils::Warning +
NOX::Utils::OuterIteration + NOX::Utils::InnerIteration +
NOX::Utils::Parameters = 0xf = 15. If this is a sublist, the following
booleans are valid (set to true to enable print option): "Error"

"Warning"

"Outer Iteration"

"Inner Iteration"

"Parameters"

"Details"

"Outer Iteration StatusTest"

"Linear Solver Details"

"Test Details"

"Stepper Iteration"

"Stepper Details"

"Stepper Parameters"

"Debug"

"Output Processor" - Specifies the designated print process.
Defaults to 0.

"MyPID" - Specifies this process's ID. Defaults to 0.

"Output Precision" - Specifis the default number of decimal places
to be used when printing floating point numbers. The default is 4.

"Output Stream" - A Teuchos::RCP<std::ostream> object that will be
used for standard output.

"Error Stream" - A Teuchos::RCP<std::ostream> object that will be
used for output of error information.

The public variables should never be modified directly.

C++ includes: NOX_Utils.H 

---

Constructor & Destructor Documentation

def PyTrilinos.NOX.Utils.__init__	(		self,
			args
	)

__init__(NOX::Utils self, int outputInformation=0xf, int MyPID=0, int outputProcess=0, int outputPrecision=3, 
    Teuchos::RCP< std::ostream > const & outputStream=Teuchos::null, Teuchos::RCP< std::ostream > const & errorStream=Teuchos::null) -> Utils
__init__(NOX::Utils self, ParameterList p) -> Utils
__init__(NOX::Utils self, Utils u) -> Utils

NOX::Utils::Utils(const
NOX::Utils &u)

Copy constructor. 

---

Member Function Documentation

def PyTrilinos.NOX.Utils.err	(		self,
			args
	)

err(Utils self) -> std::ostream &

std::ostream &
NOX::Utils::err() const

Returns the error stream for printing if this is the print process. 

def PyTrilinos.NOX.Utils.fill

(

args

)

fill(int filln, char fillc='*') -> Fill

def PyTrilinos.NOX.Utils.isPrintType	(		self,
			args
	)

isPrintType(Utils self, NOX::Utils::MsgType type) -> bool

bool
NOX::Utils::isPrintType(NOX::Utils::MsgType type) const

Returns true if this is a valid print type. 

def PyTrilinos.NOX.Utils.out	(		self,
			args
	)

out(Utils self) -> std::ostream
out(Utils self, NOX::Utils::MsgType type) -> std::ostream &

std::ostream &
NOX::Utils::out(NOX::Utils::MsgType type) const

Returns the ostream for printing if this process is the print process
and the print type is valid. Returns a Teuchos::oblackholestream
otherwise. 

def PyTrilinos.NOX.Utils.perr	(		self,
			args
	)

perr(Utils self) -> std::ostream &

std::ostream &
NOX::Utils::perr() const

Returns the error stream for printing to all processors. Only use this
call if you want all processes to print to the error stream. 

def PyTrilinos.NOX.Utils.pout	(		self,
			args
	)

pout(Utils self) -> std::ostream
pout(Utils self, NOX::Utils::MsgType type) -> std::ostream &

std::ostream &
NOX::Utils::pout(NOX::Utils::MsgType type) const

Returns the ostream for printing if the print type matches. Only use
this call if you want all processes to print to the ostream for the
print type. 

def PyTrilinos.NOX.Utils.reset	(		self,
			args
	)

reset(Utils self, ParameterList p)

void
NOX::Utils::reset(Teuchos::ParameterList &p)

Reset the printing parameters. 

def PyTrilinos.NOX.Utils.sciformat

(

args

)

sciformat(double dval) -> Sci
sciformat(double dval, int prec) -> Sci

NOX::Utils::Sci
NOX::Utils::sciformat(double dval) const

Creates a Sci object which can be used in an output stream for
printing a double precision number in scientific format with an
arbitrary precision. The precision is that specificed by the Utils
object.

For example,

This is modeled after the Form and Bound_form objects in Stroustrup,
C++ Programming Langauge, 3rd ed., Chapter 21.4. 

---

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

• NOX/__init__.py