Skip to content

Commit

Permalink
Address Josh's review:
Browse files Browse the repository at this point in the history
- use param syntax for doc page for lienarfromVPP
- plural takes an s
  • Loading branch information
GiudGiud committed Jul 4, 2023
1 parent abae075 commit 54c581e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

## Description

The `PiecewiseLinearFromVectorPostprocessor` function performs linear interpolations between pairs of data generated by a vector post-processor object. The abscissa (`argument_column`) and the ordinate (`value_column`) values should correspond to the names of member vectors of the object specified for the `vectorpostprocessor_name` parameter. By default, the abscissa values correspond to time, and the data will be interpolated at the actual simulation time-step values. However, it is possible to interpolate over spatial (x, y, or z) coordinates by specifying a direction with the `component` parameter, where the inputs, `0`, `1`, and `2`, correspond to the `x`, `y`, and `z` directions, respectively.
The `PiecewiseLinearFromVectorPostprocessor` function performs linear interpolations between pairs of data generated by a vector post-processor object. The abscissa ([!param](/Functions/PiecewiseLinearFromVectorPostprocessor/argument_column)) and the ordinate ([!param](/Functions/PiecewiseLinearFromVectorPostprocessor/value_column)) values should correspond to the names of member vectors of the object specified for the [!param](/Functions/PiecewiseLinearFromVectorPostprocessor/vectorpostprocessor_name) parameter. By default, the abscissa values correspond to time, and the data will be interpolated at the actual simulation time-step values. However, it is possible to interpolate over spatial (x, y, or z) coordinates by specifying a direction with the [!param](/Functions/PiecewiseLinearFromVectorPostprocessor/component) parameter, where the inputs, `0`, `1`, and `2`, correspond to the `x`, `y`, and `z` directions, respectively.

## Example Input Syntax

In this example, three `PiecewiseLinearFromVectorPostprocessor` are created and take data from three distinct
In this example, three `PiecewiseLinearFromVectorPostprocessor`s are created and take data from three distinct
vector postprocessors. All three functions use a [!param](/Functions/PiecewiseLinearFromVectorPostprocessor/component)
parameter, which is set so they are functions of space rather than time (y for first two, x for the last one).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ and the memory used:
!row-end!

!alert note
Due to differences in the data collection method, the memory consumption different may be slightly different from
Due to differences in the data collection method, the memory consumption may be slightly different from
the [PerfGraphOutput.md].

!syntax parameters /VectorPostprocessors/VectorMemoryUsage
Expand Down

0 comments on commit 54c581e

Please sign in to comment.