FEAT 3
Finite Element Analysis Toolbox
Loading...
Searching...
No Matches
FEAT::Geometry::PartitionSet Class Reference

Partition set class. More...

#include <partition_set.hpp>

Public Member Functions

 PartitionSet (PartitionSet &&other)
 
void add_partition (Partition &&part)
 
void clear ()
 
const Partitionfind_partition (int size, const std::deque< String > &names, int prio=0) const
 
const Partitionfind_partition (int size, const String &name="", int prio=0) const
 Tries to find a suitable partition in the set. More...
 
std::deque< Partition > & get_partitions ()
 
const std::deque< Partition > & get_partitions () const
 

Protected Attributes

std::deque< Partition_parts
 the actual partitions in the set More...
 

Detailed Description

Partition set class.

This class acts as a container, which manages a set of partitions. This class is effectively just a wrapper around a deque of Partition objects.

Author
Peter Zajac

Definition at line 185 of file partition_set.hpp.

Constructor & Destructor Documentation

◆ PartitionSet() [1/2]

FEAT::Geometry::PartitionSet::PartitionSet ( )
inline

Definition at line 192 of file partition_set.hpp.

◆ PartitionSet() [2/2]

FEAT::Geometry::PartitionSet::PartitionSet ( PartitionSet &&  other)
inline

Definition at line 196 of file partition_set.hpp.

◆ ~PartitionSet()

virtual FEAT::Geometry::PartitionSet::~PartitionSet ( )
inlinevirtual

Definition at line 201 of file partition_set.hpp.

Member Function Documentation

◆ add_partition()

void FEAT::Geometry::PartitionSet::add_partition ( Partition &&  part)
inline

Definition at line 220 of file partition_set.hpp.

◆ clear()

void FEAT::Geometry::PartitionSet::clear ( )
inline

Definition at line 205 of file partition_set.hpp.

◆ find_partition() [1/2]

const Partition * FEAT::Geometry::PartitionSet::find_partition ( int  size,
const std::deque< String > &  names,
int  prio = 0 
) const
inline

Definition at line 251 of file partition_set.hpp.

◆ find_partition() [2/2]

const Partition * FEAT::Geometry::PartitionSet::find_partition ( int  size,
const String name = "",
int  prio = 0 
) const
inline

Tries to find a suitable partition in the set.

Parameters
[in]sizeThe required size (number of ranks) of the partition. Must be > 0.
[in]nameThe required name of the partition. If name is an empty string, the name of a partition is considered irrelevant.
[in]prioThe required minimal priority of the partition. Only partitions with a priority greater or equal to prio are considered valid candidates.
Returns
A pointer to a Partition object that meets the requirements or nullptr, if no suitable partition was found in the set.

Definition at line 243 of file partition_set.hpp.

References find_partition().

Referenced by FEAT::Control::Domain::PartiDomainControl< DomainLevel_ >::_check_parti_extern(), and find_partition().

◆ get_partitions() [1/2]

std::deque< Partition > & FEAT::Geometry::PartitionSet::get_partitions ( )
inline

Definition at line 210 of file partition_set.hpp.

◆ get_partitions() [2/2]

const std::deque< Partition > & FEAT::Geometry::PartitionSet::get_partitions ( ) const
inline

Definition at line 215 of file partition_set.hpp.

Member Data Documentation

◆ _parts

std::deque<Partition> FEAT::Geometry::PartitionSet::_parts
protected

the actual partitions in the set

Definition at line 189 of file partition_set.hpp.


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