Advanced Multi-Physics (AMP)
On-Line Documentation
Public Member Functions | Private Member Functions | Private Attributes | List of all members
AMP::Discretization::multiDOFHelper Class Referencefinal

A class to manage mapping multiple DOFs to global indicies. More...

#include <MultiDOFHelper.h>

Public Member Functions

size_t begin () const
 
size_t end () const
 
std::vector< size_t > getGlobalDOF (const int manager, const std::vector< size_t > &subDOFs) const
 Convert the global to local dof.
 
const std::vector< size_t > & getLocalSize () const
 
std::vector< size_t > getSubDOF (const int manager, const std::vector< size_t > &globalDOFs) const
 Convert the local to global dof.
 
std::pair< size_t, int > globalToSub (size_t dof) const
 Convert the global to local dof.
 
 multiDOFHelper ()=default
 
 multiDOFHelper (const AMP::LinearAlgebra::VectorData &data)
 
 multiDOFHelper (const DOFManager &manager)
 
 multiDOFHelper (const multiDOFHelper &)
 
 multiDOFHelper (const std::vector< AMP::LinearAlgebra::VectorData * > &data, const AMP::AMP_MPI &comm)
 
 multiDOFHelper (const std::vector< std::shared_ptr< DOFManager > > &managers, const AMP::AMP_MPI &comm)
 
 multiDOFHelper (multiDOFHelper &&)=default
 
 multiDOFHelper (size_t)
 
size_t numGlobal () const
 
size_t numLocal () const
 
multiDOFHelperoperator= (const multiDOFHelper &)
 
multiDOFHelperoperator= (multiDOFHelper &&)=default
 
size_t subToGlobal (int manager, size_t dof) const
 Convert the local to global dof.
 
void writeHDF5 (size_t) const
 

Private Member Functions

void initialize (const AMP::AMP_MPI &comm, const AMP::Array< size_t > &data)
 
void initialize (int rank, std::vector< size_t > &&data)
 

Private Attributes

std::vector< size_t > d_begin
 
AMP::Array< size_t > d_globalOffset
 
std::vector< size_t > d_globalSize
 
std::vector< size_t > d_index
 
std::vector< size_t > d_local
 
AMP::Array< size_t > d_localOffset
 
AMP::Array< size_t > d_localSize
 
int d_rank = 0
 

Detailed Description

A class to manage mapping multiple DOFs to global indicies.

This class provides mapping between local and global DOFs for multiple DOF managers

Definition at line 21 of file MultiDOFHelper.h.

Constructor & Destructor Documentation

◆ multiDOFHelper() [1/8]

AMP::Discretization::multiDOFHelper::multiDOFHelper ( const DOFManager manager)

◆ multiDOFHelper() [2/8]

AMP::Discretization::multiDOFHelper::multiDOFHelper ( const AMP::LinearAlgebra::VectorData data)

◆ multiDOFHelper() [3/8]

AMP::Discretization::multiDOFHelper::multiDOFHelper ( const std::vector< std::shared_ptr< DOFManager > > &  managers,
const AMP::AMP_MPI comm 
)

◆ multiDOFHelper() [4/8]

AMP::Discretization::multiDOFHelper::multiDOFHelper ( const std::vector< AMP::LinearAlgebra::VectorData * > &  data,
const AMP::AMP_MPI comm 
)

◆ multiDOFHelper() [5/8]

AMP::Discretization::multiDOFHelper::multiDOFHelper ( )
default

◆ multiDOFHelper() [6/8]

AMP::Discretization::multiDOFHelper::multiDOFHelper ( multiDOFHelper &&  )
default

◆ multiDOFHelper() [7/8]

AMP::Discretization::multiDOFHelper::multiDOFHelper ( const multiDOFHelper )

◆ multiDOFHelper() [8/8]

AMP::Discretization::multiDOFHelper::multiDOFHelper ( size_t  )

Member Function Documentation

◆ begin()

size_t AMP::Discretization::multiDOFHelper::begin ( ) const
inline

Definition at line 57 of file MultiDOFHelper.h.

References d_begin, and d_rank.

◆ end()

size_t AMP::Discretization::multiDOFHelper::end ( ) const
inline

