FEM_Ghost_Stencil Class Reference
[ParFUM Unstructured Mesh Framework]

Describes a set of required adjacent elements for this kind of element, stored as an explicit adjacency list. More...

#include <fem_impl.h>

Collaboration diagram for FEM_Ghost_Stencil:

[legend]

Public Member Functions
	FEM_Ghost_Stencil (int elType_, int n_, bool addNodes_, const int *ends_, const int *adj_, int idxBase)
	Create a stencil with this number of elements, and these adjecent elements.
void	check (const FEM_Mesh &mesh) const
	Make sure this stencil makes sense for this mesh.
int	getType (void) const
	Return the type of element we describe.
const int *	getNeighbor (int i, int j) const
	Return a pair consisting of the i'th element's j'th neighbor: the return value's first int is an element type, the second int is an element number.
bool	wantNodes (void) const
	FEM_Ghost_Stencil (int elType_, int n_, bool addNodes_, const int *ends_, const int *adj_, int idxBase)
	Create a stencil with this number of elements, and these adjecent elements.
void	check (const FEM_Mesh &mesh) const
	Make sure this stencil makes sense for this mesh.
int	getType (void) const
	Return the type of element we describe.
const int *	getNeighbor (int i, int j) const
	Return a pair consisting of the i'th element's j'th neighbor: the return value's first int is an element type, the second int is an element number.
bool	wantNodes (void) const
Private Attributes
int	elType
	Our element type.
int	n
	Number of elements we describe.
bool	addNodes
	If true, add ghost nodes as well as elements.
intArrayPtr	ends
	Last adjacency entry (plus one), indexed by element.
intArrayPtr	adj
	Adjacency entries for each element.

---

Detailed Description

Describes a set of required adjacent elements for this kind of element, stored as an explicit adjacency list.

Definition at line 303 of file fem_impl.h.

---

Constructor & Destructor Documentation

FEM_Ghost_Stencil::FEM_Ghost_Stencil	(	int	elType_,
		int	n_,
		bool	addNodes_,
		const int *	ends_,
		const int *	adj_,
		int	idxBase
	)

Create a stencil with this number of elements, and these adjecent elements.

FEM_Ghost_Stencil::FEM_Ghost_Stencil	(	int	elType_,
		int	n_,
		bool	addNodes_,
		const int *	ends_,
		const int *	adj_,
		int	idxBase
	)

Create a stencil with this number of elements, and these adjecent elements.

---

Member Function Documentation

int FEM_Ghost_Stencil::getType

(

void

)

const [inline]

Return the type of element we describe.

Definition at line 338 of file fem_impl.h.

References elType.

Referenced by splitter::addStencil().

Here is the caller graph for this function:

const int* FEM_Ghost_Stencil::getNeighbor	(	int	i,
		int	j
	)			const [inline]

Return a pair consisting of the i'th element's j'th neighbor: the return value's first int is an element type, the second int is an element number.

Returns NULL if i doesn't have a j'th neighbor.

Definition at line 346 of file fem_impl.h.

References adj, and ends.

Referenced by splitter::addStencil().

Here is the caller graph for this function:

bool FEM_Ghost_Stencil::wantNodes

(

void

)

const [inline]

Definition at line 353 of file fem_impl.h.

References addNodes.

Referenced by splitter::addStencil().

Here is the caller graph for this function:

void FEM_Ghost_Stencil::check

(

const FEM_Mesh &

mesh

)

const

Make sure this stencil makes sense for this mesh.

int FEM_Ghost_Stencil::getType

(

void

)

const [inline]

Return the type of element we describe.

Definition at line 1857 of file ParFUM_internals.h.

const int* FEM_Ghost_Stencil::getNeighbor	(	int	i,
		int	j
	)			const [inline]

Return a pair consisting of the i'th element's j'th neighbor: the return value's first int is an element type, the second int is an element number.

Returns NULL if i doesn't have a j'th neighbor.

Definition at line 1865 of file ParFUM_internals.h.

References adj(), and ends().

Here is the call graph for this function:

bool FEM_Ghost_Stencil::wantNodes

(

void

)

const [inline]

Definition at line 1872 of file ParFUM_internals.h.

References addNodes().

Here is the call graph for this function:

---

Field Documentation

int FEM_Ghost_Stencil::elType [private]

Our element type.

Definition at line 305 of file fem_impl.h.

Referenced by check(), and getType().

int FEM_Ghost_Stencil::n [private]

Number of elements we describe.

Definition at line 307 of file fem_impl.h.

Referenced by check().

bool FEM_Ghost_Stencil::addNodes [private]

If true, add ghost nodes as well as elements.

Definition at line 309 of file fem_impl.h.

Referenced by wantNodes().

intArrayPtr FEM_Ghost_Stencil::ends [private]

Last adjacency entry (plus one), indexed by element.

That is, element i's data is at [ends[i-1],ends[i])

That is, element i's data is at [ends[i-1],ends[i])

Definition at line 313 of file fem_impl.h.

Referenced by check(), and getNeighbor().

intArrayPtr FEM_Ghost_Stencil::adj [private]

Adjacency entries for each element.

Stored as a series of pairs: elType, elNum. The first pair for element i starts at 2*(ends[i-1]) the last pair for element i starts at 2*(ends[i]-1) This array then has, in total, 2*ends[n-1] elements.

Stored as a series of pairs: elType, elNum. The first pair for element i starts at 2*(ends[i-1]) the last pair for element i starts at 2*(ends[i]-1) This array then has, in total, 2*ends[n-1] elements.

Definition at line 323 of file fem_impl.h.

Referenced by check(), and getNeighbor().

---

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

• libs/ck-libs/fem/fem_impl.h
• libs/ck-libs/ParFUM/ParFUM_internals.h
• libs/ck-libs/fem/map.C
• libs/ck-libs/ParFUM/map.C