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)

virtual const unsigned int &	getLagrangianIterationNumber () const

virtual void	setLagrangianIterationNumber (unsigned int iter)

Static Public Member Functions
static InputParameters	validParams ()

Protected Attributes
const unsigned int	_maximum_number_lagrangian_iterations
	maximum mumber of augmented lagrange iterations More...

unsigned int	_lagrangian_iteration_number
	current augmented lagrange iteration number More...

Detailed Description

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

Definition at line 18 of file AugmentedLagrangianContactProblemInterface.h.

Constructor & Destructor Documentation

◆ AugmentedLagrangianContactProblemInterface()

AugmentedLagrangianContactProblemInterface::AugmentedLagrangianContactProblemInterface ( const InputParameters & params )

Definition at line 22 of file AugmentedLagrangianContactProblemInterface.C.

   : _maximum_number_lagrangian_iterations(params.get<int>("maximum_lagrangian_update_iterations"))
 {
 }

Member Function Documentation

◆ getLagrangianIterationNumber()

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

inlinevirtual

Definition at line 23 of file AugmentedLagrangianContactProblemInterface.h.

Referenced by AugmentedLagrangianContactConvergence< T >::checkConvergence(), and NumAugmentedLagrangeIterations::getValue().

   {
     return _lagrangian_iteration_number;
   }

◆ setLagrangianIterationNumber()

virtual void AugmentedLagrangianContactProblemInterface::setLagrangianIterationNumber ( unsigned int iter )

inlinevirtual

Definition at line 27 of file AugmentedLagrangianContactProblemInterface.h.

   {
     _lagrangian_iteration_number = iter;
   }

◆ validParams()

InputParameters AugmentedLagrangianContactProblemInterface::validParams ( )

static

Definition at line 13 of file AugmentedLagrangianContactProblemInterface.C.

Referenced by AugmentedLagrangianContactConvergence< T >::validParams(), and AugmentedLagrangianContactProblemTempl< T >::validParams().

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