PyTrilinos::NOX::Utils Class Reference

Inheritance diagram for PyTrilinos::NOX::Utils:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::NOX::Utils:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def reset
def isPrintType
def out
def pout
def err
def perr
def __init__
def reset
def isPrintType
def out
def pout
def err
def perr

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 

Member Function Documentation

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

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

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

Copy constructor. 

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

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

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

Copy constructor. 

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

err(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::err (   self,
  args 
)

err(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::isPrintType (   self,
  args 
)

isPrintType(self, 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::isPrintType (   self,
  args 
)

isPrintType(self, 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(self) -> std::ostream
out(self, 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::out (   self,
  args 
)

out(self) -> std::ostream
out(self, 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(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::perr (   self,
  args 
)

perr(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(self) -> std::ostream
pout(self, 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::pout (   self,
  args 
)

pout(self) -> std::ostream
pout(self, 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(self, ParameterList p)

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

Reset the printing parameters. 

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

reset(self, ParameterList p)

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

Reset the printing parameters. 


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