AMP::Mesh::MeshParameters Class Reference

#include <MeshParameters.h>

Public Member Functions
const AMP::AMP_MPI &	getComm () const
	Get the comm for the mesh.
std::shared_ptr< AMP::Database >	getDatabase ()
	Get the database for the mesh.
std::shared_ptr< const AMP::Database >	getDatabase () const
	Get the database for the mesh.
	MeshParameters ()
	Empty constructor.
	MeshParameters (std::shared_ptr< AMP::Database > db)
	Constructor to create the MeshParamaters from an AMP Database object.
void	setComm (const AMP::AMP_MPI &comm)
	Set the comm for the mesh.
virtual	~MeshParameters ()
	Deconstructor.

Protected Attributes
AMP::AMP_MPI	comm
	The desired communicator.
std::shared_ptr< AMP::Database >	d_db = nullptr
	A pointer to an AMP database containing the mesh info.
int	MAX_GCW_WIDTH
	The maximum ghost cell width for the mesh.

Friends
class	Mesh
	See AMP::Mesh::Mesh for Mesh class.

Detailed Description

Definition at line 15 of file MeshParameters.h.

Constructor & Destructor Documentation

MeshParameters() [1/2]

AMP::Mesh::MeshParameters::MeshParameters

(

)

Empty constructor.

MeshParameters() [2/2]

AMP::Mesh::MeshParameters::MeshParameters ( std::shared_ptr< AMP::Database >  db )

explicit

Constructor to create the MeshParamaters from an AMP Database object.

Constructor to create the MeshParamaters from an AMP Database object.

Parameters

db	Input database for constructing a mesh

~MeshParameters()

virtual AMP::Mesh::MeshParameters::~MeshParameters ( )

virtual

Deconstructor.

Member Function Documentation

getComm()

const AMP::AMP_MPI & AMP::Mesh::MeshParameters::getComm ( ) const

inline

Get the comm for the mesh.

Get the communicator for the mesh

Definition at line 39 of file MeshParameters.h.

References comm.

getDatabase() [1/2]

std::shared_ptr< AMP::Database > AMP::Mesh::MeshParameters::getDatabase

(

)

Get the database for the mesh.

getDatabase() [2/2]

std::shared_ptr< const AMP::Database > AMP::Mesh::MeshParameters::getDatabase

(

)

const

Get the database for the mesh.

setComm()

void AMP::Mesh::MeshParameters::setComm

(

const AMP::AMP_MPI &

comm

)

Set the comm for the mesh.

Set the communicator that will be used to construct the mesh

Parameters

comm	The desired communicator

Friends And Related Symbol Documentation

Mesh

friend class Mesh

friend

See AMP::Mesh::Mesh for Mesh class.

Definition at line 61 of file MeshParameters.h.

Member Data Documentation

comm

AMP::AMP_MPI AMP::Mesh::MeshParameters::comm

protected

The desired communicator.

Definition at line 55 of file MeshParameters.h.

Referenced by getComm().

d_db

std::shared_ptr<AMP::Database> AMP::Mesh::MeshParameters::d_db = nullptr

protected

A pointer to an AMP database containing the mesh info.

Definition at line 52 of file MeshParameters.h.

MAX_GCW_WIDTH

int AMP::Mesh::MeshParameters::MAX_GCW_WIDTH

protected

The maximum ghost cell width for the mesh.

Definition at line 58 of file MeshParameters.h.

---

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

• src/mesh/MeshParameters.h