---

BasisFamily.h

Go to the documentation of this file.

#ifndef BASISFAMILY_H
#define BASISFAMILY_H

#include "SundanceDefs.h"

#include "TSFSmartPtr.h"
#include "BasisFamilyBase.h"


namespace Sundance
{

  using namespace TSF;
  using std::string;

  using std::ostream;

  /**
   * \ingroup UserLevelFE
   * Handle class for basis function families. You'll probably never use
   * this class or any of it's methods
   * directly; you'll instantiate one of the BasisFamilyBase subclasses
   * and pass it to somebody's constructor.
   */
  class BasisFamily
    {
    public:
      /** \name Developer-only methods */
      //@{
      /** empty ctor */
      BasisFamily();
      /** construct with a pointer to a derived class */
      BasisFamily(BasisFamilyBase* base);

      /** create from an XML object */
      static BasisFamily createBasis(const XMLObject& xml);

      /** return the order of the basis function */
      int order() const {return ptr_->order();}
      /** return an identifying name for the basis */
      const string& name() const {return ptr_->name();}

      /** test equality with another basis */
      bool operator==(const BasisFamily& other) const ;
      /** test ordering with another basis. This is needed for ranking
       * functions */
      bool operator<(const BasisFamily& other) const ;

      /** return true if the basis functions are vector-valued */
      bool isVectorBasis() const {return ptr_->isVectorBasis();}
      /** return true if the basis functions are scalar-valued */
      bool isScalarBasis() const {return ptr_->isScalarBasis();}

      /** return true if this is an empty object */
      bool isNull() const {return ptr_.isNull();}


      /** evaluate on a set of points given in reference coordinates */
      void refEval(const CellTopologyCode& cellType,
                   const TSFArray<Point>& pts,
                   const MultiIndex& deriv,
                   TSFArray<DenseSerialVector>& result) const
        {
          ptr_->refEval(cellType, pts, deriv, result);
        }

      /** get the number of nodes on a particular cell type */
      int nNodes(const CellTopologyCode& cellType) const
        {
          return ptr_->nNodes(cellType);
        }


      /**
       * assign DOF numbers for a set of function IDs on a specified cell
       */
      void setNodeNumbers(const Cell& cell,
                          const TSFArray<int>& funcID,
                          TemporaryMapper& tmpMap) const
        {
          ptr_->setNodeNumbers(cell, funcID, tmpMap);
        }


      /**
       * get the DOF numbers for a set of function IDs on a specified cell.
       */
      void getNodeNumbers(const Cell& cell,
                          const TSFArray<int>& funcID,
                          TemporaryMapper& tmpMap,
                          TSFArray<TSFArray<int> >& indices) const
        {
          ptr_->getNodeNumbers(cell, funcID, tmpMap, indices);
        }

      /**
       * find the DOF list for one of the facets of a specified cell
       */
      void getFacetDOFs(const Cell& c, int facetDim, int facetIndex,
                        const TSFArray<int>& maximalDOFs,
                        TSFArray<int>& facetDOFs) const
        {
          ptr_->getFacetDOFs(c, facetDim, facetIndex, maximalDOFs, facetDOFs);
        }

      /**
       * Find the points at the nodes. Some points may have been processed already
       * and are marked as inactive with the bool array. Inactive points are not
       * returned.
       */
      void getNodalPoints(const Cell& cell,
                          const TSFArray<bool>& activeNodes,
                          TSFArray<Point>& evalPoints) const
        {
          ptr_->getNodalPoints(cell, activeNodes, evalPoints);
        }

      /**
       * Write to XML
       */
      XMLObject toXML() const {return ptr_->toXML();}

      /** get a hash code */
      int hashCode() const {return ptr_->hashCode();}

      /** write to a string */
      string toString() const {return toXML().toString();}

      //@}
    private:
      TSFSmartPtr<BasisFamilyBase> ptr_;
    };

  /** \relates BasisFamily write to a stream */
  inline ostream& operator<<(ostream& os, const BasisFamily& basis)
    {
      return os << basis.toXML();
    }
}

namespace TSF
{
  /** \relates BasisFamily write to a string */
  inline string toString(const Sundance::BasisFamily& basis)
    {
      return basis.toString();
    }

  inline int hashCode(const Sundance::BasisFamily& basis)
    {
      return basis.hashCode();
    }
}

#endif

---

Contact:

Kevin Long (krlong@ca.sandia.gov)


Documentation generated by