forked from idaholab/moose
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
adding moosedocs for extra id vpp, refs idaholab#19217
- Loading branch information
Showing
1 changed file
with
26 additions
and
0 deletions.
There are no files selected for viewing
26 changes: 26 additions & 0 deletions
26
...r/doc/content/source/vectorpostprocessors/ExtraIDIntegralVectorPostprocessor.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# ExtraIDIntegralVectorPostprocessor | ||
|
||
!syntax description /VectorPostprocessors/ExtraIDIntegralVectorPostprocessor | ||
|
||
|
||
## Overview | ||
|
||
The `ExtraIDIntegralVectorPostprocessor` object is a vector postprocessor to integrate input variables based on multiple extra IDs. | ||
First, it finds unique combinations of extra IDs, and then it computes separate integral values over input variables for elements with these unique combinations. | ||
For reactor applications, reactor component-wise values, such as pin-by-pin power distribution can be easily tallied using this object. | ||
|
||
The `ExtraIDIntegralVectorPostprocessor` object needs the following parameters: | ||
|
||
- [!param](/VectorPostprocessors/ExtraIDIntegralVectorPostprocessor/variable): variables that this VectorPostprocessor operates on. | ||
|
||
- [!param](/VectorPostprocessors/ExtraIDIntegralVectorPostprocessor/id_name): list of extra IDs by which to separate integrals | ||
|
||
## Example Syntax | ||
|
||
!listing modules/reactor/test/tests/vectorpostprocessors/extra_id_vpp.i block=VectorPostprocessors | ||
|
||
!syntax parameters /VectorPostprocessors/ExtraIDIntegralVectorPostprocessor | ||
|
||
!syntax inputs /VectorPostprocessors/ExtraIDIntegralVectorPostprocessor | ||
|
||
!syntax children /VectorPostprocessors/ExtraIDIntegralVectorPostprocessor |