Add Lagged Variable PostProcessor #1523

joshua-cogliati-inl · 2021-04-20T17:05:59Z

Pull Request Description

What issue does this change request address?

Closes #1522

What are the significant changes in functionality due to this change request?

This adds a new post processor.

For Change Control Board: Change Request Review

The following review must be completed by an authorized member of the Change Control Board.

1. Review all computer code.
2. If any changes occur to the input syntax, there must be an accompanying change to the user manual and xsd schema. If the input syntax change deprecates existing input files, a conversion script needs to be added (see Conversion Scripts).
3. Make sure the Python code and commenting standards are respected (camelBack, etc.) - See on the wiki for details.
4. Automated Tests should pass, including run_tests, pylint, manual building and xsd tests. If there are changes to Simulation.py or JobHandler.py the qsub tests must pass.
5. If significant functionality is added, there must be tests added to check this. Tests should cover all possible options. Multiple short tests are preferred over one large test. If new development on the internal JobHandler parallel system is performed, a cluster test must be added setting, in XML block, the node <internalParallel> to True.
6. If the change modifies or adds a requirement or a requirement based test case, the Change Control Board's Chair or designee also needs to approve the change. The requirements and the requirements test shall be in sync.
7. The merge request must reference an issue. If the issue is closed, the issue close checklist shall be done.
8. If an analytic test is changed/added is the the analytic documentation updated/added?
9. If any test used as a basis for documentation examples (currently found in raven/tests/framework/user_guide and raven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.

alfoa

The interfacePostprocessor here should be converted to be a normal PostProcessor (please talk to @wangcj05 about the new structure)

alfoa · 2021-04-20T17:37:58Z

doc/user_manual/postprocessor.tex

+variables.  For example, if there a variable price that is set hourly,
+than new variable called price\_prev\_hour could be set by using a
+delay of -1.  This can be useful for training a ROM or other data
+analysis.


Josh, please add an example here that precisely explains the Input DataObject and how the Output DataObject will get out. From the previous explanation I do not know how to use this PP and how to set up the output dataobject.
We need to be very verbose (with examples).

Maybe in conjunction with the example you have below.

Added a bit more here, and expanded the example to include the step and the data objects.

alfoa · 2021-04-20T17:40:02Z

doc/user_manual/postprocessor.tex

+\begin{itemize}
+\item \xmlNode{delay}, \xmlDesc{empty}, a delay node with the following required parameters:
+  \begin{itemize}
+  \item \xmlAttr{original}, the variable to start with


This is not the format of the manual.
Example:

\item \xmlAttr{VAR}, \xmlDesc{required string attribute}, user-defined VARIABLE name etc etc

alfoa · 2021-04-20T17:43:03Z

doc/user_manual/postprocessor.tex

+  \item \xmlAttr{original}, the variable to start with
+  \item \xmlAttr{new}, the new variable to create
+  \item \xmlAttr{steps}, the delay (if negative) or steps into the future (if positive) to use for the new variable (so -1 gives the previous, 1 gives the next)
+  \item \xmlAttr{default}, the value to use for cases where there is no previous or next value.


please be verbose here... "there is no previous or next value". What do you mean? in terms of perfect match using the step? need clear explanation for the user

Added: (such as the beginning when a negative delay is used, or the end when the delay is positive)

alfoa · 2021-04-20T17:43:20Z

framework/PostProcessorFunctions/HistorySetDelay.py

@@ -0,0 +1,91 @@
+
+"""
+This is to implement a delay or lagged parameters in a HistorySet


standard of docstring

alfoa · 2021-04-20T17:43:27Z

framework/PostProcessorFunctions/HistorySetDelay.py

+
+class HistorySetDelay(PostProcessorInterfaceBase):
+  """
+  Class to get lagged or delayed data out of a history set.


alfoa · 2021-04-20T17:43:46Z

framework/PostProcessorFunctions/HistorySetDelay.py

+    inputSpecification = super().getInputSpecification()
+    inputSpecification.setCheckClass(CheckInterfacePP("HistorySetDelay"))
+    delayClass = InputData.parameterInputFactory("delay", InputTypes.StringType,
+                                                 descr="Adds a delay variable")


verbosity of the description

those descriptions will be used for future automatic documentation. they must be of "manual grade"

alfoa · 2021-04-20T17:44:28Z

framework/PostProcessorFunctions/HistorySetDelay.py

+
+  def initialize(self):
+    """
+      Method to initialize the HistorySetDelay


standard docstring

alfoa · 2021-04-20T17:46:41Z

tests/framework/PostProcessors/InterfacedPostProcessor/test_historySetDelay.xml

+    <created>2021-04-19</created>
+    <classesTested>InterfacedPostProcessor</classesTested>
+    <description>
+      Tests of the HistorySetDelay interfaced post-processor


Can you improve the description answering to the following questions:
what do we test? What the expected outcomes? input and outputs? the model used?

joshua-cogliati-inl · 2021-04-20T17:54:17Z

The interfacePostprocessor here should be converted to be a normal PostProcessor (please talk to @wangcj05 about the new structure)

Hm, HistorySetSync doesn't seem to be converted in #1512 Where is an example of a converted InterfacePostProcessor I can look at?

wangcj05 · 2021-04-20T18:02:20Z

The interfacePostprocessor here should be converted to be a normal PostProcessor (please talk to @wangcj05 about the new structure)

Hm, HistorySetSync doesn't seem to be converted in #1512 Where is an example of a converted InterfacePostProcessor I can look at?

I have converted the "RiskMeasuresDiscrete" in PR: https://github.com/idaholab/raven/pull/1512/files

joshua-cogliati-inl · 2021-04-20T18:10:47Z

The interfacePostprocessor here should be converted to be a normal PostProcessor (please talk to @wangcj05 about the new structure)

Hm, HistorySetSync doesn't seem to be converted in #1512 Where is an example of a converted InterfacePostProcessor I can look at?

I have converted the "RiskMeasuresDiscrete" in PR: https://github.com/idaholab/raven/pull/1512/files

The method run doesn't seem to be modified:

https://github.com/idaholab/raven/pull/1512/files#diff-1d3a8ec5e63f5ed917bae8cea26d940241b149fcfda0e001b29ff32d871c83e7

wangcj05 · 2021-04-20T18:18:21Z

The interfacePostprocessor here should be converted to be a normal PostProcessor (please talk to @wangcj05 about the new structure)

Hm, HistorySetSync doesn't seem to be converted in #1512 Where is an example of a converted InterfacePostProcessor I can look at?

I have converted the "RiskMeasuresDiscrete" in PR: https://github.com/idaholab/raven/pull/1512/files

The method run doesn't seem to be modified:

https://github.com/idaholab/raven/pull/1512/files#diff-1d3a8ec5e63f5ed917bae8cea26d940241b149fcfda0e001b29ff32d871c83e7

The base class will be changed. Based on the new structure, the interfacePP class, the PPInterfaces, the PPInterfaceBaseClass are not needed anymore. There is only minor changes in the methods by using inheritance.

joshua-cogliati-inl · 2021-04-21T17:11:37Z

Well, I attempted to convert it to a post processor in: f4244c6

joshua-cogliati-inl · 2021-04-26T19:16:58Z

This should be ready to review again.

wangcj05

Some minor comments.

framework/Models/PostProcessors/HistorySetDelay.py

tests/framework/PostProcessors/HistorySetDelay/test_historySetDelay.xml

wangcj05 · 2021-04-27T16:16:38Z

tests/framework/PostProcessors/HistorySetDelay/test_historySetDelay.xml

+<?xml version="1.0" ?>
+<Simulation verbosity="debug">
+  <TestInfo>
+    <name>framework/Models/PostProcessors/HistorySetDelay</name>


This should be the test name, i.e. framework/PostProcessors.HistorySetDelay

wangcj05

changes are good.

alfoa

Comments addressed

alfoa · 2021-04-28T18:38:33Z

Checklist passed...

Comments addressed..

Approved to merge.

alfoa · 2021-04-28T18:38:39Z

Merging...

joshua-cogliati-inl added 5 commits April 19, 2021 15:31

Adding start of test input.

0c09d83

Adding skeleton HistorySetDelay class.

7191382

Implementing delayed parameters.

fd7710b

Adding HistorySetDelay test.

6d68dae

Adding documentation of HistorySetDelay

b1afdbb

joshua-cogliati-inl added the Ready To Review label Apr 20, 2021

alfoa requested changes Apr 20, 2021

View reviewed changes

Failed attempt to convert to a post processor.

f4244c6

alfoa and others added 6 commits April 22, 2021 12:18

fixed PP for Josh

c03e66d

Changing to only set default on un-overwritten points.

bd53350

Merge remote-tracking branch 'origin/devel' into cogljj/lag_pp_merge

727bb99

Moving out of interfaced tests since it is no longer one.

8fff215

Updating documentation with more detail.

6fb1572

Improving documentation.

41daead

wangcj05 requested changes Apr 27, 2021

View reviewed changes

Fixing review comments.

a8d72e4

wangcj05 approved these changes Apr 27, 2021

View reviewed changes

alfoa added the RAVENv2.1 All tasks and defects that will go in RAVEN v2.1 label Apr 28, 2021

alfoa approved these changes Apr 28, 2021

View reviewed changes

alfoa mentioned this pull request Apr 28, 2021

[TASK] Add lagged parameter creation #1522

Closed

10 tasks

alfoa merged commit cfb57b0 into devel Apr 28, 2021

alfoa deleted the cogljj/lag_pp branch April 28, 2021 18:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Lagged Variable PostProcessor #1523

Add Lagged Variable PostProcessor #1523

joshua-cogliati-inl commented Apr 20, 2021 •

edited by alfoa

Loading

alfoa left a comment

alfoa Apr 20, 2021

alfoa Apr 20, 2021

joshua-cogliati-inl Apr 26, 2021

alfoa Apr 20, 2021

joshua-cogliati-inl Apr 26, 2021

alfoa Apr 20, 2021

joshua-cogliati-inl Apr 26, 2021

alfoa Apr 20, 2021

alfoa Apr 20, 2021

alfoa Apr 20, 2021

alfoa Apr 20, 2021

alfoa Apr 20, 2021

joshua-cogliati-inl Apr 26, 2021

alfoa Apr 20, 2021

joshua-cogliati-inl Apr 26, 2021

joshua-cogliati-inl commented Apr 20, 2021

wangcj05 commented Apr 20, 2021

joshua-cogliati-inl commented Apr 20, 2021

wangcj05 commented Apr 20, 2021

joshua-cogliati-inl commented Apr 21, 2021

joshua-cogliati-inl commented Apr 26, 2021

wangcj05 left a comment

wangcj05 Apr 27, 2021

wangcj05 left a comment

alfoa left a comment

alfoa commented Apr 28, 2021

alfoa commented Apr 28, 2021

		@@ -0,0 +1,91 @@

		"""
		This is to implement a delay or lagged parameters in a HistorySet

Add Lagged Variable PostProcessor #1523

Add Lagged Variable PostProcessor #1523

Conversation

joshua-cogliati-inl commented Apr 20, 2021 • edited by alfoa Loading

Pull Request Description

What issue does this change request address?

What are the significant changes in functionality due to this change request?

For Change Control Board: Change Request Review

alfoa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joshua-cogliati-inl commented Apr 20, 2021

wangcj05 commented Apr 20, 2021

joshua-cogliati-inl commented Apr 20, 2021

wangcj05 commented Apr 20, 2021

joshua-cogliati-inl commented Apr 21, 2021

joshua-cogliati-inl commented Apr 26, 2021

wangcj05 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wangcj05 left a comment

Choose a reason for hiding this comment

alfoa left a comment

Choose a reason for hiding this comment

alfoa commented Apr 28, 2021

alfoa commented Apr 28, 2021

joshua-cogliati-inl commented Apr 20, 2021 •

edited by alfoa

Loading