Epetra Package Browser (Single Doxygen Collection) Development
Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes
Epetra_Util Class Reference

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

#include <Epetra_Util.h>

List of all members.

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

template<typename T >
static void Sort (bool SortAscending, int NumKeys, T *Keys, int NumDoubleCompanions, double **DoubleCompanions, int NumIntCompanions, int **IntCompanions, int NumLongLongCompanions, long long **LongLongCompanions)
 Epetra_Util Sort Routine (Shell sort)
static void Sort (bool SortAscending, int NumKeys, int *Keys, int NumDoubleCompanions, double **DoubleCompanions, int NumIntCompanions, int **IntCompanions, int NumLongLongCompanions, long long **LongLongCompanions)
static void Sort (bool SortAscending, int NumKeys, long long *Keys, int NumDoubleCompanions, double **DoubleCompanions, int NumIntCompanions, int **IntCompanions, int NumLongLongCompanions, long long **LongLongCompanions)
static void Sort (bool SortAscending, int NumKeys, int *Keys, int NumDoubleCompanions, double **DoubleCompanions, int NumIntCompanions, int **IntCompanions)
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_

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.

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 77 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 205 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 207 of file Epetra_Util.h.

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

Epetra_Util Destructor.

Definition at line 209 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 65 of file Epetra_Util.cpp.

double Epetra_Util::RandomDouble ( )

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

Definition at line 84 of file Epetra_Util.cpp.

unsigned int Epetra_Util::Seed ( ) const

Get seed from Random function.

Returns:
Current random number seed.

Definition at line 96 of file Epetra_Util.cpp.

int Epetra_Util::SetSeed ( unsigned int  Seed_in)

Set seed for Random function.

Parameters:
InSeed - An integer on the interval [1, 2^31-2]
Returns:
Integer error code, set to 0 if successful.

Definition at line 101 of file Epetra_Util.cpp.

template<typename T >
void Epetra_Util::Sort ( bool  SortAscending,
int  NumKeys,
T *  Keys,
int  NumDoubleCompanions,
double **  DoubleCompanions,
int  NumIntCompanions,
int **  IntCompanions,
int  NumLongLongCompanions,
long long **  LongLongCompanions 
) [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:
InSortAscending - Sort keys in ascending order if true, otherwise sort in descending order..
InNumKeys - Number of integer values to be sorted.
In/OutKeys - List of integers to be sorted.
InNumDoubleCompanions - 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.
InDoubleCompanions - DoubleCompanions[i] is a pointer to the ith list of doubles to be sorted with key.
InNumIntCompanions - Number of lists of integers to be sorted with the key. If set to zero, IntCompanions is ignored and can be set to zero.
InIntCompanions - IntCompanions[i] is a pointer to the ith list of integers to be sorted with key.

Definition at line 108 of file Epetra_Util.cpp.

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

Definition at line 152 of file Epetra_Util.cpp.

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

Definition at line 163 of file Epetra_Util.cpp.

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

Definition at line 174 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 264 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 216 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 340 of file Epetra_Util.cpp.

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

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

Definition at line 59 of file Epetra_Util.cpp.


Member Data Documentation

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

Definition at line 197 of file Epetra_Util.h.

unsigned int Epetra_Util::Seed_ [private]

Definition at line 200 of file Epetra_Util.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines