Class to provide an interface for parameters and routines required to check convergence for the augmented Lagrangian contact problem. More...

#include <AugmentedLagrangianContactProblemInterface.h>

Inheritance diagram for AugmentedLagrangianContactProblemInterface:

[legend]

Public Member Functions
	AugmentedLagrangianContactProblemInterface (const InputParameters &params, FEProblemBase &problem)

virtual const AugmentedLagrangianContactConvergenceBase &	getAugmentedLagrangianContactConvergence () const

virtual const unsigned int &	getLagrangianIterationNumber () const

Static Public Member Functions
static InputParameters	validParams ()

Private Attributes
FEProblemBase &	_problem
	The problem that owns this interface, used to look up the convergence object.

Detailed Description

Class to provide an interface for parameters and routines required to check convergence for the augmented Lagrangian contact problem.

Definition at line 21 of file AugmentedLagrangianContactProblemInterface.h.

Constructor & Destructor Documentation

◆ AugmentedLagrangianContactProblemInterface()

AugmentedLagrangianContactProblemInterface::AugmentedLagrangianContactProblemInterface	(	const InputParameters &	params,
		FEProblemBase &	problem
	)

Definition at line 24 of file AugmentedLagrangianContactProblemInterface.C.

  : _problem(problem)
{
}

Member Function Documentation

◆ getAugmentedLagrangianContactConvergence()

const AugmentedLagrangianContactConvergenceBase & AugmentedLagrangianContactProblemInterface::getAugmentedLagrangianContactConvergence ( ) const

virtual

Returns: the augmented Lagrangian contact convergence object of the problem's nonlinear solve

Definition at line 31 of file AugmentedLagrangianContactProblemInterface.C.

{
  mooseAssert(_problem.numNonlinearSystems() == 1, "Multiple nonlinear systems are not supported.");
 
  const auto & name = _problem.getNonlinearConvergenceNames()[0];
  const auto * const convergence = dynamic_cast<const AugmentedLagrangianContactConvergenceBase *>(
      &_problem.getConvergence(name));
  if (!convergence)
    mooseError("The nonlinear convergence object '",
               name,
               "' is not an augmented Lagrangian contact convergence.");
  return *convergence;
}

Referenced by getLagrangianIterationNumber().

◆ getLagrangianIterationNumber()

virtual const unsigned int & AugmentedLagrangianContactProblemInterface::getLagrangianIterationNumber ( ) const

inlinevirtual

Definition at line 33 of file AugmentedLagrangianContactProblemInterface.h.

  {
    return getAugmentedLagrangianContactConvergence().getLagrangianIterationNumber();
  }

Referenced by NumAugmentedLagrangeIterations::getValue().

◆ validParams()

InputParameters AugmentedLagrangianContactProblemInterface::validParams ( )

static

Definition at line 15 of file AugmentedLagrangianContactProblemInterface.C.

{
  auto params = emptyInputParameters();
  params.addParam<int>("maximum_lagrangian_update_iterations",
                       100,
                       "Maximum number of update Lagrangian Multiplier iterations per step");
  return params;
}