FEI Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
snl_fei::RecordCollection Class Reference

#include <snl_fei_RecordCollection.hpp>

Public Member Functions

 RecordCollection (int localProc)
 
 RecordCollection (const RecordCollection &src)
 
virtual ~RecordCollection ()
 
void setIDMap (const int *localIDs_begin, const int *localIDs_end, const int *globalIDs_begin, const int *globalIDs_end)
 
void initRecords (int numIDs, const int *IDs, std::vector< fei::FieldMask * > &fieldMasks, int *recordLocalIDs=NULL)
 
void initRecords (int fieldID, int fieldSize, int numIDs, const int *IDs, std::vector< fei::FieldMask * > &fieldMasks, int *recordLocalIDs=NULL)
 
void setOwners_lowestSharing (fei::SharedIDs< int > &sharedIDs)
 
void setOwners_local ()
 
size_t getNumRecords () const
 
std::map< int, int > & getGlobalToLocalMap ()
 
const std::map< int, int > & getGlobalToLocalMap () const
 
std::vector< fei::Record< int > > & getRecords ()
 
const std::vector< fei::Record< int > > & getRecords () const
 
fei::Record< int > * getRecordWithID (int ID)
 
const fei::Record< int > * getRecordWithID (int ID) const
 
fei::Record< int > * getRecordWithLocalID (int lid)
 
const fei::Record< int > * getRecordWithLocalID (int lid) const
 
int getLocalID (int global_id) const
 
int getGlobalIndex (int ID, int fieldID, int fieldSize, int fieldOffset, int whichComponentOfField, const int *eqnNumbers)
 
int getGlobalIndexLocalID (int localID, int fieldID, int fieldSize, int fieldOffset, int whichComponentOfField, const int *eqnNumbers)
 
int getGlobalBlkIndex (int ID, int &globalBlkIndex)
 
void setDebugOutput (FEI_OSTREAM *dbgOut)
 
int getMinID () const
 
int getMaxID () const
 

Private Attributes

std::vector< fei::Record< int > > m_records
 
std::map< int, int > m_global_to_local
 
int m_minID
 
int m_maxID
 
int localProc_
 
bool debugOutput_
 
FEI_OSTREAMdbgOut_
 

Detailed Description

container for Record objects

Definition at line 32 of file snl_fei_RecordCollection.hpp.

Constructor & Destructor Documentation

◆ RecordCollection() [1/2]

snl_fei::RecordCollection::RecordCollection ( int localProc)

Constructor

Definition at line 21 of file snl_fei_RecordCollection.cpp.

References m_records.

◆ RecordCollection() [2/2]

snl_fei::RecordCollection::RecordCollection ( const RecordCollection & src)

Copy constructor

Definition at line 34 of file snl_fei_RecordCollection.cpp.

◆ ~RecordCollection()

snl_fei::RecordCollection::~RecordCollection ( )
virtual

Destructor

Definition at line 46 of file snl_fei_RecordCollection.cpp.

Member Function Documentation

◆ setIDMap()

void snl_fei::RecordCollection::setIDMap ( const int * localIDs_begin,
const int * localIDs_end,
const int * globalIDs_begin,
const int * globalIDs_end )

Definition at line 50 of file snl_fei_RecordCollection.cpp.

◆ initRecords() [1/2]

void snl_fei::RecordCollection::initRecords ( int numIDs,
const int * IDs,
std::vector< fei::FieldMask * > & fieldMasks,
int * recordLocalIDs = NULL )

◆ initRecords() [2/2]

void snl_fei::RecordCollection::initRecords ( int fieldID,
int fieldSize,
int numIDs,
const int * IDs,
std::vector< fei::FieldMask * > & fieldMasks,
int * recordLocalIDs = NULL )

◆ setOwners_lowestSharing()

void snl_fei::RecordCollection::setOwners_lowestSharing ( fei::SharedIDs< int > & sharedIDs)

◆ setOwners_local()

void snl_fei::RecordCollection::setOwners_local ( )

◆ getNumRecords()

size_t snl_fei::RecordCollection::getNumRecords ( ) const
inline

Query the number of records in this collection

Definition at line 66 of file snl_fei_RecordCollection.hpp.

References m_records.

Referenced by fei::copy_remotelyowned_ids_into_CommMap(), and fei::VectorSpace::getOwnedAndSharedIDs().

◆ getGlobalToLocalMap() [1/2]

std::map< int, int > & snl_fei::RecordCollection::getGlobalToLocalMap ( )
inline

