Related types and enumerations

Collaboration diagram for Related types and enumerations:

Namespaces
namespace	Dune::Partitions
	Predefined PartitionSets for commonly used combinations of parallel grid PartitionTypes.

Classes
struct	Dune::PartitionSet< partitions >
	A set of PartitionType values. More...

Enumerations
enum	Dune::PartitionType {   Dune::InteriorEntity =0 , Dune::BorderEntity =1 , Dune::OverlapEntity =2 , Dune::FrontEntity =3 ,   Dune::GhostEntity =4 }
	Attributes used in the generic overlap model. More...
enum	Dune::InterfaceType {   Dune::InteriorBorder_InteriorBorder_Interface =0 , Dune::InteriorBorder_All_Interface =1 , Dune::Overlap_OverlapFront_Interface =2 , Dune::Overlap_All_Interface =3 ,   Dune::All_All_Interface =4 }
	Parameter to be used for the communication functions. More...
enum	Dune::PartitionIteratorType {   Dune::Interior_Partition =0 , Dune::InteriorBorder_Partition =1 , Dune::Overlap_Partition =2 , Dune::OverlapFront_Partition =3 ,   Dune::All_Partition =4 , Dune::Ghost_Partition =5 }
	Parameter to be used for the parallel level- and leaf iterators. More...
enum	Dune::CommunicationDirection { Dune::ForwardCommunication , Dune::BackwardCommunication }
	Define a type for communication direction parameter. More...

Functions
std::string	Dune::PartitionName (PartitionType type)
	Provide names for the partition types. More...
std::ostream &	Dune::operator<< (std::ostream &out, const PartitionType &type)
	write a PartitionType to a stream More...
std::ostream &	Dune::operator<< (std::ostream &out, const InterfaceType &type)
	write an InterfaceType to a stream More...
std::ostream &	Dune::operator<< (std::ostream &out, const PartitionIteratorType &type)
	write a PartitionIteratorType to a stream More...
template<PartitionType p>
PartitionSet<(1<< p)>	partitionSet ()
	Creates a PartitionSet for the given PartitionType. More...

Detailed Description

Enumeration Type Documentation

CommunicationDirection

enum Dune::CommunicationDirection

Define a type for communication direction parameter.

#include <dune/grid/common/gridenums.hh>

Enumerator
ForwardCommunication	communicate as given in InterfaceType
BackwardCommunication	reverse communication direction

InterfaceType

enum Dune::InterfaceType

Parameter to be used for the communication functions.

#include <dune/grid/common/gridenums.hh>

Enumerator
InteriorBorder_InteriorBorder_Interface	send/receive interior and border entities
InteriorBorder_All_Interface	send interior and border, receive all entities
Overlap_OverlapFront_Interface	send overlap, receive overlap and front entities
Overlap_All_Interface	send overlap, receive all entities
All_All_Interface	send all and receive all entities

PartitionIteratorType

enum Dune::PartitionIteratorType

Parameter to be used for the parallel level- and leaf iterators.

#include <dune/grid/common/gridenums.hh>

Enumerator
Interior_Partition	only interior entities
InteriorBorder_Partition	interior and border entities
Overlap_Partition	interior, border, and overlap entities
OverlapFront_Partition	interior, border, overlap and front entities
All_Partition	all entities
Ghost_Partition	only ghost entities

PartitionType

enum Dune::PartitionType

Attributes used in the generic overlap model.

#include <dune/grid/common/gridenums.hh>

The values are ordered intentionally in order to be able to define ranges of partition types.

Enumerator
InteriorEntity	all interior entities
BorderEntity	on boundary between interior and overlap
OverlapEntity	all entities lying in the overlap zone
FrontEntity	on boundary between overlap and ghost
GhostEntity	ghost entities

Function Documentation

operator<<() [1/3]

std::ostream & Dune::operator<< ( std::ostream &  out, const InterfaceType &  type  )

inline

write an InterfaceType to a stream

#include <dune/grid/common/gridenums.hh>

operator<<() [2/3]

std::ostream & Dune::operator<< ( std::ostream &  out, const PartitionIteratorType &  type  )

inline

write a PartitionIteratorType to a stream

#include <dune/grid/common/gridenums.hh>

operator<<() [3/3]

std::ostream & Dune::operator<< ( std::ostream &  out, const PartitionType &  type  )

inline

write a PartitionType to a stream

#include <dune/grid/common/gridenums.hh>

PartitionName()

std::string Dune::PartitionName ( PartitionType  type )

inline

Provide names for the partition types.

#include <dune/grid/common/gridenums.hh>

partitionSet()

template<PartitionType p>

PartitionSet<(1<< p)> partitionSet ( )

related

Creates a PartitionSet for the given PartitionType.