MFEM v4.9.0
Finite element discretization library
Loading...
Searching...
No Matches
Public Member Functions | List of all members
mfem::DenseTensor Class Reference

Rank 3 tensor (array of matrices) More...

#include <densemat.hpp>

Public Member Functions

 DenseTensor ()
 
 DenseTensor (int i, int j, int k)
 
 DenseTensor (real_t *d, int i, int j, int k)
 
 DenseTensor (int i, int j, int k, MemoryType mt)
 
int SizeI () const
 
int SizeJ () const
 
int SizeK () const
 
int TotalSize () const
 
void SetSize (int i, int j, int k, MemoryType mt_=MemoryType::PRESERVE)
 
void UseExternalData (real_t *ext_data, int i, int j, int k)
 
void NewMemoryAndSize (const Memory< real_t > &mem, int i, int j, int k, bool own_mem)
 Reset the DenseTensor to use the given external Memory mem and dimensions i, j, and k.
 
DenseTensor & operator= (real_t c)
 Sets the tensor elements equal to constant c.
 
DenseMatrix & operator() (int k)
 
const DenseMatrix & operator() (int k) const
 
DenseMatrix & operator() (int k, DenseMatrix &buff)
 
const DenseMatrix & operator() (int k, DenseMatrix &buff) const
 
real_t & operator() (int i, int j, int k)
 
const real_t & operator() (int i, int j, int k) const
 
real_t * GetData (int k)
 
const real_t * GetData (int k) const
 
real_t * Data ()
 
const real_t * Data () const
 
Memory< real_t > & GetMemory ()
 
const Memory< real_t > & GetMemory () const
 
void AddMult (const Table &elem_dof, const Vector &x, Vector &y) const
 
void Clear ()
 
std::size_t MemoryUsage () const
 
const real_t * Read (bool on_dev=true) const
 Shortcut for mfem::Read( GetMemory(), TotalSize(), on_dev).
 
const real_t * HostRead () const
 Shortcut for mfem::Read(GetMemory(), TotalSize(), false).
 
real_t * Write (bool on_dev=true)
 Shortcut for mfem::Write(GetMemory(), TotalSize(), on_dev).
 
real_t * HostWrite ()
 Shortcut for mfem::Write(GetMemory(), TotalSize(), false).
 
real_t * ReadWrite (bool on_dev=true)
 Shortcut for mfem::ReadWrite(GetMemory(), TotalSize(), on_dev).
 
real_t * HostReadWrite ()
 Shortcut for mfem::ReadWrite(GetMemory(), TotalSize(), false).
 
void Swap (DenseTensor &t)
 

Detailed Description

Rank 3 tensor (array of matrices)

Definition at line 1110 of file densemat.hpp.

Constructor & Destructor Documentation

◆ DenseTensor() [1/4]

mfem::DenseTensor::DenseTensor ( )
inline

Definition at line 1118 of file densemat.hpp.

◆ DenseTensor() [2/4]

mfem::DenseTensor::DenseTensor ( int i,
int j,
int k )
inline

Definition at line 1120 of file densemat.hpp.

◆ DenseTensor() [3/4]

mfem::DenseTensor::DenseTensor ( real_t * d,
int i,
int j,
int k )
inline

Definition at line 1122 of file densemat.hpp.

◆ DenseTensor() [4/4]

mfem::DenseTensor::DenseTensor ( int i,
int j,
int k,
MemoryType mt )
inline

Definition at line 1125 of file densemat.hpp.

Member Function Documentation

◆ AddMult()

void mfem::DenseTensor::AddMult ( const Table & elem_dof,
const Vector & x,
Vector & y ) const

Matrix-vector product from unassembled element matrices, assuming both 'x' and 'y' use the same elem_dof table.

Definition at line 4288 of file densemat.cpp.

◆ Clear()

void mfem::DenseTensor::Clear ( )
inline

Definition at line 1236 of file densemat.hpp.

◆ Data() [1/2]

real_t * mfem::DenseTensor::Data ( )
inline

Definition at line 1225 of file densemat.hpp.

◆ Data() [2/2]

const real_t * mfem::DenseTensor::Data ( ) const
inline

Definition at line 1227 of file densemat.hpp.

◆ GetData() [1/2]

real_t * mfem::DenseTensor::GetData ( int k)
inline

Definition at line 1213 of file densemat.hpp.

◆ GetData() [2/2]

const real_t * mfem::DenseTensor::GetData ( int k) const
inline

Definition at line 1219 of file densemat.hpp.

◆ GetMemory() [1/2]

Memory< real_t > & mfem::DenseTensor::GetMemory ( )
inline

Definition at line 1229 of file densemat.hpp.

◆ GetMemory() [2/2]

