www.mooseframework.org
ImplicitEuler.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 "ImplicitEuler.h"
11 #include "NonlinearSystem.h"
12 
14 
15 template <>
18 {
20 
21  return params;
22 }
23 
24 ImplicitEuler::ImplicitEuler(const InputParameters & parameters) : TimeIntegrator(parameters) {}
25 
27 
28 void
30 {
31  if (!_sys.solutionUDot())
32  mooseError("ImplicitEuler: Time derivative of solution (`u_dot`) is not stored. Please set "
33  "uDotRequested() to true in FEProblemBase befor requesting `u_dot`.");
34 
35  NumericVector<Number> & u_dot = *_sys.solutionUDot();
36  u_dot = *_solution;
38  u_dot.close();
39 
40  _du_dot_du = 1.0 / _dt;
41 }
42 
43 void
44 ImplicitEuler::computeADTimeDerivatives(DualReal & ad_u_dot, const dof_id_type & dof) const
45 {
47 }
48 
49 void
50 ImplicitEuler::postResidual(NumericVector<Number> & residual)
51 {
52  residual += _Re_time;
53  residual += _Re_non_time;
54  residual.close();
55 }
void computeADTimeDerivatives(DualReal &ad_u_dot, const dof_id_type &dof) const override
method for computing local automatic differentiation time derivatives
Definition: ImplicitEuler.C:44
virtual NumericVector< Number > * solutionUDot()=0
virtual void computeTimeDerivatives() override
Definition: ImplicitEuler.C:29
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...
DualNumber< Real, NumberArray< AD_MAX_DOFS_PER_ELEM, Real > > DualReal
Definition: DualReal.h:29
void mooseError(Args &&... args) const
Definition: MooseObject.h:147
registerMooseObject("MooseApp", ImplicitEuler)
virtual ~ImplicitEuler()
Definition: ImplicitEuler.C:26
void computeTimeDerivativeHelper(T &u_dot, const T2 &u_old) const
Helper function that actually does the math for computing the time derivative.
Definition: ImplicitEuler.h:43
InputParameters validParams< TimeIntegrator >()
Real & _du_dot_du
solution vector for
const NumericVector< Number > *const & _solution
solution vectors
Base class for time integrators.
InputParameters validParams< ImplicitEuler >()
Definition: ImplicitEuler.C:17
ImplicitEuler(const InputParameters &parameters)
Definition: ImplicitEuler.C:24
NumericVector< Number > & _Re_time
residual vector for time contributions
const NumericVector< Number > & _solution_old
virtual void postResidual(NumericVector< Number > &residual) override
Callback to the TimeIntegrator called immediately after the residuals are computed in NonlinearSystem...
Definition: ImplicitEuler.C:50
Implicit Euler&#39;s method.
Definition: ImplicitEuler.h:22