peano4.api.toolbox.GridSelector.GridSelector Class Reference

Select a subset of the mesh entities. More...

Inheritance diagram for peano4.api.toolbox.GridSelector.GridSelector:

Collaboration diagram for peano4.api.toolbox.GridSelector.GridSelector:

Public Member Functions
str	createVertexGuard (self)
	C++ boolean expression over a peano4::datamanagement::VertexMarker called marker.
str	createFaceGuard (self)
	C++ boolean expression over a peano4::datamanagement::FaceMarker called marker.
str	createCellGuard (self)
	C++ boolean expression over a peano4::datamanagement::CellMarker called marker.
str	createVertexStoreGuard (self)
	C++ boolean expression over a peano4::datamanagement::VertexMarker called marker which decides whether a vertex's data is stored at the end of a mesh sweep.
str	createFaceStoreGuard (self)
	Counterpart of createVertexStoreGuard() for faces.
str	createCellStoreGuard (self)
	Counterpart of createVertexStoreGuard() for cells.

Detailed Description

Select a subset of the mesh entities.

This is a sole helper class: It does not generate any C++ code itself and is not an action set. It merely hands out guards, i.e. C++ snippets which other Python classes, such as action sets, can embed into their generated code to decide whether they should act on a particular vertex, face or cell.

Each routine returns a string which has to be a C++ boolean expression. The expression is evaluated in a context where the corresponding marker is available as marker, i.e. it can query the peano4::datamanagement::VertexMarker, peano4::datamanagement::FaceMarker or peano4::datamanagement::CellMarker, respectively.

See also

FineGridSelector

Definition at line 6 of file GridSelector.py.

Member Function Documentation

createCellGuard()

str peano4.api.toolbox.GridSelector.GridSelector.createCellGuard

(

self

)

C++ boolean expression over a peano4::datamanagement::CellMarker called marker.

Reimplemented in peano4.api.toolbox.FineGridSelector.FineGridSelector, and peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector.

Definition at line 46 of file GridSelector.py.

Referenced by peano4.api.toolbox.GridSelector.GridSelector.createCellStoreGuard().

Here is the caller graph for this function:

createCellStoreGuard()

str peano4.api.toolbox.GridSelector.GridSelector.createCellStoreGuard

(

self

)

Counterpart of createVertexStoreGuard() for cells.

Reimplemented in peano4.api.toolbox.FineGridSelector.FineGridSelector.

Definition at line 79 of file GridSelector.py.

References peano4.api.toolbox.FineGridSelector.FineGridSelector.createCellGuard(), peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector.createCellGuard(), peano4.api.toolbox.GridSelector.GridSelector.createCellGuard(), and test_derive_load_store_compute_flag._FakeGridSelector.createCellGuard().

Here is the call graph for this function:

createFaceGuard()

str peano4.api.toolbox.GridSelector.GridSelector.createFaceGuard

(

self

)

C++ boolean expression over a peano4::datamanagement::FaceMarker called marker.

Reimplemented in peano4.api.toolbox.FineGridSelector.FineGridSelector, and peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector.

Definition at line 37 of file GridSelector.py.

Referenced by peano4.api.toolbox.GridSelector.GridSelector.createFaceStoreGuard().

Here is the caller graph for this function:

createFaceStoreGuard()

str peano4.api.toolbox.GridSelector.GridSelector.createFaceStoreGuard

(

self

)

Counterpart of createVertexStoreGuard() for faces.

Reimplemented in peano4.api.toolbox.FineGridSelector.FineGridSelector.

Definition at line 71 of file GridSelector.py.

References peano4.api.toolbox.FineGridSelector.FineGridSelector.createFaceGuard(), peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector.createFaceGuard(), peano4.api.toolbox.GridSelector.GridSelector.createFaceGuard(), and test_derive_load_store_compute_flag._FakeGridSelector.createFaceGuard().

Here is the call graph for this function:

createVertexGuard()

str peano4.api.toolbox.GridSelector.GridSelector.createVertexGuard

(

self

)

C++ boolean expression over a peano4::datamanagement::VertexMarker called marker.

Reimplemented in peano4.api.toolbox.FineGridSelector.FineGridSelector, and peano4.api.toolbox.FixedResolutionGridSelector.FixedResolutionGridSelector.

Definition at line 28 of file GridSelector.py.

createVertexStoreGuard()

str peano4.api.toolbox.GridSelector.GridSelector.createVertexStoreGuard

(

self

)

C++ boolean expression over a peano4::datamanagement::VertexMarker called marker which decides whether a vertex's data is stored at the end of a mesh sweep.

Peano's stacks require that data stored in one mesh sweep are loaded in the next one. The load is guarded by createVertexGuard(). If this guard depends on the refinement state, the store therefore has to anticipate the state of the next sweep. By default, we use createVertexGuard(), which is correct for selectors that do not depend on the refinement state.

Reimplemented in peano4.api.toolbox.FineGridSelector.FineGridSelector.

Definition at line 54 of file GridSelector.py.

---

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

• src/peano4/api/toolbox/GridSelector.py