Skip to content

Commit

Permalink
More on documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fdkong committed Jul 16, 2019
1 parent fa62a02 commit c1e926d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 14 deletions.
@@ -1,25 +1,18 @@
# BlockWeightedPartitioner

!template load file=stubs/moose_object.md.template name=BlockWeightedPartitioner syntax=/Mesh/Partitioner/BlockWeightedPartitioner
!syntax description /Mesh/Partitioner/BlockWeightedPartitioner

## Overview

Under multiphysics environment, some mesh blocks have more variables and more work load than others . In parallel, the work
is spread out based on partitioners that assign equal number of elements to each processor. This will causes imbalanced simulations.
BlockWeightedPartitioner allow users to specify different weights for different blocks, e.g., low weights for light blocks
and high weights for heavy blocks. Usage:
and high weights for heavy blocks. Weights should be proportional to the relative numbers of DOFs per element in each mesh block.
The weights do not need to be pre-normalized to any particular number. Small numbers are better large numbers, e.g., 1 vs 2
is better than 1000 vs 2000. Usage:

```
[Mesh]
type = FileMesh
file = block_weighted_partitioner.e
!listing block_weighted_partitioner.i block=Mesh

[Partitioner]
type = BlockWeightedPartitioner
block = '1 2 3'
weight = '3 1 10'
[]
[]
```

An example:

Expand All @@ -32,3 +25,10 @@ An example:
!media noweightedpartitioner4.png caption=`Regular partition into 4 subdomains`
!col-end!
!row-end!


!syntax parameters /Mesh/Partitioner/BlockWeightedPartitioner

!syntax inputs /Mesh/Partitioner/BlockWeightedPartitioner

!syntax children /Mesh/Partitioner/BlockWeightedPartitioner
Expand Up @@ -7,7 +7,6 @@
block = '1 2 3'
weight = '3 1 10'
[]
# parallel_type = distributed
[]

[Variables]
Expand Down

0 comments on commit c1e926d

Please sign in to comment.