MFEM v4.7.0
Finite element discretization library
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
mfem::Table Class Reference

#include <table.hpp>

Inheritance diagram for mfem::Table:
[legend]
Collaboration diagram for mfem::Table:
[legend]

Public Member Functions

 Table ()
 Creates an empty table.
 
 Table (const Table &)
 Copy constructor.
 
Table & operator= (const Table &rhs)
 Assignment operator: deep copy.
 
 Table (int dim, int connections_per_row=3)
 Create a table with an upper limit for the number of connections.
 
 Table (int nrows, Array< Connection > &list)
 
 Table (int nrows, int *partitioning)
 
void MakeI (int nrows)
 Next 7 methods are used together with the default constructor.
 
void AddAColumnInRow (int r)
 
void AddColumnsInRow (int r, int ncol)
 
void MakeJ ()
 
void AddConnection (int r, int c)
 
void AddConnections (int r, const int *c, int nc)
 
void ShiftUpI ()
 
void SetSize (int dim, int connections_per_row)
 Set the size and the number of connections for the table.
 
void SetDims (int rows, int nnz)
 
int Size () const
 Returns the number of TYPE I elements.
 
int Size_of_connections () const
 
int operator() (int i, int j) const
 
void GetRow (int i, Array< int > &row) const
 Return row i in array row (the Table must be finalized)
 
int RowSize (int i) const
 
const int * GetRow (int i) const
 
int * GetRow (int i)
 
int * GetI ()
 
int * GetJ ()
 
const int * GetI () const
 
const int * GetJ () const
 
Memory< int > & GetIMemory ()
 
Memory< int > & GetJMemory ()
 
const Memory< int > & GetIMemory () const
 
const Memory< int > & GetJMemory () const
 
const int * ReadI (bool on_dev=true) const
 
int * WriteI (bool on_dev=true)
 
int * ReadWriteI (bool on_dev=true)
 
const int * HostReadI () const
 
int * HostWriteI ()
 
int * HostReadWriteI ()
 
const int * ReadJ (bool on_dev=true) const
 
int * WriteJ (bool on_dev=true)
 
int * ReadWriteJ (bool on_dev=true)
 
const int * HostReadJ () const
 
int * HostWriteJ ()
 
int * HostReadWriteJ ()
 
void SortRows ()
 Sort the column (TYPE II) indices in each row.
 
void SetIJ (int *newI, int *newJ, int newsize=-1)
 Replace the I and J arrays with the given newI and newJ arrays.
 
int Push (int i, int j)
 
void Finalize ()
 
void MakeFromList (int nrows, const Array< Connection > &list)
 
int Width () const
 Returns the number of TYPE II elements (after Finalize() is called).
 
void LoseData ()
 Call this if data has been stolen.
 
void Print (std::ostream &out=mfem::out, int width=4) const
 Prints the table to stream out.
 
void PrintMatlab (std::ostream &out) const
 
void Save (std::ostream &out) const
 
void Load (std::istream &in)
 
void Copy (Table &copy) const
 
void Swap (Table &other)
 
void Clear ()
 
std::size_t MemoryUsage () const
 
 ~Table ()
 Destroys Table.
 

Protected Attributes

int size
 size is the number of TYPE I elements.
 
Memory< int > I
 
Memory< int > J
 

Detailed Description

Data type Table. Table stores the connectivity of elements of TYPE I to elements of TYPE II, for example, it may be Element-To-Face connectivity table, etc.

Definition at line 43 of file table.hpp.

Constructor & Destructor Documentation

◆ Table() [1/5]

mfem::Table::Table ( )
inline

Creates an empty table.

Definition at line 56 of file table.hpp.

◆ Table() [2/5]

mfem::Table::Table ( const Table & table)

Copy constructor.

Definition at line 27 of file table.cpp.

◆ Table() [3/5]

mfem::Table::Table ( int dim,
int connections_per_row = 3 )
explicit

Create a table with an upper limit for the number of connections.

Definition at line 50 of file table.cpp.

◆ Table() [4/5]

mfem::Table::Table ( int nrows,
Array< Connection > & list )
inline

Create a table from a list of connections, see MakeFromList().

Definition at line 68 of file table.hpp.

◆ Table() [5/5]

mfem::Table::Table ( int nrows,
int * partitioning )

Create a table with one entry per row with column indices given by 'partitioning'.

Definition at line 66 of file table.cpp.

◆ ~Table()

mfem::Table::~Table ( )

Destroys Table.

Definition at line 408 of file table.cpp.

