---

Sundance::Mesh Class Reference

#include <Mesh.h>

List of all members.

Developer-only methods

• int meshID () const
• bool containsPoint (int globalIndex) const
• bool containsCell (int dim, int globalIndex) const
• void getBoundary (TSFArray< Cell > &bdryCells) const
• bool isBoundaryCell (int i) const
• void getLabeledCells (const string &label, TSFArray< Cell > &cells) const
• int labelIndex (const string &label) const
• const string & label (int i) const
• int numLabels () const
• int numFacets (int cellIndex, int dim) const
• int numCofacets (int cellIndex, int dim) const
• int facetIndex (int cellIndex, int dim, int facetNumber) const
• int cofacetIndex (int cellIndex, int dim, int cofacetNumber) const
• const Cell & getZeroCellByNodeIndex (int globalNodeIndex) const
• int pointGlobalIndex (int pointLocalIndex) const
• int pointOwnerProc (int pointLocalIndex) const
• const TSFArray< int > & pointSharerProcIDs (int pointLocalIndex) const
• int lookupCellByNodes (int dim, const TSFArray< int > &nodes) const
• void printCells () const
• string toString () const
• void diagnostics () const
• void assignGlobalIndices ()
• void traceCommunications ()
• void traceCommunicationsOff ()
• class BoundaryCellSet

Public Methods

• Cell cellNearestToPoint (const Point &x) const

  find the zero-cell closest to a specified point
  
  

Constructors

• Mesh ()

  Null constructor.
  
  

• Mesh (int spatialDim, const MPIComm &comm=MPIComm::world())

  Start an empty mesh of a specified spatial dimension.
  
  

• Mesh (int spatialDim, int rank, int nProc)

  Start an empty mesh of a specified spatial dimension, pretending that it is the rank-th processor of an nproc-processor parallel computer.
  
  

Informational methods

• int spatialDim () const

  Get dimension of the mesh.
  
  

• int numCells (int dim) const

  Get number of cells of dimension dim.
  
  

• int numPoints () const

  Get number of point in the mesh.
  
  

getting individual cells and points

• const Cell & getCell (int dim, int index) const

  look up a cell by its local index
  
  

• const Cell & getCellByGlobalIndex (int dim, int globalIndex) const

  look up a cell by its global index
  
  

• const Point & getPointByLocalIndex (int localIndex) const
• const Point & getPointByGlobalIndex (int globalIndex) const

Cell labeling

• void labelCells (int dim, const string &label, CellConditional conditional)

  Label all cells of dimension=dim that satisfy a condition given by a user-defined function.
  
  

• void labelMaximalCells (const string &label, const LogicalExpr &filter)

  Label all maximal cells on which the given logical expression is true.
  
  

• void labelPoints (const string &label, const LogicalExpr &filter)

  Label all zero cells on which the given logical expression is true.
  
  

• const TSFArray< string > & labels () const

  Return a list of all labels in the mesh.
  
  

Methods for creating a mesh

• int addPoint (const Point &x, int ownerProcID=0, int globalIndex=-1)

  add a point to the mesh.
  
  

• Cell createZeroCell (int globalNodeIndex, const string &label, int ownerProcID=0)

  Create a zero cell and add it to the mesh.
  
  

• Cell createMaximalCell (const CellFactory &factory, const string &label, int ownerProcID=0, int globalIndex=-1)

  Create a maximal cell.
  
  

• Cell createIntermediateCell (int parentIndex, int cellDim, int myFacetID, int pid=0)

  Create an intermediate cell and add it to the mesh.
  
  

information about parallel environment

• int procID () const

  return the local processor ID
  
  

• int numProcs () const

  return the number of processors used to model the mesh
  
  

• const MPIComm & comm () const

  get the communicator used y the
  
  

Mesh partioning

• void scatterMesh (int nProcs, const string &filename, const MeshWriter &writer) const

  Scatter a mesh into nProcs pieces, storing the n-th piece in a file called filename.n.
  
  

• Mesh getSubmesh (const MPIComm &comm=MPIComm::world()) const
• void getSubmesh (Mesh &subMesh, int myPid, int nProc, const TSFArray< short > &assignments) const
• void findProcAssignments (int nProc, TSFArray< short > &procAssignments) const

Mesh transformations

• void replacePoints (const TSFArray< Point > &points)

  replace the mesh points with a new set of points
  
  

• void transform (const MeshTransformation &trans)

  carry out an arbitrary transformation on the mesh
  
  

• void undo (const MeshTransformation &trans)

  undo a mesh transformation
  
  

• const TSFArray< Point > & getPoints () const

  get the entire array of mesh points
  
  

Private Methods

• void computeGlobalOffsets (TSFArray< int > &offsets) const
• void shareIndexRequests (int d, const TSFArray< TSFArray< int > > &indexRequestList, const TSFArray< TSFArray< int > > &localIndexList, TSFArray< TSFArray< int > > &globalIndices) const

Private Attributes

• TSFSmartPtr< MeshData > data_

Static Private Attributes

• bool traceComm_

