---

CellSet.h

Go to the documentation of this file.

#ifndef CELLSET_H
#define CELLSET_H

#include "SundanceDefs.h"

#include "TSFSmartPtr.h"
#include "Cell.h"
#include "CellSetBase.h"
#include "CellBlock.h"
#include "XMLObject.h"
#include "TSFArray.h"
#include "TSFNonDupArray.h"
#include "TSFHashtable.h"
#include "LogicalExpr.h"
#include "TSFTimeMonitor.h"



namespace Sundance
{

  using namespace TSF;
  using std::string;

  using std::ostream;

  class Mesh;


  /** \ingroup UserLevelGeometry
   * CellSet defines a set of cells for application of an equation or BC.
   * The class CellSet is a handle for a low-level CellSetBase object.
   */

  class CellSet
    {
    public:
      /** empty ctor */
      CellSet() : ptr_(0) {;}
      /** construct, assuming control of a CellSetBase subclass object */
      CellSet(CellSetBase* ptr);

      /* determine if a given cell is contained in this set */
      bool contains(const Cell& cell) const ;

      /**  Get lists of cells organized into blocks of identical cell types.
       * This is for use in assembling work sets. When building a DOF map,
       * use getOrderedCells() instead so that reordering is used. */
      TSFHashtable<CellTopologyCode, TSFSmartPtr<TSFArray<CellBlock> > >
        getCellBlocks(const Mesh& mesh, TSFNonDupArray<CellTopologyCode>& cellType) const ;

      /** Get a list of cells, ordered according to the
       * current reordering scheme. For use in the DOF map builder.
       * When building work sets, use getCellBlocks() instead because work sets
       * require a list of cells of identical type. */
      TSFSmartPtr<TSFArray<Cell> > getOrderedCells(const Mesh& mesh) const ;

      /** test equality */
      bool operator==(const CellSet& other) const ;

      /** relational test */
      bool operator<(const CellSet& other) const ;

      /** returns all cells that are in either this or other */
      CellSet operator+(const CellSet& other) const ;

      /** returns all cells that are in both this and other */
      CellSet operator&&(const CellSet& other) const ;

      /** returns a cell set containing all cells that are in this but not
       * in other. */
      CellSet operator-(const CellSet& other) const ;

      /** find the union of this set with another. Note: the keyword
       * "union" is reserved so we call this method join(). */
      CellSet join(const CellSet& other) const ;

      /** find intersection of this set with another */
      CellSet intersection(const CellSet& other) const ;

      /** find exclusion of this set with another */
      CellSet exclude(const CellSet& other) const ;

      /** find the complement of this set */
      CellSet complement() const ;

      /** find the subset on which the given logical expr is true */
      CellSet subset(const LogicalExpr& expr) const ;

      /** find the subset having a given label */
      CellSet labeledSubset(const string& label) const ;

      /** static method to return a MaximalCellSet object */
      static CellSet maximalCells() ;

      /** write self as XML */
      XMLObject toXML() const ;

      /** return ptr to low-level implementation. Developer use only! */
      const CellSetBase* ptr() const ;

      /** find the dimension of this cell set on the given mesh */
      int dimension(const Mesh& mesh) const ;

    private:
      TSFSmartPtr<CellSetBase> ptr_;

      static TSFTimer& cellSetTimer();
    };

  /** \relates CellSet
   * write to stream
   */
  ostream& operator<<(ostream& os, const CellSet& cellSet);


}

namespace TSF
{
  /** \relates CellSet
   * write to string
   */
  inline string toString(const Sundance::CellSet& cs)
    {
      return cs.toXML().toString();
    }
}


#endif

---

Contact:

Kevin Long (krlong@ca.sandia.gov)


Documentation generated by