libMesh::NonlinearImplicitSystem::ComputeResidual Class Referenceabstract

#include <nonlinear_implicit_system.h>

Public Member Functions

virtual ~ComputeResidual ()
virtual void residual (const NumericVector< Number > &X, NumericVector< Number > &R, sys_type &S)=0

Detailed Description

Abstract base class to be used to calculate the residual of a nonlinear system.

Definition at line 85 of file nonlinear_implicit_system.h.

Constructor & Destructor Documentation

◆ ~ComputeResidual()

virtual libMesh::NonlinearImplicitSystem::ComputeResidual::~ComputeResidual ( )

Definition at line 88 of file nonlinear_implicit_system.h.

88 {}

Member Function Documentation

◆ residual()

virtual void libMesh::NonlinearImplicitSystem::ComputeResidual::residual ( const NumericVector< Number > &  X,
NumericVector< Number > &  R,
sys_type S 
pure virtual

Residual function. This function will be called to compute the residual and must be implemented by the user in a derived class.

Referenced by libMesh::Problem_Interface::computeF(), libMesh::libmesh_petsc_snes_fd_residual(), libMesh::libmesh_petsc_snes_mffd_residual(), and libMesh::libmesh_petsc_snes_residual().

The documentation for this class was generated from the following file: