index_definition Struct Reference

This type is part of the coloring, and encapsulates the coloring information for a single index space (such as how many colors per axis the mesh needs to be partitioned into, if boundaries are periodic, etc), that is used by the coloring algorithm to create mesh partitions. More...

Public Attributes
std::vector< axis_definition >	axes
	coloring information of each axis
bool	create_plan
	Unused.
bool	diagonals = false
	whether to include diagonally connected (i.e., connected through vertex) as well as face connected entities during primary partitioning
bool	full_ghosts = true
	Whether to include full ghost information for auxiliaries.

Detailed Description

This type is part of the coloring, and encapsulates the coloring information for a single index space (such as how many colors per axis the mesh needs to be partitioned into, if boundaries are periodic, etc), that is used by the coloring algorithm to create mesh partitions.

Member Data Documentation

axes

std::vector<axis_definition> axes

coloring information of each axis

diagonals

bool diagonals = false

whether to include diagonally connected (i.e., connected through vertex) as well as face connected entities during primary partitioning

create_plan

bool create_plan

Unused.

Deprecated:

Omit the initialization (and assign full_ghosts if needed).

full_ghosts

bool full_ghosts = true

Whether to include full ghost information for auxiliaries.

When true, all the auxiliaries surrounding needed primary entities (owned and ghost) are included. If false, only auxiliaries completely surrounded by needed primaries are included. For primary entities, this flag has no effect.