Skip to content

Commit

Permalink
Documentation for VPPV closes #11272
Browse files Browse the repository at this point in the history
  • Loading branch information
friedmud committed Apr 13, 2018
1 parent 94e11f6 commit 8c35edd
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
@@ -0,0 +1,23 @@
# VectorPostprocessorVisualizationAux

## Short Description

!syntax description /AuxKernels/VectorPostprocessorVisualizationAux

## Description

This object is intended to let you view VectorPostprocessor vectors that are of lenght `num_procs` (meaning there is one value per MPI process). This object will take those values and fill up an Auxiliary field with them so the values can be visualized.

## Important Notes

Note: the VectorPostprocessor must be syncing the vectors it's computing to all processors. By default many just compute to processor 0 (because that's where output occurrs).

For instance: this is the case for [WorkBalance]. By default it only syncs to processor 0, but it has a parameter (`sync_to_all_procs`) to tell it to create copies of the vectors on all processors.

!syntax parameters /AuxKernels/VectorPostprocessorVisualizationAux

!syntax inputs /AuxKernels/VectorPostprocessorVisualizationAux

!syntax children /AuxKernels/VectorPostprocessorVisualizationAux

!bibtex bibliography
Expand Up @@ -12,7 +12,9 @@ Currently computes: number of local elements, nodes, dofs and partition sides.

## Important Notes

Note that this VPP only computes the complete vector on processor 0. The vectors this VPP computes may be very large and there is no need to have a copy of them on every processor.
Note that, by default, this VPP only computes the complete vector on processor 0. The vectors this VPP computes may be very large and there is no need to have a copy of them on every processor.

However, you can modify this behavior by setting `sync_to_all_procs = true`

!syntax parameters /VectorPostprocessors/WorkBalance

Expand Down

0 comments on commit 8c35edd

Please sign in to comment.