Merge pull request #12756 from permcody/multiap_start_time

Multiapp start time

framework/include/multiapps/FullSolveMultiApp.h

@@ -33,10 +33,6 @@ class FullSolveMultiApp : public MultiApp
 
   virtual bool solveStep(Real dt, Real target_time, bool auto_advance = true) override;
 
-  virtual void incrementTStep() override {}
-
-  virtual void finishStep() override {}
-
   virtual bool isSolved() const override { return _solved; }
 
 private:

framework/include/multiapps/MultiApp.h

@@ -112,16 +112,7 @@ class MultiApp : public MooseObject, public SetupInterface, public Restartable
    * which is called either directly from solveStep() for loose coupling cases
    * or through finishStep() for Picard coupling cases)
    */
-  virtual void incrementTStep() {}
-
-  /**
-   * Deprecated method. Use finishStep
-   */
-  virtual void advanceStep()
-  {
-    mooseDeprecated("advanceStep() is deprecated; please use finishStep() instead");
-    finishStep();
-  }
+  virtual void incrementTStep(Real /*target_time*/) {}
 
   /**
    * Calls multi-apps executioners' endStep and postStep methods which creates output and advances
@@ -399,6 +390,9 @@ class MultiApp : public MooseObject, public SetupInterface, public Restartable
   /// Whether or not to move the output of the MultiApp into position
   bool _output_in_position;
 
+  /// The offset time so the MultiApp local time relative to the global time
+  const Real _global_time_offset;
+
   /// The time at which to reset apps
   Real _reset_time;
 

framework/include/multiapps/TransientMultiApp.h

@@ -40,7 +40,7 @@ class TransientMultiApp : public MultiApp
 
   virtual bool solveStep(Real dt, Real target_time, bool auto_advance = true) override;
 
-  virtual void incrementTStep() override;
+  virtual void incrementTStep(Real target_time) override;
 
   virtual void finishStep() override;
 

framework/src/multiapps/MultiApp.C

@@ -112,6 +112,11 @@ validParams<MultiApp>()
       false,
       "If true this will cause the output from the MultiApp to be 'moved' by its position vector");
 
+  params.addParam<Real>("global_time_offset",
+                        0,
+                        "The time offset relative to the master application for the purpose of "
+                        "starting a subapp at different time from the master application. The "
+                        "global time will be ahead by the offset specified here.");
   params.addParam<Real>("reset_time",
                         std::numeric_limits<Real>::max(),
                         "The time at which to reset Apps given by the 'reset_apps' parameter.  "
@@ -173,6 +178,7 @@ MultiApp::MultiApp(const InputParameters & parameters)
     _bounding_box_padding(getParam<Point>("bounding_box_padding")),
     _max_procs_per_app(getParam<unsigned int>("max_procs_per_app")),
     _output_in_position(getParam<bool>("output_in_position")),
+    _global_time_offset(getParam<Real>("global_time_offset")),
     _reset_time(getParam<Real>("reset_time")),
     _reset_apps(getParam<std::vector<unsigned int>>("reset_apps")),
     _reset_happened(false),
@@ -229,7 +235,7 @@ MultiApp::initialSetup()
         _app_type, getParam<std::string>("library_path"), getParam<std::string>("library_name"));
 
   for (unsigned int i = 0; i < _my_num_apps; i++)
-    createApp(i, _app.getGlobalTimeOffset());
+    createApp(i, _global_time_offset);
 }
 
 void

framework/src/multiapps/TransientMultiApp.C

@@ -110,27 +110,38 @@ TransientMultiApp::TransientMultiApp(const InputParameters & parameters)
 {
   // Transfer interpolation only makes sense for sub-cycling solves
   if (_interpolate_transfers && !_sub_cycling)
-    mooseError("MultiApp ",
+    paramError("interpolate_transfers",
+               "MultiApp ",
                name(),
                " is set to interpolate_transfers but is not sub_cycling!  That is not valid!");
 
   // Subcycling overrides catch up, we don't want to confuse users by allowing them to set both.
   if (_sub_cycling && _catch_up)
-    mooseError("MultiApp ",
+    paramError("catch_up",
+               "MultiApp ",
                name(),
-               " sub_cycling and catch_up cannot both be set to true simultaneously.");
+               " \"sub_cycling\" and \"catch_up\" cannot both be set to true simultaneously.");
 
   if (_sub_cycling && _keep_solution_during_restore)
-    mooseError("In MultiApp ",
+    paramError("keep_solution_during_restore",
+               "In MultiApp ",
                name(),
                " it doesn't make any sense to keep a solution during restore when doing "
-               "sub_cycling.  Consider trying catch_up steps instead");
+               "sub_cycling.  Consider trying \"catch_up\" steps instead");
 
   if (!_catch_up && _keep_solution_during_restore)
-    mooseError("In MultiApp ",
+    paramError("keep_solution_during_restore",
+               "In MultiApp ",
                name(),
-               " `keep_solution_during_restore` requires `catch_up = true`.  Either disable "
-               "`keep_solution_during_restart` or set `catch_up = true`");
+               " \"keep_solution_during_restore\" requires \"catch_up = true\".  Either disable "
+               "\"keep_solution_during_restart\" or set \"catch_up = true\"");
+
+  if (_sub_cycling && _tolerate_failure)
+    paramInfo("tolerate_failure",
+              "In MultiApp ",
+              name(),
+              " both \"sub_cycling\" and \"tolerate_failure\" are set to true. \"tolerate_failure\""
+              " will be ignored.");
 }
 
 NumericVector<Number> &
@@ -220,7 +231,6 @@ TransientMultiApp::solveStep(Real dt, Real target_time, bool auto_advance)
 
     for (unsigned int i = 0; i < _my_num_apps; i++)
     {
-
       FEProblemBase & problem = appProblemBase(_first_local_app + i);
 
       Transient * ex = _transient_executioners[i];
@@ -441,7 +451,7 @@ TransientMultiApp::solveStep(Real dt, Real target_time, bool auto_advance)
             }
           }
         }
-        else
+        else // auto_advance == false
         {
           if (!ex->lastSolveConverged())
           {
@@ -520,14 +530,21 @@ TransientMultiApp::solveStep(Real dt, Real target_time, bool auto_advance)
 }
 
 void
-TransientMultiApp::incrementTStep()
+TransientMultiApp::incrementTStep(Real target_time)
 {
   if (!_sub_cycling)
   {
     for (unsigned int i = 0; i < _my_num_apps; i++)
     {
       Transient * ex = _transient_executioners[i];
-      ex->incrementStepOrReject();
+
+      // The App might have a different local time from the rest of the problem
+      Real app_time_offset = _apps[i]->getGlobalTimeOffset();
+
+      // Only increment the step if we are after (target_time) the
+      // start_time (app_time_offset) of this sub_app.
+      if (app_time_offset < target_time)
+        ex->incrementStepOrReject();
     }
   }
 }

framework/src/problems/FEProblemBase.C

@@ -3608,7 +3608,7 @@ FEProblemBase::incrementMultiAppTStep(ExecFlagType type)
 
   if (multi_apps.size())
     for (const auto & multi_app : multi_apps)
-      multi_app->incrementTStep();
+      multi_app->incrementTStep(_time);
 }
 
 void

modules/level_set/include/multiapps/LevelSetReinitializationMultiApp.h

@@ -31,8 +31,6 @@ class LevelSetReinitializationMultiApp : public MultiApp
   LevelSetReinitializationMultiApp(const InputParameters & parameters);
 
   virtual void initialSetup() override;
-  virtual void incrementTStep() override {}
-  virtual void finishStep() override {}
   virtual bool solveStep(Real dt, Real target_time, bool auto_advance = true) override;
 
 protected:

test/tests/multiapps/check_error/tests

@@ -1,56 +1,81 @@
 [Tests]
+  design = "MultiApps/index.md"
   [./input_file]
     type = 'RunException'
     input = 'check_error.i'
     expect_err = 'missing required parameter'
+
+    issues = "#4101 #4113"
+    requirement = "The system shall detect input file problems with sub app input files."
   [../]
 
   [./unused_subapp_param]
     type = 'RunException'
     input = 'check_error.i'
     cli_args = 'MultiApps/multi/input_files="sub_unused.i"'
     expect_err = 'unused parameter'
+
+    issues = "#4101 #4113"
+    requirement = "The system shall CLI argument problems related to sub app input files."
   [../]
 
   [./positions]
     type = 'RunException'
     input = 'check_error.i'
     expect_err = 'Not enough positions for the number of input files'
     cli_args = 'MultiApps/multi/input_files="sub1.i sub2.i"'
+
+    issues = "#1845 #3556 #5784"
+    requirement = "The system show error when the number of input files is great than one and doesn't match the number of provided sub app positions."
   [../]
 
   [./not_enough_positions]
     type = 'RunException'
     input = 'check_error.i'
     expect_err = 'Not enough positions for the number of input files'
     cli_args = 'MultiApps/multi/input_files="sub1.i sub2.i" MultiApps/multi/positions="0 1 0"'
+
+    issues = "#1845 #3556 #5784"
+    requirement = "The system show error when the number of input files is great than one and doesn't match the number of provided sub app positions when using CLI overrides."
   [../]
 
   [./not_enough_position_files]
     type = 'RunException'
     input = 'check_error.i'
     expect_err = 'Number of input_files for MultiApp'
     cli_args = 'MultiApps/multi/input_files="sub1.i sub2.i" MultiApps/multi/positions_file="position1"'
+
+    issues = "#1845 #3556 #5784"
+    requirement = "The system shall error when the number of sub app input files doesn't match the number of provided positions files."
   [../]
 
   [./both_positions]
     type = 'RunException'
     input = 'check_error.i'
     expect_err = 'Both \'positions\' and \'positions_file\' cannot be specified simultaneously in MultiApp'
     cli_args = 'MultiApps/multi/input_files="sub1.i sub2.i" MultiApps/multi/positions="0 1 0" MultiApps/multi/positions_file="position1"'
+
+    issues = "#1845 #3556 #5784"
+    requirement = "The system shall error when both positions are provided in the input file along with a separate file of positions."
   [../]
 
   [./bad_positions]
     type = 'RunException'
     input = 'check_error.i'
     expect_err = 'Number of entries in \'positions_file\''
     cli_args = 'MultiApps/multi/input_files="sub1.i" MultiApps/multi/positions_file="bad_positions.txt"'
+
+    issues = "#1845 #3556 #5784"
+    requirement = "The system shall error when the multiapp positions file is malformed."
   [../]
 
   [./sub_cycling_and_catch_up]
     type = 'RunException'
     input = 'check_error.i'
-    expect_err = 'sub_cycling and catch_up cannot both be set to true'
+    expect_err = '"sub_cycling" and "catch_up" cannot both be set to true'
     cli_args = 'MultiApps/multi/input_files="sub1.i" MultiApps/multi/positions="0 1 0" MultiApps/multi/sub_cycling=true MultiApps/multi/catch_up=true'
+
+    issues = "#6127"
+    requirement = "The system shall error when the Multiapp parameter sub_cycling and catch_up are both set to true."
   [../]
 []

test/tests/multiapps/time_offset/master.i

@@ -0,0 +1,58 @@
+[Mesh]
+  type = GeneratedMesh
+  dim = 2
+  nx = 10
+  ny = 10
+[]
+
+[Variables]
+  [./u]
+  [../]
+[]
+
+[Kernels]
+  [./diff]
+    type = Diffusion
+    variable = u
+  [../]
+  [./td]
+    type = TimeDerivative
+    variable = u
+  [../]
+[]
+
+[BCs]
+  [./left]
+    type = DirichletBC
+    variable = u
+    boundary = left
+    value = 0
+  [../]
+  [./right]
+    type = DirichletBC
+    variable = u
+    boundary = right
+    value = 1
+  [../]
+[]
+
+[Executioner]
+  type = Transient
+  num_steps = 10
+  dt = 0.2
+
+  petsc_options_iname = '-pc_type -pc_hypre_type'
+  petsc_options_value = 'hypre boomeramg'
+[]
+
+[Outputs]
+  exodus = true
+[]
+
+[MultiApps]
+  [./sub_app]
+    type = TransientMultiApp
+    input_files = 'sub.i'
+    global_time_offset = 0.8
+  [../]
+[]

test/tests/multiapps/time_offset/sub.i

@@ -0,0 +1,50 @@
+[Mesh]
+  type = GeneratedMesh
+  dim = 2
+  nx = 10
+  ny = 10
+[]
+
+[Variables]
+  [./u]
+  [../]
+[]
+
+[Kernels]
+  [./diff]
+    type = Diffusion
+    variable = u
+  [../]
+  [./td]
+    type = TimeDerivative
+    variable = u
+  [../]
+[]
+
+[BCs]
+  [./left]
+    type = DirichletBC
+    variable = u
+    boundary = left
+    value = 0
+  [../]
+  [./right]
+    type = DirichletBC
+    variable = u
+    boundary = right
+    value = 1
+  [../]
+[]
+
+[Executioner]
+  type = Transient
+  num_steps = 10
+  dt = 1 # This will be constrained by the master solve
+
+  petsc_options_iname = '-pc_type -pc_hypre_type'
+  petsc_options_value = 'hypre boomeramg'
+[]
+
+[Outputs]
+  exodus = true
+[]

test/tests/multiapps/time_offset/tests

@@ -0,0 +1,11 @@
+[Tests]
+  [start_time]
+    type = Exodiff
+    input = master.i
+    exodiff = master_out_sub_app0.e
+
+    issues = #12755
+    requirement = "The system shall support a time offset between the master and a subapp when using the Multiapp system."
+    design = "TransientMultiApp.md"
+  []
+[]