Class ae108::cpppetsc::LocalVertexView

template <class MeshType_>

ClassList > ae108 > cpppetsc > LocalVertexView

Public Types

Type	Name
typedef MeshDataProvider< mesh_type >	DataProvider
typedef typename mesh_type::matrix_type	matrix_type
typedef MeshType_	mesh_type
typedef typename mesh_type::size_type	size_type
typedef typename mesh_type::value_type	value_type
typedef typename mesh_type::vector_type	vector_type

Public Functions

Type	Name
	LocalVertexView (DataProvider data, const size_type vertexPointIndex)
void	addVertexData (const std::vector< value_type > & data, local< vector_type > *const vector) const Adds the provided vertex data to the vector.
void	addVertexMatrix (const std::vector< value_type > & data, matrix_type *const matrix) const Adds the provided matrix data to the matrix.
void	copyVertexData (const local< vector_type > & vector, std::vector< value_type > * data) const Copies the data belonging to the vertex to data.
LocalVertexView	forClonedMesh (const mesh_type *const mesh) const Converts the vertex view to a vertex view for a cloned mesh.
std::pair< size_type, size_type >	globalDofLineRange () const Returns the global range of lines (e.g. in a vector) that is associated with the degrees of freedom of this vertex in the following format: (first line, last line + 1).
size_type	index () const Returns the global vertex index.
std::pair< size_type, size_type >	localDofLineRange () const Returns the local range of lines (e.g. in a vector) that is associated with the degrees of freedom of this vertex in the following format: (first line, last line + 1).
size_type	numberOfDofs () const Returns the number of degrees of freedom associated with the vertex.
void	setVertexData (const std::vector< value_type > & data, local< vector_type > *const vector) const Sets the provided vertex data in the vector.

Public Types Documentation

typedef DataProvider

using ae108::cpppetsc::LocalVertexView< MeshType_ >::DataProvider =  MeshDataProvider<mesh_type>;

---

typedef matrix_type

using ae108::cpppetsc::LocalVertexView< MeshType_ >::matrix_type =  typename mesh_type::matrix_type;

---

typedef mesh_type

using ae108::cpppetsc::LocalVertexView< MeshType_ >::mesh_type =  MeshType_;

---

typedef size_type

using ae108::cpppetsc::LocalVertexView< MeshType_ >::size_type =  typename mesh_type::size_type;

---

typedef value_type

using ae108::cpppetsc::LocalVertexView< MeshType_ >::value_type =  typename mesh_type::value_type;

---

typedef vector_type

using ae108::cpppetsc::LocalVertexView< MeshType_ >::vector_type =  typename mesh_type::vector_type;

---

Public Functions Documentation

function LocalVertexView

explicit ae108::cpppetsc::LocalVertexView::LocalVertexView (
    DataProvider data,
    const size_type vertexPointIndex
) 

Parameters:

• data Provides mesh information to the view.
• vertexPointIndex A valid vertex point index.

---

function addVertexData

Adds the provided vertex data to the vector.

void ae108::cpppetsc::LocalVertexView::addVertexData (
    const std::vector< value_type > & data,
    local < vector_type > *const vector
) const

---

function addVertexMatrix

Adds the provided matrix data to the matrix.

void ae108::cpppetsc::LocalVertexView::addVertexMatrix (
    const std::vector< value_type > & data,
    matrix_type *const matrix
) const

---

function copyVertexData

Copies the data belonging to the vertex to data.

void ae108::cpppetsc::LocalVertexView::copyVertexData (
    const local < vector_type > & vector,
    std::vector< value_type > * data
) const

---

function forClonedMesh

Converts the vertex view to a vertex view for a cloned mesh.

LocalVertexView ae108::cpppetsc::LocalVertexView::forClonedMesh (
    const mesh_type *const mesh
) const

Parameters:

• mesh is a Mesh that was cloned from the Mesh that this view refers to.

---

function globalDofLineRange

Returns the global range of lines (e.g. in a vector) that is associated with the degrees of freedom of this vertex in the following format: (first line, last line + 1).

std::pair< size_type, size_type > ae108::cpppetsc::LocalVertexView::globalDofLineRange () const

Remark:

Returns negative line numbers (-begin - 1, -end - 1) if the point data is not owned locally (e.g. for ghost points).

---

function index

Returns the global vertex index.

size_type ae108::cpppetsc::LocalVertexView::index () const

---

function localDofLineRange

Returns the local range of lines (e.g. in a vector) that is associated with the degrees of freedom of this vertex in the following format: (first line, last line + 1).

std::pair< size_type, size_type > ae108::cpppetsc::LocalVertexView::localDofLineRange () const

---

function numberOfDofs

Returns the number of degrees of freedom associated with the vertex.

size_type ae108::cpppetsc::LocalVertexView::numberOfDofs () const

---

function setVertexData

Sets the provided vertex data in the vector.

void ae108::cpppetsc::LocalVertexView::setVertexData (
    const std::vector< value_type > & data,
    local < vector_type > *const vector
) const

---

---

The documentation for this class was generated from the following file cpppetsc/src/include/ae108/cpppetsc/LocalVertexView.h