TimeSequenceStepper

under construction:Undocumented Class

The TimeSequenceStepper has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.


# TimeSequenceStepper

!syntax description /Executioner/TimeStepper/TimeSequenceStepper

## Overview

!! Replace these lines with information regarding the TimeSequenceStepper object.

## Example Input File Syntax

!! Describe and include an example of how to use the TimeSequenceStepper object.

!syntax parameters /Executioner/TimeStepper/TimeSequenceStepper

!syntax inputs /Executioner/TimeStepper/TimeSequenceStepper

!syntax children /Executioner/TimeStepper/TimeSequenceStepper

Solves the Transient problem at a sequence of given time points.

Input Parameters

time_sequenceThe values of t
C++ Type:std::vector
Options:
Description:The values of t

Required Parameters

cutback_factor_at_failure0.5Factor to apply to timestep if it a time step fails to convergence.
Default:0.5
C++ Type:double
Options:
Description:Factor to apply to timestep if it a time step fails to convergence.
reset_dtFalseUse when restarting a calculation to force a change in dt.
Default:False
C++ Type:bool
Options:
Description:Use when restarting a calculation to force a change in dt.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Files

test/tests/time_steppers/timesequence_stepper/timesequence_restart1.i
test/tests/time_steppers/timesequence_stepper/timesequence_restart2.i
test/tests/time_steppers/timesequence_stepper/timesequence.i
test/tests/time_steppers/timesequence_stepper/timesequence_restart_failure.i
modules/phase_field/test/tests/misc/timestepmaterial.i
test/tests/time_steppers/timesequence_stepper/timesequence_restart3.i

test/tests/time_steppers/timesequence_stepper/timesequence_restart1.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = -1
  xmax =  1
  ymin = -1
  ymax =  1
  nx = 2
  ny = 2
  elem_type = QUAD9
[]

[Functions]
  [./exact_fn]
    type = ParsedFunction
    value = t*t*(x*x+y*y)
  [../]

  [./forcing_fn]
    type = ParsedFunction
    value = 2*t*(x*x+y*y)-4*t*t
  [../]
[]

[Variables]
  [./u]
    family = LAGRANGE
    order = SECOND
  [../]
[]

[ICs]
  [./u_var]
    type = FunctionIC
    variable = u
    function = exact_fn
  [../]
[]

[Kernels]
  [./td]
    type = TimeDerivative
    variable = u
  [../]

  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./ffn]
    type = BodyForce
    variable = u
    function = forcing_fn
  [../]
[]

[BCs]
  [./all]
    type = FunctionDirichletBC
    variable = u
    boundary = 'left right top bottom'
    function = exact_fn
  [../]
[]

[Executioner]
  type = Transient
  end_time = 4.0
  [./TimeStepper]
    type = TimeSequenceStepper
    time_sequence  = '0   0.85 1.3 2 4'
  [../]
[]

[Outputs]
  exodus = true
  [./checkpoint]
    type = Checkpoint
    num_files = 4
  [../]
[]

test/tests/time_steppers/timesequence_stepper/timesequence_restart2.i

[Mesh]
  file = timesequence_restart1_cp/0002_mesh.cpr
[]

[Problem]
  restart_file_base = timesequence_restart1_cp/0002
[]

[Functions]
  [./exact_fn]
    type = ParsedFunction
    value = t*t*(x*x+y*y)
  [../]

  [./forcing_fn]
    type = ParsedFunction
    value = 2*t*(x*x+y*y)-4*t*t
  [../]
[]

[Variables]
  [./u]
    family = LAGRANGE
    order = SECOND
  [../]
[]

[ICs]
  [./u_var]
    type = FunctionIC
    variable = u
    function = exact_fn
  [../]
[]

[Kernels]
  [./td]
    type = TimeDerivative
    variable = u
  [../]

  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./ffn]
    type = BodyForce
    variable = u
    function = forcing_fn
  [../]
[]

[BCs]
  [./all]
    type = FunctionDirichletBC
    variable = u
    boundary = 'left right top bottom'
    function = exact_fn
  [../]
[]

[Executioner]
  type = Transient
  end_time = 4.0
  [./TimeStepper]
    type = TimeSequenceStepper
    time_sequence  = '0   0.85 1.3 2 4'
  [../]
[]

[Outputs]
  exodus = true
[]

test/tests/time_steppers/timesequence_stepper/timesequence.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  xmin = -1
  xmax =  1
  ymin = -1
  ymax =  1
  nx = 2
  ny = 2
  elem_type = QUAD9
[]

[Functions]
  [./exact_fn]
    type = ParsedFunction
    value = t*t*(x*x+y*y)
  [../]

  [./forcing_fn]
    type = ParsedFunction
    value = 2*t*(x*x+y*y)-4*t*t
  [../]
[]

[Variables]
  [./u]
    family = LAGRANGE
    order = SECOND
  [../]
[]

[ICs]
  [./u_var]
    type = FunctionIC
    variable = u
    function = exact_fn
  [../]
[]

