loadBalancer Class Reference

Dynamic mesh redistribution using the distributor specified in decomposeParDict. More...

Inheritance diagram for loadBalancer:
Collaboration diagram for loadBalancer:

Public Member Functions

 TypeName ("loadBalancer")
 Runtime type information. More...
 
 loadBalancer (fvMesh &mesh)
 Construct from fvMesh. More...
 
virtual ~loadBalancer ()
 Destructor. More...
 
virtual bool update ()
 Distribute the. More...
 
- Public Member Functions inherited from distributor
 TypeName ("distributor")
 Runtime type information. More...
 
 distributor (fvMesh &mesh)
 Construct from fvMesh. More...
 
 distributor (const distributor &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~distributor ()
 Destructor. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update corresponding to the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Update corresponding to the given distribution map. More...
 
virtual bool write (const bool write=true) const
 Write using given format, version and compression. More...
 
void operator= (const distributor &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fvMeshDistributor
 TypeName ("fvMeshDistributor")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fvMeshDistributor, fvMesh,(fvMesh &mesh),(mesh))
 
 fvMeshDistributor (fvMesh &)
 Construct from fvMesh. More...
 
 fvMeshDistributor (const fvMeshDistributor &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fvMeshDistributor ()
 Destructor. More...
 
fvMeshmesh ()
 Return the fvMesh. More...
 
const fvMeshmesh () const
 Return the fvMesh. More...
 
const dictionarydict () const
 Return the dynamicMeshDict/distributor sub-dict. More...
 
virtual bool dynamic () const
 Is mesh dynamic, i.e. might it change? More...
 
void operator= (const fvMeshDistributor &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fvMeshDistributor
static autoPtr< fvMeshDistributorNew (fvMesh &)
 Select, construct and return the fvMeshDistributor. More...
 
- Protected Member Functions inherited from distributor
void readDict ()
 Read the projection parameters from dictionary. More...
 
void distribute (const labelList &distribution)
 Distribute the mesh and mesh data. More...
 
- Protected Attributes inherited from distributor
autoPtr< decompositionMethoddistributor_
 Cache the decomposer/distributor. More...
 
label redistributionInterval_
 Time-step interval between redistribution calls. More...
 
scalar maxImbalance_
 Maximum imbalance between the ideal number of cells per processor. More...
 
label timeIndex_
 The time index used for updating. More...
 

Detailed Description

Dynamic mesh redistribution using the distributor specified in decomposeParDict.

Usage
Example of single field based refinement in all cells:
distributor
{
    type            loadBalancer;

    libs            ("libfvMeshDistributors.so");

    // How often to redistribute
    redistributionInterval  10;

    // Maximum fractional cell distribution imbalance
    // before rebalancing
    maxImbalance    0.1;
}
Source files

Definition at line 70 of file fvMeshDistributorsLoadBalancer.H.

Constructor & Destructor Documentation

◆ loadBalancer()

loadBalancer ( fvMesh mesh)
explicit

Construct from fvMesh.

Definition at line 64 of file fvMeshDistributorsLoadBalancer.C.

◆ ~loadBalancer()

~loadBalancer ( )
virtual

Destructor.

Definition at line 74 of file fvMeshDistributorsLoadBalancer.C.

Member Function Documentation

◆ TypeName()

TypeName ( "loadBalancer"  )

Runtime type information.

◆ update()


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