Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
panzer::FaceFieldPattern Class Reference

#include <Panzer_FaceFieldPattern.hpp>

Inheritance diagram for panzer::FaceFieldPattern:
Inheritance graph
[legend]

Public Member Functions

 FaceFieldPattern ()
 
 FaceFieldPattern (const shards::CellTopology &ct)
 
virtual ~FaceFieldPattern ()
 Do nothing destructor. More...
 
void setCellTopology (const shards::CellTopology &ct)
 Set the cell topology for this field pattern. More...
 
virtual int getSubcellCount (int dim) const
 
virtual const std::vector< int > & getSubcellIndices (int dim, int cellIndex) const
 
virtual void getSubcellClosureIndices (int dim, int cellIndex, std::vector< int > &indices) const
 
virtual int getDimension () const
 
virtual shards::CellTopology getCellTopology () const
 
- Public Member Functions inherited from panzer::FieldPattern
virtual ~FieldPattern ()=0
 Do nothing destructor. More...
 
virtual int numberIds () const
 
virtual bool sameGeometry (const FieldPattern &fp) const
 
virtual bool consistentSubcells () const
 
virtual void print (std::ostream &os) const
 
virtual bool equals (const FieldPattern &fp) const
 

Public Attributes

shards::CellTopology cellTopo_
 
std::vector< std::vector< int > > FaceIndices_
 
std::vector< int > empty_
 

Detailed Description

A simple field pattern that is useful for guranteeing you can compute orientations.

Definition at line 28 of file Panzer_FaceFieldPattern.hpp.

Constructor & Destructor Documentation

panzer::FaceFieldPattern::FaceFieldPattern ( )
panzer::FaceFieldPattern::FaceFieldPattern ( const shards::CellTopology &  ct)

Definition at line 18 of file Panzer_FaceFieldPattern.cpp.

virtual panzer::FaceFieldPattern::~FaceFieldPattern ( )
inlinevirtual

Do nothing destructor.

Definition at line 36 of file Panzer_FaceFieldPattern.hpp.

Member Function Documentation

void panzer::FaceFieldPattern::setCellTopology ( const shards::CellTopology &  ct)

Set the cell topology for this field pattern.

Definition at line 23 of file Panzer_FaceFieldPattern.cpp.

int panzer::FaceFieldPattern::getSubcellCount ( int  dim) const
virtual

How many sub cells of a particular dimension are there? For instance a "hex" element as six sub cells of dimension 2 (Face type),12 sub cells of dimension one (edge type), and 8 sub cell of dimension 0.

Parameters
[in]dimDimension of the sub cell of interest
Returns
Number of sub cells of dimension dim

Implements panzer::FieldPattern.

Definition at line 37 of file Panzer_FaceFieldPattern.cpp.

const std::vector< int > & panzer::FaceFieldPattern::getSubcellIndices ( int  dim,
int  cellIndex 
) const
virtual

Get the local indices associated with a particular sub cell. The sub cell is specified through its dimension and cell index. A vector is returned that gives the indices.

Parameters
[in]dimDimension of the sub cell of interest
[in]cellIndexIndex of the sub cell (must be lest than getSubcellCount(dim) and greater than or equal to 0.
Returns
A vector of indices for the specified sub cell.

Implements panzer::FieldPattern.

Definition at line 43 of file Panzer_FaceFieldPattern.cpp.

void panzer::FaceFieldPattern::getSubcellClosureIndices ( int  dim,
int  cellIndex,
std::vector< int > &  indices 
) const
virtual

Get the set of indices that are on the sub cell. The ``closure'' means that this set includes indices of all the child sub cells as well.

Parameters
[in]dimDimension of the sub cell of interest
[in]cellIndexIndex of the sub cell (must be lest than getSubcellCount(dim) and greater than or equal to 0.
[out]indicesVector, to be overwritten, containing the closure indices on return.

Implements panzer::FieldPattern.

Definition at line 52 of file Panzer_FaceFieldPattern.cpp.

int panzer::FaceFieldPattern::getDimension ( ) const
virtual

What is the dimension of this pattern. For instance a "quad" element is two dimensional. This is a purely geometric quantity.

Implements panzer::FieldPattern.

Definition at line 58 of file Panzer_FaceFieldPattern.cpp.

virtual shards::CellTopology panzer::FaceFieldPattern::getCellTopology ( ) const
inlinevirtual

Get the cell topology associated with this field pattern.

Implements panzer::FieldPattern.

Definition at line 85 of file Panzer_FaceFieldPattern.hpp.

Member Data Documentation

shards::CellTopology panzer::FaceFieldPattern::cellTopo_

Definition at line 89 of file Panzer_FaceFieldPattern.hpp.

std::vector<std::vector<int> > panzer::FaceFieldPattern::FaceIndices_

Definition at line 90 of file Panzer_FaceFieldPattern.hpp.

std::vector<int> panzer::FaceFieldPattern::empty_

Definition at line 91 of file Panzer_FaceFieldPattern.hpp.


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