NOX::Utils Class Reference

Provides parallel communication and printing utilities. More...

#include <NOX_Utils.H>

Inheritance diagram for NOX::Utils:

[legend]List of all members.

Public Types
enum	MsgType {   Error = 0, Warning = 0x1, OuterIteration = 0x2, InnerIteration = 0x4,   Parameters = 0x8, Details = 0x10, OuterIterationStatusTest = 0x20, LinearSolverDetails = 0x40,   TestDetails = 0x80, Debug = 0x0100 }
	Message types for printing. More...
Public Member Functions
	Utils ()
	Empty constructor.
	Utils (NOX::Parameter::List &p)
	Constructor.
	Utils (const NOX::Utils &u)
	Copy constructor.
	~Utils ()
	Destructor.
void	reset (NOX::Parameter::List &p)
	Reset the utility parameters.
bool	isPrintProcess () const
	Returns true if this is the designated print process.
bool	isPrintType (NOX::Utils::MsgType type) const
	Returns true if this is a valid print type.
bool	isPrintProcessAndType (NOX::Utils::MsgType type) const
	Returns true if this is the designated print process and this is a valid print type.
Sci	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.
Static Public Member Functions
void	setUtils (NOX::Parameter::List &p)
	Deprecated.
bool	isPrintProc ()
	Deprecated.
bool	doPrint (int printLevel)
	Deprecated.
bool	doPrint (MsgType type)
	Deprecated.
bool	doAllPrint (int printLevel)
	Deprecated.
bool	doAllPrint (MsgType type)
	Deprecated.
int	getMyPID ()
	Deprecated.
Fill	fill (int filln, char fillc= '*')
	Creates a Fill object which can be used in an output stream to insert an arbitrary number of a given character. The default character is an asterick.
Sci	sci (double dval, int prec=-1)
	Deprecated.
Sci	sciformat (double dval, int prec)
	Static version of sciformat().

---

Detailed Description

Provides parallel communication and printing utilities.

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

• "Output Information" - An integer which 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.

• "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.

The public variables should never be modified directly.

---

Member Enumeration Documentation

enum NOX::Utils::MsgType

Message types for printing. Note that each message type if a power of two - this is very important. They can be added together to specify which messages you wish to receive. Enumeration values: Error  Errors are always printed. Warning  2^0 OuterIteration  2^1 InnerIteration  2^2 Parameters  2^3 Details  2^4 OuterIterationStatusTest  2^5 LinearSolverDetails  2^6 TestDetails  2^7 Debug  2^8

---

Member Function Documentation

bool NOX::Utils::doAllPrint (  MsgType  type  )  [static]

Deprecated. Deprecated: Use isPrintCode() on instantiated object instead.

bool NOX::Utils::doAllPrint (  int  printLevel  )  [static]

Deprecated. Deprecated: Use isPrintProcessAndCode() on instantiated object instead.

bool NOX::Utils::doPrint (  MsgType  type  )  [static]

Deprecated. Deprecated: Use isPrintProcessAndCode() on instantiated object instead.

bool NOX::Utils::doPrint (  int  printLevel  )  [static]

Deprecated. Deprecated: Use isPrintProcess() on instantiated object instead.

NOX::Utils::Fill NOX::Utils::fill (  int  filln, char  fillc = '*' )  [static]

Creates a Fill object which can be used in an output stream to insert an arbitrary number of a given character. The default character is an asterick. For example, cout << Utils::fill(10) << "or" << Utils::fill(10,'-'); This is modeled after the Form and Bound_form objects in Stroustrup, C++ Programming Langauge, 3rd ed., Chapter 21.4.

int NOX::Utils::getMyPID (   )  [static]

Deprecated. Deprecated: No replacement.

bool NOX::Utils::isPrintProc (   )  [static]

Deprecated. Deprecated: Use isPrintProcess() on instantiated object instead.

NOX::Utils::Sci NOX::Utils::sci (  double  dval, int  prec = -1 )  [static]

Deprecated. Deprecated: Use sciformat() on instantiated object instead.

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, cout << Utils::sci(d) << "or" << Utils::sci(d,2); This is modeled after the Form and Bound_form objects in Stroustrup, C++ Programming Langauge, 3rd ed., Chapter 21.4.

void NOX::Utils::setUtils (  NOX::Parameter::List &  p  )  [static]

Deprecated. Deprecated: Use Utils() or reset() on instantiated object instead.

---

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

• NOX_Utils.H
• NOX_Utils.C

---