AMP::Mesh::StructuredMeshHelper Class Reference

A class used to provide utility functions for simple structured meshes. More...

#include <StructuredMeshHelper.h>

Static Public Member Functions
static AMP::Mesh::MeshIterator	getFaceIterator (std::shared_ptr< AMP::Mesh::Mesh > mesh, int gcw, int direction)
	Get an iterator over the faces.
static AMP::Mesh::MeshIterator	getGapFaceIterator (std::shared_ptr< AMP::Mesh::Mesh > subChannel, int ghostWidth)
static AMP::Mesh::MeshIterator	getXYFaceIterator (std::shared_ptr< AMP::Mesh::Mesh > mesh, int gcw=0)
	Get an iterator over the faces in the x-y planes.
static void	getXYZCoordinates (std::shared_ptr< AMP::Mesh::Mesh > mesh, std::vector< double > &x, std::vector< double > &y, std::vector< double > &z, bool check=true)
	Get the x, y, z, coordinates of a cube mesh.
static AMP::Mesh::MeshIterator	getXZFaceIterator (std::shared_ptr< AMP::Mesh::Mesh > mesh, int gcw=0)
	Get an iterator over the faces in the x-z planes.
static AMP::Mesh::MeshIterator	getYZFaceIterator (std::shared_ptr< AMP::Mesh::Mesh > mesh, int gcw)
	Get an iterator over the faces in the y-z planes.

Detailed Description

A class used to provide utility functions for simple structured meshes.

This class provides utility routines when working with simple structured meshes in the x-y-z planes. Most of the functions require the underlying mesh to have it's nodes aligned in the x, y, and z directions.

Definition at line 17 of file StructuredMeshHelper.h.

Member Function Documentation

getFaceIterator()

static AMP::Mesh::MeshIterator AMP::Mesh::StructuredMeshHelper::getFaceIterator ( std::shared_ptr< AMP::Mesh::Mesh >  mesh, int  gcw, int  direction  )

static

Get an iterator over the faces.

For a simple mesh with nodes aligned in the x, y, z directions, this function returns an iterator of the faces that lie on the faces perpendicular to the given direction.

Parameters

mesh	Mesh that we want to use for the iterator
gcw	Desired ghost width
direction	Direction of faces to iterate

getGapFaceIterator()

static AMP::Mesh::MeshIterator AMP::Mesh::StructuredMeshHelper::getGapFaceIterator ( std::shared_ptr< AMP::Mesh::Mesh >  subChannel, int  ghostWidth  )

static

getXYFaceIterator()

static AMP::Mesh::MeshIterator AMP::Mesh::StructuredMeshHelper::getXYFaceIterator ( std::shared_ptr< AMP::Mesh::Mesh >  mesh, int  gcw = 0  )

static

Get an iterator over the faces in the x-y planes.

For a simple mesh with nodes aligned in the x, y, z directions, this function returns an iterators that lie on the x-y planes (all nodes for the given element share the same z-coordinate).

Parameters

mesh	Mesh that we want to use for the iterator
gcw	Desired ghost width

getXYZCoordinates()

static void AMP::Mesh::StructuredMeshHelper::getXYZCoordinates ( std::shared_ptr< AMP::Mesh::Mesh >  mesh, std::vector< double > &  x, std::vector< double > &  y, std::vector< double > &  z, bool  check = true  )

static

Get the x, y, z, coordinates of a cube mesh.

For a simple cube mesh with nodes aligned in the x, y, z directions, this function returns the list of the x, y, and z coordinates across all processors. This function will require communication on the mesh and will throw an error if the mesh nodes are not aligned

Parameters

mesh	Mesh that we want to use for the iterator
x	x-coordinates
y	y-coordinates
z	z-coordinates
check	Check that the total number of nodes is unchanged

getXZFaceIterator()

static AMP::Mesh::MeshIterator AMP::Mesh::StructuredMeshHelper::getXZFaceIterator ( std::shared_ptr< AMP::Mesh::Mesh >  mesh, int  gcw = 0  )

static

Get an iterator over the faces in the x-z planes.

For a simple mesh with nodes aligned in the x, y, z directions, this function returns an iterators that lie on the x-z planes (all nodes for the given element share the same y-coordinate).

Parameters

mesh	Mesh that we want to use for the iterator
gcw	Desired ghost width

getYZFaceIterator()

static AMP::Mesh::MeshIterator AMP::Mesh::StructuredMeshHelper::getYZFaceIterator ( std::shared_ptr< AMP::Mesh::Mesh >  mesh, int  gcw  )

static

Get an iterator over the faces in the y-z planes.

For a simple mesh with nodes aligned in the x, y, z directions, this function returns an iterators that lie on the y-z planes (all nodes for the given element share the same x-coordinate).

Parameters

mesh	Mesh that we want to use for the iterator
gcw	Desired ghost width

---

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

• src/mesh/StructuredMeshHelper.h