Sierra Toolkit  Version of the Day
stk_classic::rebalance Namespace Reference

Classes

class  GeomDecomp
 Class for determining the optimal partitioning of mesh entities. More...
 
class  Partition
 Initialized with a list of mesh entities unique to each processor. More...
 

Typedefs

typedef mesh::Field< double, mesh::CartesianVectorField
 
typedef mesh::Field< double > ScalarField
 
typedef Teuchos::ParameterList Parameters
 

Functions

bool rebalance (mesh::BulkData &bulk_data, const mesh::Selector &selector, const VectorField *coord_ref, const ScalarField *elem_weight_ref, Partition &partition, const stk_classic::mesh::EntityRank rank=stk_classic::mesh::InvalidEntityRank)
 Rebalance with a Partition object. More...
 

Detailed Description

Rebalance API

Function Documentation

◆ rebalance()

bool stk_classic::rebalance::rebalance ( mesh::BulkData bulk_data,
const mesh::Selector selector,
const VectorField coord_ref,
const ScalarField elem_weight_ref,
Partition partition,
const stk_classic::mesh::EntityRank  rank = stk_classic::mesh::InvalidEntityRank 
)

Rebalance with a Partition object.

Parameters
bulk_dataBulkData must be in a parallel consistent state.
selectorUsed to select a subset of mesh entities to compute measure.
coord_refThe field containing the nodal coordinates. For the default ZoltanPartition class in stk_classic::reblance, this should be non-NULL.
elem_weight_refThis field will be used by the Partition class and can be NULL.
PartitionThe base class of a derived class that is used to determine the new partition. See the ZoltanPartition class for an example.
rankRank of the entities elem_weight_ref is defined on.

This rebalance function will use the Partition object passed to perform the rebalancing. It will be necessary to use one of the pre-defined derived classes in stk_classic::rebalance, like ZoltanPartition, or to define your own.

Definition at line 164 of file Rebalance.cpp.