waLBerla 7.3
Loading...
Searching...
No Matches
walberla::blockforest::WeightAssignmentFunctor Class Reference

Detailed Description

General assignment functor for load balancing.

Uses BlockInfo::computationalWeight as PhantomBlockWeight

#include <WeightAssignmentFunctor.h>

Public Types

using PhantomBlockWeight = walberla::blockforest::PODPhantomWeight<double>
 Convenience typedef to be used as PhantomBlock weight in conjunction with this weight assignment functor.
using PhantomBlockWeightPackUnpackFunctor = walberla::blockforest::PODPhantomWeightPackUnpack<double>
 Convenience typedef for pack and unpack functions to be used in conjunction with PhantomBlockWeight.

Public Member Functions

 WeightAssignmentFunctor (shared_ptr< blockforest::InfoCollection > &ic, const real_t baseWeight=10.0_r)
void operator() (std::vector< std::pair< const PhantomBlock *, std::any > > &blockData, const PhantomBlockForest &)
void setBaseWeight (const double weight)
double getBaseWeight () const

Private Attributes

shared_ptr< blockforest::InfoCollection > ic_
double baseWeight_ = 10.0_r
 Base weight due to allocated data structures. A weight of zero for blocks is dangerous as empty blocks might accumulate on one process!

Member Typedef Documentation

◆ PhantomBlockWeight

using walberla::blockforest::WeightAssignmentFunctor::PhantomBlockWeight = walberla::blockforest::PODPhantomWeight<double>

Convenience typedef to be used as PhantomBlock weight in conjunction with this weight assignment functor.

◆ PhantomBlockWeightPackUnpackFunctor

using walberla::blockforest::WeightAssignmentFunctor::PhantomBlockWeightPackUnpackFunctor = walberla::blockforest::PODPhantomWeightPackUnpack<double>

Convenience typedef for pack and unpack functions to be used in conjunction with PhantomBlockWeight.

Constructor & Destructor Documentation

◆ WeightAssignmentFunctor()

walberla::blockforest::WeightAssignmentFunctor::WeightAssignmentFunctor ( shared_ptr< blockforest::InfoCollection > & ic,
const real_t baseWeight = 10.0_r )
inline

Member Function Documentation

◆ getBaseWeight()

double walberla::blockforest::WeightAssignmentFunctor::getBaseWeight ( ) const
inline

◆ operator()()

void walberla::blockforest::WeightAssignmentFunctor::operator() ( std::vector< std::pair< const PhantomBlock *, std::any > > & blockData,
const PhantomBlockForest &  )
inline

◆ setBaseWeight()

void walberla::blockforest::WeightAssignmentFunctor::setBaseWeight ( const double weight)
inline

Member Data Documentation

◆ baseWeight_

double walberla::blockforest::WeightAssignmentFunctor::baseWeight_ = 10.0_r
private

Base weight due to allocated data structures. A weight of zero for blocks is dangerous as empty blocks might accumulate on one process!

◆ ic_

shared_ptr<blockforest::InfoCollection> walberla::blockforest::WeightAssignmentFunctor::ic_
private
The documentation for this class was generated from the following file: