Epetra_Util Class Reference

Epetra_Util: The Epetra Util Wrapper Class. More...

#include <Epetra_Util.h>

List of all members.

Random number utilities

unsigned int RandomInt ()
 Returns a random integer on the interval (0, 2^31-1).
double RandomDouble ()
 Returns a random double on the interval (-1.0,1.0).
unsigned int Seed () const
 Get seed from Random function.
int SetSeed (unsigned int Seed_in)
 Set seed for Random function.

Public Member Functions

 Epetra_Util ()
 Epetra_Util Constructor.
 Epetra_Util (const Epetra_Util &Util)
 Epetra_Util Copy Constructor.
virtual ~Epetra_Util ()
 Epetra_Util Destructor.

Static Public Member Functions

static void Sort (bool SortAscending, int NumKeys, int *Keys, int NumDoubleCompanions, double **DoubleCompanions, int NumIntCompanions, int **IntCompanions)
 Epetra_Util Sort Routine (Shell sort).
static Epetra_Map Create_Root_Map (const Epetra_Map &usermap, int root=0)
 Epetra_Util Create_Root_Map function.
static Epetra_Map Create_OneToOne_Map (const Epetra_Map &usermap, bool high_rank_proc_owns_shared=false)
 Epetra_Util Create_OneToOne_Map function.
static Epetra_BlockMap Create_OneToOne_BlockMap (const Epetra_BlockMap &usermap, bool high_rank_proc_owns_shared=false)
 Epetra_Util Create_OneToOne_Map function.
static double Chop (const double &Value)
 Epetra_Util Chop method. Return zero if input Value is less than ChopValue.

Static Public Attributes

static const double chopVal_ = 1.0e-15

Private Attributes

unsigned int Seed_


Detailed Description

Epetra_Util: The Epetra Util Wrapper Class.

The Epetra_Util class is a collection of useful functions that cut across a broad set of other classes.

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

Definition at line 64 of file Epetra_Util.h.


Constructor & Destructor Documentation

Epetra_Util::Epetra_Util (  )  [inline]

Epetra_Util Constructor.

Builds an instance of a serial Util object.

Definition at line 175 of file Epetra_Util.h.

Epetra_Util::Epetra_Util ( const Epetra_Util Util  )  [inline]

Epetra_Util Copy Constructor.

Makes an exact copy of an existing Epetra_Util instance.

Definition at line 177 of file Epetra_Util.h.

Epetra_Util::~Epetra_Util (  )  [inline, virtual]

Epetra_Util Destructor.

Definition at line 179 of file Epetra_Util.h.


Member Function Documentation

unsigned int Epetra_Util::RandomInt (  ) 

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

Definition at line 45 of file Epetra_Util.cpp.

double Epetra_Util::RandomDouble (  ) 

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

Definition at line 64 of file Epetra_Util.cpp.

unsigned int Epetra_Util::Seed (  )  const

Get seed from Random function.

Returns:
Current random number seed.

Definition at line 76 of file Epetra_Util.cpp.

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]
Returns:
Integer error code, set to 0 if successful.

Definition at line 81 of file Epetra_Util.cpp.

void Epetra_Util::Sort ( bool  SortAscending,
int  NumKeys,
int *  Keys,
int  NumDoubleCompanions,
double **  DoubleCompanions,
int  NumIntCompanions,
int **  IntCompanions 
) [static]

Epetra_Util Sort Routine (Shell sort).

This function sorts a list of integer values in ascending or descending order. Additionally it sorts any number of companion lists of doubles or ints. A shell sort is used, which is fast if indices are already sorted.

Parameters:
In SortAscending - Sort keys in ascending order if true, otherwise sort in descending order..
In NumKeys - Number of integer values to be sorted.
In/Out Keys - List of integers to be sorted.
In NumDoubleCompanions - Number of lists of double precision numbers to be sorted with the key. If set to zero, DoubleCompanions is ignored and can be set to zero.
In DoubleCompanions - DoubleCompanions[i] is a pointer to the ith list of doubles to be sorted with key.
In NumIntCompanions - Number of lists of integers to be sorted with the key. If set to zero, IntCompanions is ignored and can be set to zero.
In IntCompanions - IntCompanions[i] is a pointer to the ith list of integers to be sorted with key.

Definition at line 87 of file Epetra_Util.cpp.

Epetra_Map Epetra_Util::Create_Root_Map ( const Epetra_Map usermap,
int  root = 0 
) [static]

Epetra_Util Create_Root_Map function.

Function to create a new Epetra_Map object with all GIDs sent to the root processor which is zero by default. All all processors will have no GIDs. This root map can then be used to create an importer or exporter that will migrate all data to the root processor.

If root is set to -1 then the user map will be replicated completely on all processors.

Definition at line 173 of file Epetra_Util.cpp.

Epetra_Map Epetra_Util::Create_OneToOne_Map ( const Epetra_Map usermap,
bool  high_rank_proc_owns_shared = false 
) [static]

Epetra_Util Create_OneToOne_Map function.

Function to create 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.

Definition at line 127 of file Epetra_Util.cpp.

Epetra_BlockMap Epetra_Util::Create_OneToOne_BlockMap ( const Epetra_BlockMap usermap,
bool  high_rank_proc_owns_shared = false 
) [static]

Epetra_Util Create_OneToOne_Map function.

Function to create 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.

Definition at line 248 of file Epetra_Util.cpp.

static double Epetra_Util::Chop ( const double &  Value  )  [inline, static]

Epetra_Util Chop method. Return zero if input Value is less than ChopValue.

Definition at line 162 of file Epetra_Util.h.


Member Data Documentation

const double Epetra_Util::chopVal_ = 1.0e-15 [static]

Definition at line 165 of file Epetra_Util.h.

unsigned int Epetra_Util::Seed_ [private]

Definition at line 170 of file Epetra_Util.h.


The documentation for this class was generated from the following files:
Generated on Wed May 12 21:41:09 2010 for Epetra Package Browser (Single Doxygen Collection) by  doxygen 1.4.7