Related Functions

(Note that these are not member functions.)

• Mesh extrudeMesh (const Mesh &inputMesh, double z0, double z1, int nz)

  Extrude a 2-dimensional mesh into the third dimension.
  
  

• Mesh findLocalSubdomain (const Mesh &globalMesh, const MPIComm &comm, CellProcessorResolver findOwner)

  find the subdomain of a global mesh that is owned by the current processor
  
  

• Mesh findLocalSubdomain (const Mesh &globalMesh, CellProcessorResolver findOwner)

  find the subdomain of a global mesh that is owned by the current processor
  
  

• Mesh serialLineMesh (double a, double b, int n)

  Meshes a line on one processor.
  
  

• Mesh lineMesh (double a, double b, int n)

  Meshes a line on one processor.
  
  

• Mesh rectMesh (double ax, double bx, int nx, double ay, double by, int ny, bool alternateDirections=true)

  Meshes a rectangle.
  
  

• Mesh quadRectMesh (double ax, double bx, int nx, double ay, double by, int ny)

  Meshes a rectangle using affine quad elements.
  
  

• Mesh lineMesh (const MPIComm &comm, double a, double b, int n)

  Meshes a line.
  
  

• int lineProcessorResolver (const Cell &c, const MPIComm &comm)

  assigns cells to processors
  
  

• int rectProcessorResolver (const Cell &c, const MPIComm &comm)

  assigns cells to processors
  
  

---

Detailed Description

Mesh represents an unstructured mesh.

Definition at line 33 of file Mesh.h.

---

Constructor & Destructor Documentation

Sundance::Mesh::Mesh (    )

Sundance::Mesh::Mesh (  int    spatialDim, const MPIComm &    comm = MPIComm::world() )

Sundance::Mesh::Mesh (  int    spatialDim, int    rank, int    nProc )

---

Member Function Documentation

int Sundance::Mesh::spatialDim (    )  const [inline]

Definition at line 51 of file Mesh.h. References data_.

int Sundance::Mesh::numCells (  int    dim )  const [inline]

Definition at line 53 of file Mesh.h. References data_.

int Sundance::Mesh::numPoints (    )  const [inline]

Definition at line 55 of file Mesh.h. References data_.

const Cell& Sundance::Mesh::getCell (  int    dim, int    index )  const

const Cell& Sundance::Mesh::getCellByGlobalIndex (  int    dim, int    globalIndex )  const

const Point& Sundance::Mesh::getPointByLocalIndex (  int    localIndex )  const

const Point& Sundance::Mesh::getPointByGlobalIndex (  int    globalIndex )  const

void Sundance::Mesh::labelCells (  int    dim, const string &    label, CellConditional    conditional )

void Sundance::Mesh::labelMaximalCells (  const string &    label, const LogicalExpr &    filter )

void Sundance::Mesh::labelPoints (  const string &    label, const LogicalExpr &    filter )

const TSFArray<string>& Sundance::Mesh::labels (    )  const [inline]

Definition at line 84 of file Mesh.h. References data_.

Cell Sundance::Mesh::cellNearestToPoint (  const Point &    x )  const

int Sundance::Mesh::addPoint (  const Point &    x, int    ownerProcID = 0, int    globalIndex = -1 )

Give the coordinates of the point, the ID of the processor that owns the point, a list of other processors that include this point, and the global index of the point

Cell Sundance::Mesh::createZeroCell (  int    globalNodeIndex, const string &    label, int    ownerProcID = 0 )

Specify the global index of the node associated with the zero cell, the label, and the ID of the processor that owns the point

Cell Sundance::Mesh::createMaximalCell (  const CellFactory &    factory, const string &    label, int    ownerProcID = 0, int    globalIndex = -1 )

Cell Sundance::Mesh::createIntermediateCell (  int    parentIndex, int    cellDim, int    myFacetID, int    pid = 0 )

int Sundance::Mesh::procID (    )  const [inline]

Definition at line 126 of file Mesh.h. References data_.

int Sundance::Mesh::numProcs (    )  const [inline]

Definition at line 128 of file Mesh.h. References data_.

const MPIComm& Sundance::Mesh::comm (    )  const [inline]

Definition at line 130 of file Mesh.h. References data_.

void Sundance::Mesh::scatterMesh (  int    nProcs, const string &    filename, const MeshWriter &    writer )  const

Mesh Sundance::Mesh::getSubmesh (  const MPIComm &    comm = MPIComm::world() )  const

void Sundance::Mesh::getSubmesh (  Mesh &    subMesh, int    myPid, int    nProc, const TSFArray< short > &    assignments )  const

void Sundance::Mesh::findProcAssignments (  int    nProc, TSFArray< short > &    procAssignments )  const

void Sundance::Mesh::replacePoints (  const TSFArray< Point > &    points )

void Sundance::Mesh::transform (  const MeshTransformation &    trans )

void Sundance::Mesh::undo (  const MeshTransformation &    trans )

const TSFArray<Point>& Sundance::Mesh::getPoints (    )  const