◆ getGlobalToLocalMap() [2/2]

const std::map< int, int > & snl_fei::RecordCollection::getGlobalToLocalMap ( ) const
inline

Definition at line 75 of file snl_fei_RecordCollection.hpp.

References m_global_to_local.

◆ getRecords() [1/2]

std::vector< fei::Record< int > > & snl_fei::RecordCollection::getRecords ( )
inline

Get the vector containing the records

Definition at line 79 of file snl_fei_RecordCollection.hpp.

References m_records.

Referenced by fei::Lookup_Impl::buildDatabases(), fei::ReverseMapper::ReverseMapper(), and test_misc_RecordCollection().

◆ getRecords() [2/2]

const std::vector< fei::Record< int > > & snl_fei::RecordCollection::getRecords ( ) const
inline

Get the vector containing the records

Definition at line 85 of file snl_fei_RecordCollection.hpp.

References m_records.

◆ getRecordWithID() [1/2]

fei::Record< int > * snl_fei::RecordCollection::getRecordWithID ( int ID)

◆ getRecordWithID() [2/2]

const fei::Record< int > * snl_fei::RecordCollection::getRecordWithID ( int ID) const

Get record with the specified ID. Returns NULL if not found.

Definition at line 265 of file snl_fei_RecordCollection.cpp.

◆ getRecordWithLocalID() [1/2]

fei::Record< int > * snl_fei::RecordCollection::getRecordWithLocalID ( int lid)
inline

◆ getRecordWithLocalID() [2/2]

const fei::Record< int > * snl_fei::RecordCollection::getRecordWithLocalID ( int lid) const
inline

Definition at line 99 of file snl_fei_RecordCollection.hpp.

References m_records.

◆ getLocalID()

int snl_fei::RecordCollection::getLocalID ( int global_id) const
inline

◆ getGlobalIndex()

int snl_fei::RecordCollection::getGlobalIndex ( int ID,
int fieldID,
int fieldSize,
int fieldOffset,
int whichComponentOfField,
const int * eqnNumbers )

◆ getGlobalIndexLocalID()

int snl_fei::RecordCollection::getGlobalIndexLocalID ( int localID,
int fieldID,
int fieldSize,
int fieldOffset,
int whichComponentOfField,
const int * eqnNumbers )

◆ getGlobalBlkIndex()

int snl_fei::RecordCollection::getGlobalBlkIndex ( int ID,
int & globalBlkIndex )

Get global block-equation index for specified ID

Definition at line 276 of file snl_fei_RecordCollection.cpp.

References ERReturn, and fei::Record< GlobalIDType >::getNumber().

◆ setDebugOutput()

void snl_fei::RecordCollection::setDebugOutput ( FEI_OSTREAM * dbgOut)
inline

specify an output-stream for debug information

Definition at line 131 of file snl_fei_RecordCollection.hpp.

References dbgOut, dbgOut_, and debugOutput_.

◆ getMinID()

int snl_fei::RecordCollection::getMinID ( ) const
inline

Definition at line 137 of file snl_fei_RecordCollection.hpp.

References m_minID.

◆ getMaxID()

int snl_fei::RecordCollection::getMaxID ( ) const
inline

Definition at line 138 of file snl_fei_RecordCollection.hpp.

References m_maxID.

Member Data Documentation

◆ m_records

std::vector<fei::Record<int> > snl_fei::RecordCollection::m_records
private

◆ m_global_to_local

std::map<int,int> snl_fei::RecordCollection::m_global_to_local
private

◆ m_minID

int snl_fei::RecordCollection::m_minID
private

Definition at line 145 of file snl_fei_RecordCollection.hpp.

Referenced by getMinID().

◆ m_maxID

int snl_fei::RecordCollection::m_maxID
private

Definition at line 145 of file snl_fei_RecordCollection.hpp.

Referenced by getMaxID().

◆ localProc_

int snl_fei::RecordCollection::localProc_
private

Definition at line 147 of file snl_fei_RecordCollection.hpp.

◆ debugOutput_

bool snl_fei::RecordCollection::debugOutput_
private

Definition at line 149 of file snl_fei_RecordCollection.hpp.

Referenced by setDebugOutput().

◆ dbgOut_

FEI_OSTREAM* snl_fei::RecordCollection::dbgOut_
private

Definition at line 150 of file snl_fei_RecordCollection.hpp.

Referenced by setDebugOutput().


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