www.mooseframework.org
ExplicitEuler.C
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #include "ExplicitEuler.h"
11 #include "NonlinearSystem.h"
12 #include "FEProblem.h"
13 
15 
18 {
20  params.addClassDescription("Time integration using the explicit Euler method.");
21  return params;
22 }
23 
24 ExplicitEuler::ExplicitEuler(const InputParameters & parameters) : TimeIntegrator(parameters) {}
25 
26 void
28 {
29  if (_dt == _dt_old)
31  else
33 }
34 
35 void
37 {
38  if (!_sys.solutionUDot())
39  mooseError("ExplicitEuler: Time derivative of solution (`u_dot`) is not stored. Please set "
40  "uDotRequested() to true in FEProblemBase before requesting `u_dot`.");
41 
43  u_dot = *_solution;
45  u_dot.close();
46 
47  _du_dot_du = 1.0 / _dt;
48 }
49 
50 void
52  const dof_id_type & dof,
53  DualReal & /*ad_u_dotdot*/) const
54 {
56 }
57 
58 void
60 {
61  residual += _Re_time;
62  residual += _Re_non_time;
63  residual.close();
64 }
static InputParameters validParams()
Definition: ExplicitEuler.C:17
virtual NumericVector< Number > * solutionUDot()=0
FEProblemBase & _fe_problem
DualNumber< Real, DNDerivativeType, true > DualReal
Definition: DualReal.h:49
ExplicitEuler(const InputParameters &parameters)
Definition: ExplicitEuler.C:24
NumericVector< Number > & _Re_non_time
residual vector for non-time contributions
SystemBase & _sys
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
virtual void computeTimeDerivatives() override
Computes the time derivative and the Jacobian of the time derivative.
Definition: ExplicitEuler.C:36
virtual void postResidual(NumericVector< Number > &residual) override
Callback to the TimeIntegrator called immediately after the residuals are computed in NonlinearSystem...
Definition: ExplicitEuler.C:59
void computeADTimeDerivatives(DualReal &ad_u_dot, const dof_id_type &dof, DualReal &ad_u_dotdot) const override
method for computing local automatic differentiation time derivatives
Definition: ExplicitEuler.C:51
virtual void close()=0
Real & _du_dot_du
Derivative of time derivative with respect to current solution: .
void computeTimeDerivativeHelper(T &u_dot, const T2 &u_old) const
Helper function that actually does the math for computing the time derivative.
Definition: ExplicitEuler.h:42
const NumericVector< Number > *const & _solution
solution vectors
Explicit Euler time integrator.
Definition: ExplicitEuler.h:17
Base class for time integrators.
void setConstJacobian(bool state)
Set flag that Jacobian is constant (for optimization purposes)
void mooseError(Args &&... args) const
Emits an error prefixed with object name and type.
NumericVector< Number > & _Re_time
residual vector for time contributions
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
const NumericVector< Number > & _solution_old
virtual void preSolve() override
Definition: ExplicitEuler.C:27
registerMooseObject("MooseApp", ExplicitEuler)
static InputParameters validParams()
uint8_t dof_id_type