int Sundance::Mesh::meshID (    )  const [inline]

Definition at line 166 of file Mesh.h. References data_.

bool Sundance::Mesh::containsPoint (  int    globalIndex )  const

bool Sundance::Mesh::containsCell (  int    dim, int    globalIndex )  const

void Sundance::Mesh::getBoundary (  TSFArray< Cell > &    bdryCells )  const

bool Sundance::Mesh::isBoundaryCell (  int    i )  const [inline]

Definition at line 174 of file Mesh.h. References data_.

void Sundance::Mesh::getLabeledCells (  const string &    label, TSFArray< Cell > &    cells )  const

int Sundance::Mesh::labelIndex (  const string &    label )  const

const string& Sundance::Mesh::label (  int    i )  const

int Sundance::Mesh::numLabels (    )  const [inline]

Definition at line 181 of file Mesh.h. References data_.

int Sundance::Mesh::numFacets (  int    cellIndex, int    dim )  const

int Sundance::Mesh::numCofacets (  int    cellIndex, int    dim )  const

int Sundance::Mesh::facetIndex (  int    cellIndex, int    dim, int    facetNumber )  const

int Sundance::Mesh::cofacetIndex (  int    cellIndex, int    dim, int    cofacetNumber )  const

const Cell& Sundance::Mesh::getZeroCellByNodeIndex (  int    globalNodeIndex )  const

int Sundance::Mesh::pointGlobalIndex (  int    pointLocalIndex )  const [inline]

Definition at line 195 of file Mesh.h. References data_.

int Sundance::Mesh::pointOwnerProc (  int    pointLocalIndex )  const [inline]

Definition at line 198 of file Mesh.h. References data_.

const TSFArray<int>& Sundance::Mesh::pointSharerProcIDs (  int    pointLocalIndex )  const [inline]

Definition at line 201 of file Mesh.h. References data_.

int Sundance::Mesh::lookupCellByNodes (  int    dim, const TSFArray< int > &    nodes )  const

void Sundance::Mesh::printCells (    )  const

string Sundance::Mesh::toString (    )  const [inline]

Definition at line 208 of file Mesh.h.

void Sundance::Mesh::diagnostics (    )  const

void Sundance::Mesh::assignGlobalIndices (    )

void Sundance::Mesh::traceCommunications (    )  [inline, static]

Definition at line 213 of file Mesh.h. References traceComm_.

void Sundance::Mesh::traceCommunicationsOff (    )  [inline, static]

Definition at line 214 of file Mesh.h. References traceComm_.

void Sundance::Mesh::computeGlobalOffsets (  TSFArray< int > &    offsets )  const [private]

void Sundance::Mesh::shareIndexRequests (  int    d, const TSFArray< TSFArray< int > > &    indexRequestList, const TSFArray< TSFArray< int > > &    localIndexList, TSFArray< TSFArray< int > > &    globalIndices )  const [private]

---

Friends And Related Function Documentation

friend class BoundaryCellSet [friend]

Definition at line 216 of file Mesh.h.

Mesh extrudeMesh (  const Mesh &    inputMesh, double    z0, double    z1, int    nz )  [related]

The starting and finishing z-coordinates are z0 and z1. The number of mesh points in the z-direction is nz

Mesh findLocalSubdomain (  const Mesh &    globalMesh, const MPIComm &    comm, CellProcessorResolver    findOwner )  [related]

Mesh findLocalSubdomain (  const Mesh &    globalMesh, CellProcessorResolver    findOwner )  [related]

Definition at line 36 of file FindLocalSubdomain.h. References Sundance::CellProcessorResolver.

Mesh serialLineMesh (  double    a, double    b, int    n )  [related]

Mesh lineMesh (  double    a, double    b, int    n )  [related]

Mesh rectMesh (  double    ax, double    bx, int    nx, double    ay, double    by, int    ny, bool    alternateDirections = true )  [related]

Mesh quadRectMesh (  double    ax, double    bx, int    nx, double    ay, double    by, int    ny )  [related]

Mesh lineMesh (  const MPIComm &    comm, double    a, double    b, int    n )  [related]

int lineProcessorResolver (  const Cell &    c, const MPIComm &    comm )  [related]

int rectProcessorResolver (  const Cell &    c, const MPIComm &    comm )  [related]

---

Member Data Documentation

TSFSmartPtr<MeshData> Sundance::Mesh::data_ [private]

Definition at line 226 of file Mesh.h. Referenced by comm(), isBoundaryCell(), labels(), meshID(), numCells(), numLabels(), numPoints(), numProcs(), pointGlobalIndex(), pointOwnerProc(), pointSharerProcIDs(), procID(), and spatialDim().

bool Sundance::Mesh::traceComm_ [static, private]

Definition at line 228 of file Mesh.h. Referenced by traceCommunications(), and traceCommunicationsOff().

---

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

• Mesh.h
• ExtrudeMesh.h
• FindLocalSubdomain.h
• SimpleMeshes.h

---

Contact:

Kevin Long (krlong@ca.sandia.gov)


Documentation generated by