Definition at line 60 of file MultiDOFHelper.h.

References d_begin, d_local, and d_rank.

◆ getGlobalDOF()

std::vector< size_t > AMP::Discretization::multiDOFHelper::getGlobalDOF ( const int  manager,
const std::vector< size_t > &  subDOFs 
) const

Convert the global to local dof.

◆ getLocalSize()

const std::vector< size_t > & AMP::Discretization::multiDOFHelper::getLocalSize ( ) const
inline

Definition at line 63 of file MultiDOFHelper.h.

References d_local.

◆ getSubDOF()

std::vector< size_t > AMP::Discretization::multiDOFHelper::getSubDOF ( const int  manager,
const std::vector< size_t > &  globalDOFs 
) const

Convert the local to global dof.

◆ globalToSub()

std::pair< size_t, int > AMP::Discretization::multiDOFHelper::globalToSub ( size_t  dof) const

Convert the global to local dof.

Referenced by AMP::Discretization::multiDOFManager::globalToSub().

◆ initialize() [1/2]

void AMP::Discretization::multiDOFHelper::initialize ( const AMP::AMP_MPI comm,
const AMP::Array< size_t > &  data 
)
private

◆ initialize() [2/2]

void AMP::Discretization::multiDOFHelper::initialize ( int  rank,
std::vector< size_t > &&  data 
)
private

◆ numGlobal()

size_t AMP::Discretization::multiDOFHelper::numGlobal ( ) const
inline

Definition at line 54 of file MultiDOFHelper.h.

References d_begin, and d_local.

◆ numLocal()

size_t AMP::Discretization::multiDOFHelper::numLocal ( ) const
inline

Definition at line 51 of file MultiDOFHelper.h.

References d_local, and d_rank.

◆ operator=() [1/2]

multiDOFHelper & AMP::Discretization::multiDOFHelper::operator= ( const multiDOFHelper )

◆ operator=() [2/2]

multiDOFHelper & AMP::Discretization::multiDOFHelper::operator= ( multiDOFHelper &&  )
default

◆ subToGlobal()

size_t AMP::Discretization::multiDOFHelper::subToGlobal ( int  manager,
size_t  dof 
) const

Convert the local to global dof.

Referenced by AMP::Discretization::multiDOFManager::subToGlobal().

◆ writeHDF5()

void AMP::Discretization::multiDOFHelper::writeHDF5 ( size_t  ) const

Member Data Documentation

◆ d_begin

std::vector<size_t> AMP::Discretization::multiDOFHelper::d_begin
private

Definition at line 85 of file MultiDOFHelper.h.

Referenced by begin(), end(), and numGlobal().

◆ d_globalOffset

AMP::Array<size_t> AMP::Discretization::multiDOFHelper::d_globalOffset
private

Definition at line 89 of file MultiDOFHelper.h.

◆ d_globalSize

std::vector<size_t> AMP::Discretization::multiDOFHelper::d_globalSize
private

Definition at line 86 of file MultiDOFHelper.h.

◆ d_index

std::vector<size_t> AMP::Discretization::multiDOFHelper::d_index
private

Definition at line 83 of file MultiDOFHelper.h.

◆ d_local

std::vector<size_t> AMP::Discretization::multiDOFHelper::d_local
private

Definition at line 84 of file MultiDOFHelper.h.

Referenced by end(), getLocalSize(), numGlobal(), and numLocal().

◆ d_localOffset

AMP::Array<size_t> AMP::Discretization::multiDOFHelper::d_localOffset
private

Definition at line 88 of file MultiDOFHelper.h.

◆ d_localSize

AMP::Array<size_t> AMP::Discretization::multiDOFHelper::d_localSize
private

Definition at line 87 of file MultiDOFHelper.h.

◆ d_rank

int AMP::Discretization::multiDOFHelper::d_rank = 0
private

Definition at line 82 of file MultiDOFHelper.h.

Referenced by begin(), end(), and numLocal().


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



Advanced Multi-Physics (AMP)
Oak Ridge National Laboratory
Idaho National Laboratory
Los Alamos National Laboratory
This page automatically produced from the
source code by doxygen
Last updated: Tue Mar 10 2026 13:06:42.
Comments on this page