[Kernels]
  [./td]
    type = TimeDerivative
    variable = u
  [../]

  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./ffn]
    type = BodyForce
    variable = u
    function = forcing_fn
  [../]
[]

[BCs]
  [./all]
    type = FunctionDirichletBC
    variable = u
    boundary = 'left right top bottom'
    function = exact_fn
  [../]
[]

[Executioner]
  type = Transient
  end_time = 4.0
  [./TimeStepper]
    type = TimeSequenceStepper
    time_sequence  = '0   0.85 1.3 2 4'
  [../]
[]

[Outputs]
  exodus = true
[]

test/tests/time_steppers/timesequence_stepper/timesequence_restart_failure.i

[Mesh]
  file = timesequence_restart_failure1_cp/0002_mesh.cpr
[]

[Problem]
  restart_file_base = timesequence_restart_failure1_cp/0002
[]

[Functions]
  [./exact_fn]
    type = ParsedFunction
    value = t*t*(x*x+y*y)
  [../]

  [./forcing_fn]
    type = ParsedFunction
    value = 2*t*(x*x+y*y)-4*t*t
  [../]
[]

[Variables]
  [./u]
    family = LAGRANGE
    order = SECOND
  [../]
[]

[ICs]
  [./u_var]
    type = FunctionIC
    variable = u
    function = exact_fn
  [../]
[]

[Kernels]
  [./td]
    type = TimeDerivative
    variable = u
  [../]

  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./ffn]
    type = BodyForce
    variable = u
    function = forcing_fn
  [../]
[]

[BCs]
  [./all]
    type = FunctionDirichletBC
    variable = u
    boundary = 'left right top bottom'
    function = exact_fn
  [../]
[]

[Executioner]
  type = Transient
  end_time = 4.0
  [./TimeStepper]
    type = TimeSequenceStepper
    time_sequence  = '0   0.85 1.2 1.3 2 4'
  [../]
[]

[Outputs]
  exodus = true
[]

modules/phase_field/test/tests/misc/timestepmaterial.i

[Mesh]
  type = GeneratedMesh
  dim = 2
  nx = 2
  ny = 1
[]

[Materials]
  [./time]
    type = TimeStepMaterial
    outputs = exodus
  [../]
[]

[Problem]
  solve = false
  kernel_coverage_check = false
[]

[Executioner]
  type = Transient
  num_steps = 6

  [./TimeStepper]
    type = TimeSequenceStepper
    time_sequence = '4 8 15 16 23 42'
  [../]
[]

[Outputs]
  exodus = true
  execute_on = timestep_end
[]

test/tests/time_steppers/timesequence_stepper/timesequence_restart3.i

[Mesh]
  file = timesequence_restart1_cp/0002_mesh.cpr
[]

[Problem]
  restart_file_base = timesequence_restart1_cp/0002
[]

[Functions]
  [./exact_fn]
    type = ParsedFunction
    value = t*t*(x*x+y*y)
  [../]

  [./forcing_fn]
    type = ParsedFunction
    value = 2*t*(x*x+y*y)-4*t*t
  [../]
[]

[Variables]
  [./u]
    family = LAGRANGE
    order = SECOND
  [../]
[]

[ICs]
  [./u_var]
    type = FunctionIC
    variable = u
    function = exact_fn
  [../]
[]

[Kernels]
  [./td]
    type = TimeDerivative
    variable = u
  [../]

  [./diff]
    type = Diffusion
    variable = u
  [../]

  [./ffn]
    type = BodyForce
    variable = u
    function = forcing_fn
  [../]
[]

[BCs]
  [./all]
    type = FunctionDirichletBC
    variable = u
    boundary = 'left right top bottom'
    function = exact_fn
  [../]
[]

[Executioner]
  type = Transient
  end_time = 4.5
  [./TimeStepper]
    type = TimeSequenceStepper
    time_sequence  = '0   0.85 1.3 1.9 2 4 4.5'
  [../]
[]

[Outputs]
  exodus = true
[]

Child Objects

test/include/timesteppers/TimeSequenceStepperFailTest.h

test/include/timesteppers/TimeSequenceStepperFailTest.h

// This file is part of the MOOSE framework
// https://www.mooseframework.org
//
// All rights reserved, see COPYRIGHT for full restrictions
// https://github.com/idaholab/moose/blob/master/COPYRIGHT
//
// Licensed under LGPL 2.1, please see LICENSE for details
// https://www.gnu.org/licenses/lgpl-2.1.html

#pragma once

#include "TimeSequenceStepper.h"

/**
 * Exactly the same as TimeSequenceStepper, but fails at predetermined
 * timesteps.
 */
class TimeSequenceStepperFailTest : public TimeSequenceStepper
{
public:
  static InputParameters validParams();

  TimeSequenceStepperFailTest(const InputParameters & parameters);

  virtual void step() override;

protected:
  /// stores a copy of the original sequence of time points, is not updated due to failures.
  std::vector<Real> _original_time_sequence;
};

Input Parameters
Input Files
Child Objects

Application Usage

Physics and Syntax

Application Development

Framework Development

MOOSEDocs

Infrastructure

Questions

Information and Tools