AugmentedLagrangianContactProblemTempl< T > Class Template Reference

Class to manage nested solution for augmented Lagrange contact. More...

#include <AugmentedLagrangianContactProblem.h>

Inheritance diagram for AugmentedLagrangianContactProblemTempl< T >:

Public Member Functions
	AugmentedLagrangianContactProblemTempl (const InputParameters &params)
virtual	~AugmentedLagrangianContactProblemTempl ()
virtual void	addDefaultNonlinearConvergence (const InputParameters &params) override
virtual bool	onlyAllowDefaultNonlinearConvergence () const override
void	addDefaultNonlinearConvergence (const InputParameters &params_to_apply)
void	addDefaultNonlinearConvergence (const InputParameters &params_to_apply)
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

template<class T>
class AugmentedLagrangianContactProblemTempl< T >

Class to manage nested solution for augmented Lagrange contact.

The AugmentedLagrangianContactProblem manages the nested solution procedure, repeating the solution until convergence has been achieved, checking for convergence, and updating the Lagrangian multipliers.

Definition at line 25 of file AugmentedLagrangianContactProblem.h.

Constructor & Destructor Documentation

AugmentedLagrangianContactProblemTempl()

template<class T >

AugmentedLagrangianContactProblemTempl< T >::AugmentedLagrangianContactProblemTempl

(

const InputParameters &

params

)

Definition at line 46 of file AugmentedLagrangianContactProblem.C.

  : T(params), AugmentedLagrangianContactProblemInterface(params, *this)
{
}

~AugmentedLagrangianContactProblemTempl()

template<class T >

virtual AugmentedLagrangianContactProblemTempl< T >::~AugmentedLagrangianContactProblemTempl ( )

inlinevirtual

Definition at line 32 of file AugmentedLagrangianContactProblem.h.

{}

Member Function Documentation

addDefaultNonlinearConvergence() [1/3]

template<class T >

virtual void AugmentedLagrangianContactProblemTempl< T >::addDefaultNonlinearConvergence ( const InputParameters &  params )

overridevirtual

addDefaultNonlinearConvergence() [2/3]

void AugmentedLagrangianContactProblemTempl< ReferenceResidualProblem >::addDefaultNonlinearConvergence

(

const InputParameters &

params_to_apply

)

Definition at line 54 of file AugmentedLagrangianContactProblem.C.

{
  std::string class_name = "AugmentedLagrangianContactReferenceConvergence";
  InputParameters params = this->_factory.getValidParams(class_name);
  params.applyParameters(params_to_apply);
  params.applyParameters(parameters());
  params.set<bool>("added_as_default") = true;
  // TODO: Add multi-nonlinear system support
  if (this->numNonlinearSystems() > 1)
    mooseError("Multi-system not currently implemented");
  this->addConvergence(class_name, this->getNonlinearConvergenceNames()[0], params);
}

addDefaultNonlinearConvergence() [3/3]

void AugmentedLagrangianContactProblemTempl< FEProblem >::addDefaultNonlinearConvergence

(

const InputParameters &

params_to_apply

)

Definition at line 70 of file AugmentedLagrangianContactProblem.C.

{
  std::string class_name = "AugmentedLagrangianContactFEProblemConvergence";
  InputParameters params = _factory.getValidParams(class_name);
  params.applyParameters(params_to_apply);
  params.applyParameters(parameters());
  params.set<bool>("added_as_default") = true;
  // TODO: Add multi-nonlinear system support
  if (this->numNonlinearSystems() > 1)
    mooseError("Multi-system not currently implemented");
  this->addConvergence(class_name, this->getNonlinearConvergenceNames()[0], params);
}

getAugmentedLagrangianContactConvergence()

const AugmentedLagrangianContactConvergenceBase & AugmentedLagrangianContactProblemInterface::getAugmentedLagrangianContactConvergence ( ) const

virtualinherited

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 AugmentedLagrangianContactProblemInterface::getLagrangianIterationNumber().

getLagrangianIterationNumber()

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

inlinevirtualinherited

Definition at line 33 of file AugmentedLagrangianContactProblemInterface.h.

  {
    return getAugmentedLagrangianContactConvergence().getLagrangianIterationNumber();
  }

Referenced by NumAugmentedLagrangeIterations::getValue().

onlyAllowDefaultNonlinearConvergence()

template<class T >

virtual bool AugmentedLagrangianContactProblemTempl< T >::onlyAllowDefaultNonlinearConvergence ( ) const

inlineoverridevirtual

Definition at line 35 of file AugmentedLagrangianContactProblem.h.

{ return true; }

validParams()

template<class T >

InputParameters AugmentedLagrangianContactProblemTempl< T >::validParams ( )

static

Definition at line 37 of file AugmentedLagrangianContactProblem.C.

{
  InputParameters params = T::validParams();
  params += AugmentedLagrangianContactProblemInterface::validParams();
  params.addClassDescription("Manages nested solution for augmented Lagrange contact");
  return params;
}

Member Data Documentation

_problem

FEProblemBase& AugmentedLagrangianContactProblemInterface::_problem

privateinherited

The problem that owns this interface, used to look up the convergence object.

Definition at line 40 of file AugmentedLagrangianContactProblemInterface.h.

Referenced by AugmentedLagrangianContactProblemInterface::getAugmentedLagrangianContactConvergence().

---

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

• contact/include/problems/AugmentedLagrangianContactProblem.h
• contact/src/problems/AugmentedLagrangianContactProblem.C