Composition time stepper #23961

MengnanLi91 · 2023-04-04T17:02:40Z

Reason

Sometimes we want to benefit from the behavior of multiple time steppers, but save for re-implementing what s missing (for example IterationAdaptiveDT did that), you cant mix & match

Design

Introduce a timesteppersytem which allows timestepper action to create multiple timesteppers and a composition time stepper which can apply composition rules to input timesteppers to generate composed time step size and support times to hit with input TimeSequenceStepper.

Impact

Reaching the full capability of current time steppers

…h basic function idaholab#23961

moosebuild · 2023-04-04T17:11:35Z

Job Precheck on aefb205 wanted to post the following:

Your code requires style changes.

A patch was auto generated and copied here
You can directly apply the patch by running, in the top level of your repository:

curl -s https://mooseframework.inl.gov/docs/PRs/23961/clang_format/style.patch | git apply -v

Alternatively, with your repository up to date and in the top level of your repository:

git clang-format 40ccebf10202cd732f7af7ccfc66764e7271560c

…h basic function idaholab#23961

moosebuild · 2023-04-06T02:07:14Z

Job Documentation on a8077c4 wanted to post the following:

View the site here

This comment will be updated on new commits.

moosebuild · 2023-04-06T02:17:10Z

Job Coverage on 579dde8 wanted to post the following:

Framework coverage

	2fdaa7	#23961 579dde
	Total	Total	+/-	New
Rate	85.08%	85.09%	+0.02%	96.71%
Hits	86264	86407	+143	147
Misses	15132	15137	+5	5

Diff coverage report

Full coverage report

Modules coverage

Coverage did not change

Full coverage reports

Reports

This comment will be updated on new commits.

…h basic function idaholab#23961

moosebuild · 2023-04-06T18:57:38Z

Job Conda (ARM Mac) on 0b46ecb : invalidated by @MengnanLi91

MengnanLi91 · 2023-04-06T19:08:34Z

@GiudGiud I have some basic functions done for composition time stepper and ready for review. If you have time next week, could we schedule a meeting discussing this PR and the overlay mesh generator PR?

GiudGiud · 2023-04-07T16:59:19Z

framework/doc/content/source/timesteppers/CompositionDT.md

+## Description
+
+The `CompositionDT` TimeStepper takes TimeSteppers as inputs and generates a composed time step size based on the user specific composition rules. A base TimeStepper is required to provide a baseline time step size. The available composition rules including max, min and hit. The max/min option is specified with [!param](/Executioner/TimeStepper/CompositionDT/composition_type). It produces the maximum/minimum time step size value of all the input TimeSteppers. The hit option ensures the TimeStepper hits user specified time. It requires a TimeSequenceStepper with [!param](/Executioner/TimeStepper/CompositionDT/times_to_hit_timestepper) to specify the time sequence to hit. All together, The `CompositionDT` TimeStepper allows users to have a base time step with upper or lower limits and hit specified time points.
+


since you are doing only one operation per CompositionDT, let s mention that we can nest CompositionDT

maybe we shouldnt compose compositionDT

I think it s more simple to just have all the parameters in one?

GiudGiud · 2023-04-07T16:59:28Z

framework/doc/content/source/timesteppers/CompositionDT.md

+
+## Example Input Syntax
+
+!listing test/tests/time_steppers/composition_dt/composition_dt.i block=Executioner


describe the example

framework/doc/content/syntax/Executioner/TimeStepper/index.md

GiudGiud · 2023-04-07T17:01:20Z

framework/include/timesteppers/CompositionDT.h

+  // the name of the time sequence stepper
+  std::string _hit_timestepper_name;


there can be more than one.

It can accept multiple time sequence steppers now

framework/include/timesteppers/TimeStepperSystem.h

framework/src/executioners/Transient.C

framework/src/timesteppers/CompositionDT.C

GiudGiud · 2023-04-07T17:31:01Z

framework/src/timesteppers/CompositionDT.C

