Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       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 "VariableResidual.h"
      11             : 
      12             : // MOOSE includes
      13             : #include "MooseVariable.h"
      14             : #include "NonlinearSystemBase.h"
      15             : 
      16             : // libMesh includes
      17             : #include "libmesh/enum_norm_type.h"
      18             : 
      19             : registerMooseObject("MooseApp", VariableResidual);
      20             : 
      21             : InputParameters
      22       14305 : VariableResidual::validParams()
      23             : {
      24       14305 :   InputParameters params = GeneralPostprocessor::validParams();
      25       14305 :   params.addRequiredParam<VariableName>("variable",
      26             :                                         "The name of the variable to compute the residual for");
      27             : 
      28       14305 :   params.addClassDescription(
      29             :       "Computes the L2 norm of the residual of a single variable in the solution vector.");
      30       14305 :   return params;
      31           0 : }
      32             : 
      33          20 : VariableResidual::VariableResidual(const InputParameters & parameters)
      34             :   : GeneralPostprocessor(parameters),
      35          60 :     _var(_fe_problem.getVariable(_tid,
      36          20 :                                  getParam<VariableName>("variable"),
      37             :                                  Moose::VarKindType::VAR_SOLVER,
      38          20 :                                  Moose::VarFieldType::VAR_FIELD_STANDARD))
      39             : {
      40          20 :   mooseDeprecated(
      41             :       "VariableResidual is deprecated. Please use DiscreteVariableResidualNorm instead.");
      42          20 : }
      43             : 
      44             : void
      45          18 : VariableResidual::initialize()
      46             : {
      47          18 :   _var_residual = 0;
      48          18 : }
      49             : 
      50             : void
      51          18 : VariableResidual::execute()
      52             : {
      53          18 :   NonlinearSystemBase & nl = _fe_problem.getNonlinearSystemBase(_sys.number());
      54          18 :   _var_residual = nl.system().calculate_norm(nl.RHS(), _var.number(), libMesh::DISCRETE_L2);
      55          18 : }
      56             : 
      57             : PostprocessorValue
      58          18 : VariableResidual::getValue() const
      59             : {
      60          18 :   return _var_residual;
      61             : }