doxygen/moose/Residual_8h_source.html

 //* This file is part of the MOOSE framework
 //* https://mooseframework.inl.gov
 //*
 //* 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 "GeneralPostprocessor.h"

 class Residual : public GeneralPostprocessor
 {
 public:
   static InputParameters validParams();

   Residual(const InputParameters & parameters);

   virtual void initialize() override {}
   virtual void execute() override {}

   virtual Real getValue() const override;

 protected:
   MooseEnum _residual_type;
 };
Residual
Definition: Residual.h:14

Residual::validParams
static InputParameters validParams()
Definition: Residual.C:19

InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Definition: InputParameters.h:66

GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition: GeneralPostprocessor.h:21

Residual::getValue
virtual Real getValue() const override
This will return the final nonlinear residual.
Definition: Residual.C:39

MooseEnum
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:33

Residual::initialize
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Definition: Residual.h:21

Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real

GeneralPostprocessor.h

Residual::Residual
Residual(const InputParameters &parameters)
Definition: Residual.C:29

MooseBaseParameterInterface::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseBaseParameterInterface.h:62

Residual::_residual_type
MooseEnum _residual_type
Definition: Residual.h:30

Residual::execute
virtual void execute() override
Execute method.
Definition: Residual.h:22