+Real
+CompositionDT::produceHitDT(const Real & composeDT)
+{
+  auto ts = setupSequenceStepper(_hit_timestepper_name);


this inits on every time step. that would be surprising?

I think the function name is misleading. It is not init but gets the current TimeSequence time. I change it to getSequenceStepper

GiudGiud · 2023-04-07T17:32:27Z

framework/src/timesteppers/CompositionDT.C

+  if (next_time_to_hit - _time <= _dt_min)
+  {
+    ts->increaseCurrentStep();


hitting steps should take priority over minimum time steps imo

we should document that

framework/src/timesteppers/TimeStepperSystem.C

GiudGiud · 2023-04-07T17:36:31Z

Tuesday and Thursday might be more difficult next week, otherwise should be good

…h basic function idaholab#23961

MengnanLi91 · 2023-04-11T23:13:55Z

@GiudGiud I've addressed most of the easy fix comments. I'll do the rest after our meeting tomorrow.

…h basic function idaholab#23961

Co-Authored-By: Guillaume Giudicelli <guillaume.giudicelli@gmail.com>

moosebuild · 2023-04-13T22:47:32Z

Job Python spack on a8077c4 : invalidated by @MengnanLi91

GiudGiud · 2023-05-03T00:08:10Z

Superseded by #24046

MengnanLi91 changed the title ~~Composition time stepper 23740~~ Composition time stepper Apr 4, 2023

MengnanLi91 added a commit to MengnanLi91/moose that referenced this pull request Apr 4, 2023

Allow multiple TimeSteppers action, create CompositionTimeStepper wit…

bfc4b19

…h basic function idaholab#23961

MengnanLi91 force-pushed the composition_time_stepper_23740 branch from 611e94b to aefb205 Compare April 4, 2023 17:07

GiudGiud self-assigned this Apr 4, 2023

MengnanLi91 added a commit to MengnanLi91/moose that referenced this pull request Apr 5, 2023

Allow multiple TimeSteppers action, create CompositionTimeStepper wit…

204aead

…h basic function idaholab#23961

MengnanLi91 force-pushed the composition_time_stepper_23740 branch from aefb205 to 08ab7ed Compare April 5, 2023 20:20

MengnanLi91 added a commit to MengnanLi91/moose that referenced this pull request Apr 5, 2023

Allow multiple TimeSteppers action, create CompositionTimeStepper wit…

1a38e44

…h basic function idaholab#23961

MengnanLi91 force-pushed the composition_time_stepper_23740 branch from 08ab7ed to fb4077f Compare April 5, 2023 20:58

MengnanLi91 added a commit to MengnanLi91/moose that referenced this pull request Apr 6, 2023

Allow multiple TimeSteppers action, create CompositionTimeStepper wit…

9c80298

…h basic function idaholab#23961

MengnanLi91 force-pushed the composition_time_stepper_23740 branch from 2869ded to b78085a Compare April 6, 2023 15:10

MengnanLi91 added a commit to MengnanLi91/moose that referenced this pull request Apr 6, 2023

Allow multiple TimeSteppers action, create CompositionTimeStepper wit…

c55f9f8

…h basic function idaholab#23961

MengnanLi91 force-pushed the composition_time_stepper_23740 branch from b78085a to 0b46ecb Compare April 6, 2023 17:59

MengnanLi91 marked this pull request as ready for review April 6, 2023 19:05

MengnanLi91 requested review from roystgnr and lindsayad as code owners April 6, 2023 19:05

moosebuild added the PR: Failed but allowed label Apr 6, 2023

GiudGiud reviewed Apr 7, 2023

View reviewed changes

GiudGiud requested changes Apr 7, 2023

View reviewed changes

MengnanLi91 added a commit to MengnanLi91/moose that referenced this pull request Apr 11, 2023

Allow multiple TimeSteppers action, create CompositionTimeStepper wit…

2a38b38

…h basic function idaholab#23961

MengnanLi91 force-pushed the composition_time_stepper_23740 branch from 0b46ecb to 579dde8 Compare April 11, 2023 23:10

moosebuild removed the PR: Failed but allowed label Apr 11, 2023

MengnanLi91 requested a review from GiudGiud April 11, 2023 23:11

Allow multiple TimeSteppers action, create CompositionTimeStepper wit…

3040269

…h basic function idaholab#23961

MengnanLi91 and others added 9 commits April 13, 2023 14:19

Allow TimeSequenceStepper in CompositionTimeStepper

bcaae6e

Add docos and test cases

d44689e

Fix TimeSequenceStepper test failure

2cee7d1

Fix docos and remove the unused variable

f47194b

Fix TimeStepperSystem naming error

ccfd3c0

Fix unity build error and duplicate detail in test

e71bdaa

Fix non-unity build failure

07b2519

Address review: improve docs and comments

c03aac6

Co-Authored-By: Guillaume Giudicelli <guillaume.giudicelli@gmail.com>

Use maximum/minimum_step_from and allow multiple time sequence steppers

7336a70

Co-Authored-By: Guillaume Giudicelli <guillaume.giudicelli@gmail.com>

MengnanLi91 force-pushed the composition_time_stepper_23740 branch from 579dde8 to 7336a70 Compare April 13, 2023 20:20

Fix compositionDT doco

a8077c4

GiudGiud closed this May 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Composition time stepper #23961

Composition time stepper #23961

MengnanLi91 commented Apr 4, 2023

moosebuild commented Apr 4, 2023

moosebuild commented Apr 6, 2023 •

edited

moosebuild commented Apr 6, 2023 •

edited

moosebuild commented Apr 6, 2023

MengnanLi91 commented Apr 6, 2023

GiudGiud Apr 7, 2023

GiudGiud Apr 7, 2023

GiudGiud Apr 7, 2023

GiudGiud Apr 7, 2023

MengnanLi91 Apr 13, 2023

GiudGiud Apr 7, 2023

MengnanLi91 Apr 12, 2023 •

edited

GiudGiud Apr 7, 2023

GiudGiud Apr 7, 2023

GiudGiud commented Apr 7, 2023

MengnanLi91 commented Apr 11, 2023

moosebuild commented Apr 13, 2023

GiudGiud commented May 3, 2023

		## Description

		The `CompositionDT` TimeStepper takes TimeSteppers as inputs and generates a composed time step size based on the user specific composition rules. A base TimeStepper is required to provide a baseline time step size. The available composition rules including max, min and hit. The max/min option is specified with [!param](/Executioner/TimeStepper/CompositionDT/composition_type). It produces the maximum/minimum time step size value of all the input TimeSteppers. The hit option ensures the TimeStepper hits user specified time. It requires a TimeSequenceStepper with [!param](/Executioner/TimeStepper/CompositionDT/times_to_hit_timestepper) to specify the time sequence to hit. All together, The `CompositionDT` TimeStepper allows users to have a base time step with upper or lower limits and hit specified time points.


		## Example Input Syntax

		!listing test/tests/time_steppers/composition_dt/composition_dt.i block=Executioner

		// the name of the time sequence stepper
		std::string _hit_timestepper_name;

Composition time stepper #23961

Composition time stepper #23961

Conversation

MengnanLi91 commented Apr 4, 2023

Reason

Design

Impact

moosebuild commented Apr 4, 2023

moosebuild commented Apr 6, 2023 • edited

moosebuild commented Apr 6, 2023 • edited

Framework coverage

Modules coverage

Full coverage reports

moosebuild commented Apr 6, 2023

MengnanLi91 commented Apr 6, 2023

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

MengnanLi91 Apr 12, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GiudGiud commented Apr 7, 2023

MengnanLi91 commented Apr 11, 2023

moosebuild commented Apr 13, 2023

GiudGiud commented May 3, 2023

moosebuild commented Apr 6, 2023 •

edited

moosebuild commented Apr 6, 2023 •

edited

MengnanLi91 Apr 12, 2023 •

edited