const Memory< real_t > & mfem::DenseTensor::GetMemory ( ) const
inline

Definition at line 1230 of file densemat.hpp.

◆ HostRead()

const real_t * mfem::DenseTensor::HostRead ( ) const
inline

Shortcut for mfem::Read(GetMemory(), TotalSize(), false).

Definition at line 1245 of file densemat.hpp.

◆ HostReadWrite()

real_t * mfem::DenseTensor::HostReadWrite ( )
inline

Shortcut for mfem::ReadWrite(GetMemory(), TotalSize(), false).

Definition at line 1257 of file densemat.hpp.

◆ HostWrite()

real_t * mfem::DenseTensor::HostWrite ( )
inline

Shortcut for mfem::Write(GetMemory(), TotalSize(), false).

Definition at line 1251 of file densemat.hpp.

◆ MemoryUsage()

std::size_t mfem::DenseTensor::MemoryUsage ( ) const
inline

Definition at line 1239 of file densemat.hpp.

◆ NewMemoryAndSize()

void mfem::DenseTensor::NewMemoryAndSize ( const Memory< real_t > & mem,
int i,
int j,
int k,
bool own_mem )
inline

Reset the DenseTensor to use the given external Memory mem and dimensions i, j, and k.

If own_mem is false, the DenseTensor will not own any of the pointers of mem.

Note that when own_mem is true, the mem object can be destroyed immediately by the caller but mem.Delete() should NOT be called since the DenseTensor object takes ownership of all pointers owned by mem.

Definition at line 1163 of file densemat.hpp.

◆ operator()() [1/6]

real_t & mfem::DenseTensor::operator() ( int i,
int j,
int k )
inline

Definition at line 1197 of file densemat.hpp.

◆ operator()() [2/6]

const real_t & mfem::DenseTensor::operator() ( int i,
int j,
int k ) const
inline

Definition at line 1205 of file densemat.hpp.

◆ operator()() [3/6]

DenseMatrix & mfem::DenseTensor::operator() ( int k)
inline

Definition at line 1176 of file densemat.hpp.

◆ operator()() [4/6]

const DenseMatrix & mfem::DenseTensor::operator() ( int k) const
inline

Definition at line 1180 of file densemat.hpp.

◆ operator()() [5/6]

DenseMatrix & mfem::DenseTensor::operator() ( int k,
DenseMatrix & buff )
inline

Definition at line 1184 of file densemat.hpp.

◆ operator()() [6/6]

const DenseMatrix & mfem::DenseTensor::operator() ( int k,
DenseMatrix & buff ) const
inline

Definition at line 1190 of file densemat.hpp.

◆ operator=()

DenseTensor & mfem::DenseTensor::operator= ( real_t c)

Sets the tensor elements equal to constant c.

Definition at line 4343 of file densemat.cpp.

◆ Read()

const real_t * mfem::DenseTensor::Read ( bool on_dev = true) const
inline

Shortcut for mfem::Read( GetMemory(), TotalSize(), on_dev).

Definition at line 1242 of file densemat.hpp.

◆ ReadWrite()

real_t * mfem::DenseTensor::ReadWrite ( bool on_dev = true)
inline

Shortcut for mfem::ReadWrite(GetMemory(), TotalSize(), on_dev).

Definition at line 1254 of file densemat.hpp.

◆ SetSize()

void mfem::DenseTensor::SetSize ( int i,
int j,
int k,
MemoryType mt_ = MemoryType::PRESERVE )
inline

Definition at line 1134 of file densemat.hpp.

◆ SizeI()

int mfem::DenseTensor::SizeI ( ) const
inline

Definition at line 1128 of file densemat.hpp.

◆ SizeJ()

int mfem::DenseTensor::SizeJ ( ) const
inline

Definition at line 1129 of file densemat.hpp.

◆ SizeK()

int mfem::DenseTensor::SizeK ( ) const
inline

Definition at line 1130 of file densemat.hpp.

◆ Swap()

void mfem::DenseTensor::Swap ( DenseTensor & t)
inline

Definition at line 1259 of file densemat.hpp.

◆ TotalSize()

int mfem::DenseTensor::TotalSize ( ) const
inline

Definition at line 1132 of file densemat.hpp.

◆ UseExternalData()

void mfem::DenseTensor::UseExternalData ( real_t * ext_data,
int i,
int j,
int k )
inline

Definition at line 1145 of file densemat.hpp.

◆ Write()

real_t * mfem::DenseTensor::Write ( bool on_dev = true)
inline

Shortcut for mfem::Write(GetMemory(), TotalSize(), on_dev).

Definition at line 1248 of file densemat.hpp.

The documentation for this class was generated from the following files:
Generated on Thu Dec 11 2025 11:52:57 for MFEM by doxygen 1.11.0