---

Sundance::BasisFamily Class Reference

#include <BasisFamily.h>

List of all members.

Developer-only methods

• BasisFamily ()

  empty ctor
  
  

• BasisFamily (BasisFamilyBase *base)

  construct with a pointer to a derived class
  
  

• int order () const

  return the order of the basis function
  
  

• const string & name () const

  return an identifying name for the basis
  
  

• bool operator== (const BasisFamily &other) const

  test equality with another basis
  
  

• bool operator< (const BasisFamily &other) const

  test ordering with another basis.
  
  

• bool isVectorBasis () const

  return true if the basis functions are vector-valued
  
  

• bool isScalarBasis () const

  return true if the basis functions are scalar-valued
  
  

• bool isNull () const

  return true if this is an empty object
  
  

• void refEval (const CellTopologyCode &cellType, const TSFArray< Point > &pts, const MultiIndex &deriv, TSFArray< DenseSerialVector > &result) const

  evaluate on a set of points given in reference coordinates
  
  

• int nNodes (const CellTopologyCode &cellType) const

  get the number of nodes on a particular cell type
  
  

• void setNodeNumbers (const Cell &cell, const TSFArray< int > &funcID, TemporaryMapper &tmpMap) const

  assign 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

  get the DOF numbers for a set of function IDs on a specified cell.
  
  

• void getFacetDOFs (const Cell &c, int facetDim, int facetIndex, const TSFArray< int > &maximalDOFs, TSFArray< int > &facetDOFs) const

  find the DOF list for one of the facets of a specified cell
  
  

• void getNodalPoints (const Cell &cell, const TSFArray< bool > &activeNodes, TSFArray< Point > &evalPoints) const

  Find the points at the nodes.
  
  

• XMLObject toXML () const

  Write to XML.
  
  

• int hashCode () const

  get a hash code
  
  

• string toString () const

  write to a string
  
  

• BasisFamily createBasis (const XMLObject &xml)

  create from an XML object
  
  

Private Attributes

• TSFSmartPtr< BasisFamilyBase > ptr_

Related Functions

(Note that these are not member functions.)

• ostream & operator<< (ostream &os, const BasisFamily &basis)

  write to a stream
  
  

---

Detailed Description

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.

Definition at line 25 of file BasisFamily.h.

---

Constructor & Destructor Documentation

Sundance::BasisFamily::BasisFamily (    )

Sundance::BasisFamily::BasisFamily (  BasisFamilyBase *    base )

---

Member Function Documentation

BasisFamily Sundance::BasisFamily::createBasis (  const XMLObject &    xml )  [static]

int Sundance::BasisFamily::order (    )  const [inline]

Definition at line 39 of file BasisFamily.h. References ptr_.

const string& Sundance::BasisFamily::name (    )  const [inline]

Definition at line 41 of file BasisFamily.h. References ptr_.

bool Sundance::BasisFamily::operator== (  const BasisFamily &    other )  const

bool Sundance::BasisFamily::operator< (  const BasisFamily &    other )  const

This is needed for ranking functions

bool Sundance::BasisFamily::isVectorBasis (    )  const [inline]

Definition at line 50 of file BasisFamily.h. References ptr_.

bool Sundance::BasisFamily::isScalarBasis (    )  const [inline]

Definition at line 52 of file BasisFamily.h. References ptr_.

bool Sundance::BasisFamily::isNull (    )  const [inline]

Definition at line 55 of file BasisFamily.h. References ptr_.

void Sundance::BasisFamily::refEval (  const CellTopologyCode &    cellType, const TSFArray< Point > &    pts, const MultiIndex &    deriv, TSFArray< DenseSerialVector > &    result )  const [inline]

Definition at line 59 of file BasisFamily.h. References ptr_.

int Sundance::BasisFamily::nNodes (  const CellTopologyCode &    cellType )  const [inline]

Definition at line 68 of file BasisFamily.h. References ptr_.

void Sundance::BasisFamily::setNodeNumbers (  const Cell &    cell, const TSFArray< int > &    funcID, TemporaryMapper &    tmpMap )  const [inline]

Definition at line 77 of file BasisFamily.h. References ptr_.

void Sundance::BasisFamily::getNodeNumbers (  const Cell &    cell, const TSFArray< int > &    funcID, TemporaryMapper &    tmpMap, TSFArray< TSFArray< int > > &    indices )  const [inline]

Definition at line 88 of file BasisFamily.h. References ptr_.

void Sundance::BasisFamily::getFacetDOFs (  const Cell &    c, int    facetDim, int    facetIndex, const TSFArray< int > &    maximalDOFs, TSFArray< int > &    facetDOFs )  const [inline]

Definition at line 99 of file BasisFamily.h. References ptr_.

void Sundance::BasisFamily::getNodalPoints (  const Cell &    cell, const TSFArray< bool > &    activeNodes, TSFArray< Point > &    evalPoints )  const [inline]

Some points may have been processed already and are marked as inactive with the bool array. Inactive points are not returned. Definition at line 111 of file BasisFamily.h. References ptr_.

XMLObject Sundance::BasisFamily::toXML (    )  const [inline]

Definition at line 121 of file BasisFamily.h. References ptr_. Referenced by operator<<(), and toString().

int Sundance::BasisFamily::hashCode (    )  const [inline]

Definition at line 124 of file BasisFamily.h. References ptr_. Referenced by TSF::hashCode().

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

Definition at line 127 of file BasisFamily.h. References toXML().

---

Friends And Related Function Documentation

ostream & operator<< (  ostream &    os, const BasisFamily &    basis )  [related]

Definition at line 135 of file BasisFamily.h. References toXML().

---

Member Data Documentation

TSFSmartPtr<BasisFamilyBase> Sundance::BasisFamily::ptr_ [private]

Definition at line 131 of file BasisFamily.h. Referenced by getFacetDOFs(), getNodalPoints(), getNodeNumbers(), hashCode(), isNull(), isScalarBasis(), isVectorBasis(), name(), nNodes(), order(), refEval(), setNodeNumbers(), and toXML().

---

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

• BasisFamily.h

---

Contact:

Kevin Long (krlong@ca.sandia.gov)


Documentation generated by