Member Function Documentation

◆ AddAColumnInRow()

void mfem::Table::AddAColumnInRow ( int r)
inline

Definition at line 77 of file table.hpp.

◆ AddColumnsInRow()

void mfem::Table::AddColumnsInRow ( int r,
int ncol )
inline

Definition at line 78 of file table.hpp.

◆ AddConnection()

void mfem::Table::AddConnection ( int r,
int c )
inline

Definition at line 80 of file table.hpp.

◆ AddConnections()

void mfem::Table::AddConnections ( int r,
const int * c,
int nc )

Definition at line 104 of file table.cpp.

◆ Clear()

void mfem::Table::Clear ( )

Definition at line 381 of file table.cpp.

◆ Copy()

void mfem::Table::Copy ( Table & copy) const

Definition at line 390 of file table.cpp.

◆ Finalize()

void mfem::Table::Finalize ( )

Finalize the table initialization. The function may be called only once, after the table has been initialized, in order to compress array J (by getting rid of -1's in array J). Calling this function will "freeze" the table and function Push will work no more. Note: The table is functional even without calling Finalize().

Definition at line 243 of file table.cpp.

◆ GetI() [1/2]

int * mfem::Table::GetI ( )
inline

Definition at line 113 of file table.hpp.

◆ GetI() [2/2]

const int * mfem::Table::GetI ( ) const
inline

Definition at line 115 of file table.hpp.

◆ GetIMemory() [1/2]

Memory< int > & mfem::Table::GetIMemory ( )
inline

Definition at line 118 of file table.hpp.

◆ GetIMemory() [2/2]

const Memory< int > & mfem::Table::GetIMemory ( ) const
inline

Definition at line 120 of file table.hpp.

◆ GetJ() [1/2]

int * mfem::Table::GetJ ( )
inline

Definition at line 114 of file table.hpp.

◆ GetJ() [2/2]

const int * mfem::Table::GetJ ( ) const
inline

Definition at line 116 of file table.hpp.

◆ GetJMemory() [1/2]

Memory< int > & mfem::Table::GetJMemory ( )
inline

Definition at line 119 of file table.hpp.

◆ GetJMemory() [2/2]

const Memory< int > & mfem::Table::GetJMemory ( ) const
inline

Definition at line 121 of file table.hpp.

◆ GetRow() [1/3]

int * mfem::Table::GetRow ( int i)
inline

Definition at line 111 of file table.hpp.

◆ GetRow() [2/3]

const int * mfem::Table::GetRow ( int i) const
inline

Definition at line 110 of file table.hpp.

◆ GetRow() [3/3]

void mfem::Table::GetRow ( int i,
Array< int > & row ) const

Return row i in array row (the Table must be finalized)

Definition at line 187 of file table.cpp.

◆ HostReadI()

const int * mfem::Table::HostReadI ( ) const
inline

Definition at line 129 of file table.hpp.

◆ HostReadJ()

const int * mfem::Table::HostReadJ ( ) const
inline

Definition at line 142 of file table.hpp.

◆ HostReadWriteI()

int * mfem::Table::HostReadWriteI ( )
inline

Definition at line 133 of file table.hpp.

◆ HostReadWriteJ()

int * mfem::Table::HostReadWriteJ ( )
inline

Definition at line 146 of file table.hpp.

◆ HostWriteI()

int * mfem::Table::HostWriteI ( )
inline

Definition at line 131 of file table.hpp.

◆ HostWriteJ()

int * mfem::Table::HostWriteJ ( )
inline

Definition at line 144 of file table.hpp.

◆ Load()

void mfem::Table::Load ( std::istream & in)

Definition at line 362 of file table.cpp.

◆ LoseData()

void mfem::Table::LoseData ( )
inline

Call this if data has been stolen.

Definition at line 180 of file table.hpp.

◆ MakeFromList()

void mfem::Table::MakeFromList ( int nrows,
const Array< Connection > & list )

Create the table from a list of connections {(from, to)}, where 'from' is a TYPE I index and 'to' is a TYPE II index. The list is assumed to be sorted and free of duplicities, i.e., you need to call Array::Sort and Array::Unique before calling this method.

Definition at line 280 of file table.cpp.

◆ MakeI()

void mfem::Table::MakeI ( int nrows)

Next 7 methods are used together with the default constructor.

Definition at line 81 of file table.cpp.

◆ MakeJ()

void mfem::Table::MakeJ ( )

Definition at line 91 of file table.cpp.

◆ MemoryUsage()

std::size_t mfem::Table::MemoryUsage ( ) const

Definition at line 402 of file table.cpp.

◆ operator()()

int mfem::Table::operator() ( int i,
int j ) const

Returns index of the connection between element i of TYPE I and element j of TYPE II. If there is no connection between element i and element j established in the table, then the return value is -1.

Definition at line 165 of file table.cpp.

◆ operator=()

Table & mfem::Table::operator= ( const Table & rhs)

Assignment operator: deep copy.

Definition at line 40 of file table.cpp.

◆ Print()

void mfem::Table::Print ( std::ostream & out = mfem::out,
int width = 4 ) const

Prints the table to stream out.

Definition at line 311 of file table.cpp.

◆ PrintMatlab()

void mfem::Table::PrintMatlab ( std::ostream & out) const

Definition at line 333 of file table.cpp.

◆ Push()

int mfem::Table::Push ( int i,
int j )

Establish connection between element i and element j in the table. The return value is the index of the connection. It returns -1 if it fails to establish the connection. Possibilities are there is not enough memory on row i to establish connection to j, an attempt to establish new connection after calling Finalize().

Definition at line 219 of file table.cpp.

◆ ReadI()

const int * mfem::Table::ReadI ( bool on_dev = true) const
inline

Definition at line 123 of file table.hpp.

◆ ReadJ()

const int * mfem::Table::ReadJ ( bool on_dev = true) const
inline

Definition at line 136 of file table.hpp.

◆ ReadWriteI()

int * mfem::Table::ReadWriteI ( bool on_dev = true)
inline

Definition at line 127 of file table.hpp.

◆ ReadWriteJ()

int * mfem::Table::ReadWriteJ ( bool on_dev = true)
inline

Definition at line 140 of file table.hpp.

◆ RowSize()

int mfem::Table::RowSize ( int i) const
inline

Definition at line 108 of file table.hpp.

◆ Save()

void mfem::Table::Save ( std::ostream & out) const

Definition at line 348 of file table.cpp.

◆ SetDims()

void mfem::Table::SetDims ( int rows,
int nnz )

Set the rows and the number of all connections for the table. Does NOT initialize the whole array I ! (I[0]=0 and I[rows]=nnz only)

Definition at line 140 of file table.cpp.

◆ SetIJ()

void mfem::Table::SetIJ ( int * newI,
int * newJ,
int newsize = -1 )

Replace the I and J arrays with the given newI and newJ arrays.

If newsize < 0, then the size of the Table is not modified.

Definition at line 207 of file table.cpp.

◆ SetSize()

void mfem::Table::SetSize ( int dim,
int connections_per_row )

Set the size and the number of connections for the table.

Definition at line 124 of file table.cpp.

◆ ShiftUpI()

void mfem::Table::ShiftUpI ( )

Definition at line 115 of file table.cpp.

◆ Size()

int mfem::Table::Size ( ) const
inline

Returns the number of TYPE I elements.

Definition at line 92 of file table.hpp.

◆ Size_of_connections()

int mfem::Table::Size_of_connections ( ) const
inline

Returns the number of connections in the table. If Finalize() is not called, it returns the number of possible connections established by the used constructor. Otherwise, it is exactly the number of established connections before calling Finalize().

Definition at line 98 of file table.hpp.

◆ SortRows()

void mfem::Table::SortRows ( )

Sort the column (TYPE II) indices in each row.

Definition at line 199 of file table.cpp.

◆ Swap()

void mfem::Table::Swap ( Table & other)

Definition at line 395 of file table.cpp.

◆ Width()

int mfem::Table::Width ( ) const

Returns the number of TYPE II elements (after Finalize() is called).

Definition at line 301 of file table.cpp.

◆ WriteI()

int * mfem::Table::WriteI ( bool on_dev = true)
inline

Definition at line 125 of file table.hpp.

◆ WriteJ()

int * mfem::Table::WriteJ ( bool on_dev = true)
inline

Definition at line 138 of file table.hpp.

Member Data Documentation

◆ I

Memory<int> mfem::Table::I
protected

Arrays for the connectivity information in the CSR storage. I is of size "size+1", J is of size the number of connections between TYPE I to TYPE II elements (actually stored I[size]).

Definition at line 52 of file table.hpp.

◆ J

Memory<int> mfem::Table::J
protected

Definition at line 52 of file table.hpp.

◆ size

int mfem::Table::size
protected

size is the number of TYPE I elements.

Definition at line 47 of file table.hpp.

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