PyTrilinos::Epetra::Util Class Reference

Inheritance diagram for PyTrilinos::Epetra::Util:

Inheritance graph
[legend]
Collaboration diagram for PyTrilinos::Epetra::Util:

Collaboration graph
[legend]

List of all members.

Public Member Functions

def __init__
def RandomInt
def RandomDouble
def Seed
def SetSeed
def Create_Root_Map
def Create_OneToOne_Map
def Create_OneToOne_BlockMap
def Chop
def __init__
def RandomInt
def RandomDouble
def Seed
def SetSeed
def Create_Root_Map
def Create_OneToOne_Map
def Create_OneToOne_BlockMap
def Chop

Public Attributes

 this


Detailed Description

Epetra Util Wrapper Class.

The Epetra.Util class is a collection of useful functions that cut
across a broad set of other classes.  A random number generator is
provided, along with methods to set and retrieve the random-number
seed.

The random number generator is a multiplicative linear congruential
generator, with multiplier 16807 and modulus 2^31 - 1. It is based on
the algorithm described in 'Random Number Generators: Good Ones Are
Hard To Find', S. K. Park and K. W. Miller, Communications of the ACM,
vol. 31, no. 10, pp. 1192-1201.

The C++ Sort() method is not supported in python.

A static function is provided for creating a new Epetra.Map object
with 1-to-1 ownership of entries from an existing map which may have
entries that appear on multiple processors.

Epetra.Util is a serial interface only.  This is appropriate since the
standard utilities are only specified for serial execution (or shared
memory parallel).

Member Function Documentation

def PyTrilinos::Epetra::Util::__init__ (   self,
  args 
)

__init__(self) -> Util
__init__(self, Util Util) -> Util

Epetra_Util::Epetra_Util(const Epetra_Util &Util)

Epetra_Util Copy Constructor.

Makes an exact copy of an existing Epetra_Util instance. 

def PyTrilinos::Epetra::Util::__init__ (   self,
  args 
)

__init__(self) -> Util
__init__(self, Util Util) -> Util

Epetra_Util::Epetra_Util(const Epetra_Util &Util)

Epetra_Util Copy Constructor.

Makes an exact copy of an existing Epetra_Util instance. 

def PyTrilinos::Epetra::Util::Chop (   args  ) 

Chop(double Value) -> double

def PyTrilinos::Epetra::Util::Chop (   args  ) 

Chop(double Value) -> double

def PyTrilinos::Epetra::Util::Create_OneToOne_BlockMap (   args  ) 

Create_OneToOne_BlockMap(BlockMap usermap, bool high_rank_proc_owns_shared = False) -> BlockMap

def PyTrilinos::Epetra::Util::Create_OneToOne_BlockMap (   args  ) 

Create_OneToOne_BlockMap(BlockMap usermap, bool high_rank_proc_owns_shared = False) -> BlockMap

def PyTrilinos::Epetra::Util::Create_OneToOne_Map (   args  ) 

Create_OneToOne_Map(Map usermap, bool high_rank_proc_owns_shared = False) -> Map

def PyTrilinos::Epetra::Util::Create_OneToOne_Map (   args  ) 

Create_OneToOne_Map(Map usermap, bool high_rank_proc_owns_shared = False) -> Map

def PyTrilinos::Epetra::Util::Create_Root_Map (   args  ) 

Create_Root_Map(Map usermap, int root = 0) -> Map

def PyTrilinos::Epetra::Util::Create_Root_Map (   args  ) 

Create_Root_Map(Map usermap, int root = 0) -> Map

def PyTrilinos::Epetra::Util::RandomDouble (   self,
  args 
)

RandomDouble(self) -> double

double
Epetra_Util::RandomDouble()

Returns a random double on the interval (-1.0,1.0). 

def PyTrilinos::Epetra::Util::RandomDouble (   self,
  args 
)

RandomDouble(self) -> double

double
Epetra_Util::RandomDouble()

Returns a random double on the interval (-1.0,1.0). 

def PyTrilinos::Epetra::Util::RandomInt (   self,
  args 
)

RandomInt(self) -> unsigned int

unsigned int
Epetra_Util::RandomInt()

Returns a random integer on the interval (0, 2^31-1). 

def PyTrilinos::Epetra::Util::RandomInt (   self,
  args 
)

RandomInt(self) -> unsigned int

unsigned int
Epetra_Util::RandomInt()

Returns a random integer on the interval (0, 2^31-1). 

def PyTrilinos::Epetra::Util::Seed (   self,
  args 
)

Seed(self) -> unsigned int

unsigned int
Epetra_Util::Seed() const

Get seed from Random function.

Current random number seed. 

def PyTrilinos::Epetra::Util::Seed (   self,
  args 
)

Seed(self) -> unsigned int

unsigned int
Epetra_Util::Seed() const

Get seed from Random function.

Current random number seed. 

def PyTrilinos::Epetra::Util::SetSeed (   self,
  args 
)

SetSeed(self, unsigned int Seed_in) -> int

int
Epetra_Util::SetSeed(unsigned int Seed_in)

Set seed for Random function.

Parameters:
-----------

In:  Seed - An integer on the interval [1, 2^31-2]

Integer error code, set to 0 if successful. 

def PyTrilinos::Epetra::Util::SetSeed (   self,
  args 
)

SetSeed(self, unsigned int Seed_in) -> int

int
Epetra_Util::SetSeed(unsigned int Seed_in)

Set seed for Random function.

Parameters:
-----------

In:  Seed - An integer on the interval [1, 2^31-2]

Integer error code, set to 0 if successful. 


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

Generated on Thu Dec 17 11:00:20 2009 for PyTrilinos by  doxygen 1.5.9