Chombo + EB  3.0
Public Member Functions | Private Attributes | List of all members
FaceStencil Class Reference

#include <Stencils.H>

Inheritance diagram for FaceStencil:
Inheritance graph

Public Member Functions

 FaceStencil ()
virtual ~FaceStencil ()
void clear ()
void add (const FaceIndex &face, const Real &weight, int variable=0)
virtual int size () const
void setAllVariables (int a_var)
const FaceIndexface (int i) const
virtual const Realweight (int i) const
virtual BaseIndexindex (int i) const
virtual const int & variable (int i) const
virtual int & variable (int i)
FaceStenciloperator+= (const FaceStencil &a_facesten)
FaceStenciloperator= (const FaceStencil &a_facesten)
 FaceStencil (const FaceStencil &a_facesten)
void operator*= (const Real &scaling)
- Public Member Functions inherited from BaseStencil
 BaseStencil ()
virtual ~BaseStencil ()

Private Attributes

Vector< FaceIndexfaces
 the Faces More...
Vector< Realweights
 the weights More...
Vector< int > variables
 the variable numbers More...

Detailed Description

Face-centered Stencil for embedded boundary applications.

Constructor & Destructor Documentation

◆ FaceStencil() [1/2]

FaceStencil::FaceStencil ( )

◆ ~FaceStencil()

virtual FaceStencil::~FaceStencil ( )

◆ FaceStencil() [2/2]

FaceStencil::FaceStencil ( const FaceStencil a_facesten)

Member Function Documentation

◆ clear()

void FaceStencil::clear ( )

◆ add()

void FaceStencil::add ( const FaceIndex face,
const Real weight,
int  variable = 0 

add an Face and it's weight If the face is already in the stencil, add the weights.

◆ size()

virtual int FaceStencil::size ( ) const

number of Faces in the Stencil

Implements BaseStencil.

◆ setAllVariables()

void FaceStencil::setAllVariables ( int  a_var)

References BaseStencil::weight().

◆ face()

const FaceIndex& FaceStencil::face ( int  i) const

access an Face

◆ weight()

virtual const Real& FaceStencil::weight ( int  i) const

access a weight

Implements BaseStencil.

◆ index()

virtual BaseIndex& FaceStencil::index ( int  i) const

Implements BaseStencil.

References BaseStencil::variable().

◆ variable() [1/2]

virtual const int& FaceStencil::variable ( int  i) const

Implements BaseStencil.

◆ variable() [2/2]

virtual int& FaceStencil::variable ( int  i)

◆ operator+=()

FaceStencil& FaceStencil::operator+= ( const FaceStencil a_facesten)

add all faces and weights of inputs to this. If a face is already in the stencil, add the weights. only addition is well-defined here as far as arithmatic operations are concerned.

◆ operator=()

FaceStencil& FaceStencil::operator= ( const FaceStencil a_facesten)

◆ operator*=()

void FaceStencil::operator*= ( const Real scaling)

Member Data Documentation

◆ faces

Vector<FaceIndex> FaceStencil::faces

the Faces

◆ weights

Vector<Real> FaceStencil::weights

the weights

◆ variables

Vector<int> FaceStencil::variables

the variable numbers

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