LineSearch.h

Go to the documentation of this file.

//* 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 "MooseObject.h"
 
class FEProblem;
class LineSearch : public MooseObject
{
public:
  static InputParameters validParams();
 
  LineSearch(const InputParameters & parameters);
 
  void zeroIts() { _nl_its = 0; }
 
  size_t nlIts() const { return _nl_its; }
 
  virtual void lineSearch() { mooseError("You must implement a line-search method."); }
 
  virtual void timestepSetup() {}
  virtual void customSetup(const ExecFlagType & /*exec_type*/) {}
  virtual void initialSetup() {}
 
protected:
  FEProblem & _fe_problem;
 
  size_t _nl_its;
};