Advanced Multi-Physics (AMP)
On-Line Documentation
Public Member Functions | Public Attributes | Private Attributes | List of all members
AMP::LinearAlgebra::EpetraVectorEngineParameters Class Reference

Class that details how to construct an EpetraVectorEngine. More...

#include <EpetraVectorData.h>

Public Member Functions

size_t beginDOF () const
 Return the first DOF on this core.
 
 EpetraVectorEngineParameters (size_t N_local, const AMP_MPI &comm, std::shared_ptr< CommunicationList > commList)
 Constructor.
 
AMP_MPI getComm () const
 Return the Epetra_MpiComm for this engine.
 
Epetra_Map & getEpetraMap ()
 Return the Epetra_Map for this engine.
 
size_t getGlobalSize () const
 Return the local size.
 
size_t getLocalSize () const
 Return the local size.
 
virtual ~EpetraVectorEngineParameters ()
 Destructor.
 

Public Attributes

std::shared_ptr< CommunicationListd_CommList = nullptr
 The CommunicationList for a vector.
 

Private Attributes

size_t d_begin = 0
 
AMP_MPI d_comm
 
std::shared_ptr< Epetra_Map > d_emap = nullptr
 
size_t d_end = 0
 
size_t d_global = 0
 

Detailed Description

Class that details how to construct an EpetraVectorEngine.

Definition at line 18 of file EpetraVectorData.h.

Constructor & Destructor Documentation

◆ EpetraVectorEngineParameters()

AMP::LinearAlgebra::EpetraVectorEngineParameters::EpetraVectorEngineParameters ( size_t  N_local,
const AMP_MPI comm,
std::shared_ptr< CommunicationList commList 
)

Constructor.

Parameters
[in]N_localNumber of local entries
[in]commCommunicator to use
[in]commListcommunication list

◆ ~EpetraVectorEngineParameters()

virtual AMP::LinearAlgebra::EpetraVectorEngineParameters::~EpetraVectorEngineParameters ( )
virtual

Destructor.

Member Function Documentation

◆ beginDOF()

size_t AMP::LinearAlgebra::EpetraVectorEngineParameters::beginDOF ( ) const
inline

Return the first DOF on this core.

Definition at line 45 of file EpetraVectorData.h.

References d_begin.

◆ getComm()

AMP_MPI AMP::LinearAlgebra::EpetraVectorEngineParameters::getComm ( ) const
inline

Return the Epetra_MpiComm for this engine.

Returns
The Epetra_MpiComm

Definition at line 50 of file EpetraVectorData.h.

References d_comm.

◆ getEpetraMap()

Epetra_Map & AMP::LinearAlgebra::EpetraVectorEngineParameters::getEpetraMap ( )

Return the Epetra_Map for this engine.

Returns
The Epetra_Map

◆ getGlobalSize()

size_t AMP::LinearAlgebra::EpetraVectorEngineParameters::getGlobalSize ( ) const
inline

Return the local size.

Definition at line 42 of file EpetraVectorData.h.

References d_global.

◆ getLocalSize()

size_t AMP::LinearAlgebra::EpetraVectorEngineParameters::getLocalSize ( ) const
inline

Return the local size.

Definition at line 39 of file EpetraVectorData.h.

References d_begin, and d_end.

Member Data Documentation

◆ d_begin

size_t AMP::LinearAlgebra::EpetraVectorEngineParameters::d_begin = 0
private

Definition at line 56 of file EpetraVectorData.h.

Referenced by beginDOF(), and getLocalSize().

◆ d_comm

AMP_MPI AMP::LinearAlgebra::EpetraVectorEngineParameters::d_comm
private

Definition at line 59 of file EpetraVectorData.h.

Referenced by getComm().

◆ d_CommList

std::shared_ptr<CommunicationList> AMP::LinearAlgebra::EpetraVectorEngineParameters::d_CommList = nullptr

The CommunicationList for a vector.

Definition at line 53 of file EpetraVectorData.h.

◆ d_emap

std::shared_ptr<Epetra_Map> AMP::LinearAlgebra::EpetraVectorEngineParameters::d_emap = nullptr
private

Definition at line 60 of file EpetraVectorData.h.

◆ d_end

size_t AMP::LinearAlgebra::EpetraVectorEngineParameters::d_end = 0
private

Definition at line 57 of file EpetraVectorData.h.

Referenced by getLocalSize().

◆ d_global

size_t AMP::LinearAlgebra::EpetraVectorEngineParameters::d_global = 0
private

Definition at line 58 of file EpetraVectorData.h.

Referenced by getGlobalSize().


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