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.
Add documentation for the integral variable pp, refs idaholab#17566
- Loading branch information
Showing
1 changed file
with
19 additions
and
2 deletions.
There are no files selected for viewing
21 changes: 19 additions & 2 deletions
21
...ework/doc/content/source/postprocessors/ElementIntegralVariablePostprocessor.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 |
---|---|---|
@@ -1,4 +1,21 @@ | ||
# ElementIntegralVariablePostprocessor | ||
|
||
The ElementIntegralVariablePostprocessor is an intermediate base class that should be derived from for any calculation involing | ||
the integral of a variable quantity over the whole domain or a portion of the domain. | ||
The ElementIntegralVariablePostprocessor is an intermediate base class that should be derived from for any calculation involving | ||
the integral of a variable quantity over the whole domain or a portion of the domain. | ||
|
||
The ElementIntegralVariablePostprocessor may be used to compute the volume integral of a variable, based on the quadrature defined | ||
for this variable. This integral may be restricted to blocks/subdomains on which the variable is defined. | ||
|
||
## Example input file | ||
|
||
In this input file, we use `ElementIntegralVariablePostprocessor` to compute the integral | ||
of a variable $u$, solution of a diffusion problem, over each and all of the two subdomains it | ||
is defined on. | ||
|
||
!listing postprocessors/element_integral/element_block_integral_test.i | ||
|
||
!syntax parameters /Postprocessors/ElementIntegralVariablePostprocessor | ||
|
||
!syntax inputs /Postprocessors/ElementIntegralVariablePostprocessor | ||
|
||
!syntax children /Postprocessors/ElementIntegralVariablePostprocessor |