Petsc implementation of the contact line search (based on the Petsc LineSearchShell) More...

#include <PetscContactLineSearch.h>

Inheritance diagram for PetscContactLineSearch:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PetscContactLineSearch (const InputParameters &parameters)

virtual void	lineSearch () override

void	printContactInfo (const std::set< dof_id_type > &contact_set)
	Method for printing the contact information. More...

void	insertSet (const std::set< dof_id_type > &mech_set)
	Unionize sets from different constraints. More...

virtual void	reset ()
	Reset the line search data. More...

void	zeroIts ()

size_t	nlIts () const

virtual void	timestepSetup ()

virtual void	customSetup (const ExecFlagType &)

virtual void	initialSetup ()

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	haveParameter (const std::string &name) const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

Protected Member Functions
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

Protected Attributes
PetscNonlinearSolver< Real > *	_solver

std::set< dof_id_type >	_current_contact_state
	The current contact set. More...

std::set< dof_id_type >	_old_contact_state
	The old contact set. More...

Real	_user_ksp_rtol
	the linear tolerance set by the user in the input file More...

bool	_user_ksp_rtol_set
	Whether the user linear tolerance has been set yet in this object. More...

Real	_contact_lambda
	The multiplier of the newton step. More...

unsigned	_allowed_lambda_cuts
	How many times the linsearch is allowed to cut lambda. More...

Real	_contact_ltol
	What the linear tolerance should be while the contact state is changing. More...

bool	_affect_ltol
	Whether to modify the linear tolerance. More...

FEProblem &	_fe_problem

size_t	_nl_its

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const Parallel::Communicator &	_communicator

Detailed Description

Petsc implementation of the contact line search (based on the Petsc LineSearchShell)

Definition at line 28 of file PetscContactLineSearch.h.

Constructor & Destructor Documentation

◆ PetscContactLineSearch()

PetscContactLineSearch::PetscContactLineSearch ( const InputParameters & parameters )

Definition at line 25 of file PetscContactLineSearch.C.

   : ContactLineSearchBase(parameters)
 {
   _solver = dynamic_cast<PetscNonlinearSolver<Real> *>(
       _fe_problem.getNonlinearSystem(/*nl_sys_num=*/0).nonlinearSolver());
   if (!_solver)
     mooseError(
         "This line search operates only with Petsc, so Petsc must be your nonlinear solver.");
 }

Member Function Documentation

◆ insertSet()

void ContactLineSearchBase::insertSet ( const std::set< dof_id_type > & mech_set )

inherited

Unionize sets from different constraints.

Definition at line 53 of file ContactLineSearchBase.C.

Referenced by MechanicalContactConstraint::residualEnd().

 {
   if (_current_contact_state.empty())
     _current_contact_state = mech_set;
   else
     for (auto & node : mech_set)
       _current_contact_state.insert(node);
 }

◆ lineSearch()

void PetscContactLineSearch::lineSearch ( )

overridevirtual

Reimplemented from LineSearch.

Definition at line 36 of file PetscContactLineSearch.C.

 {
   PetscBool changed_y = PETSC_FALSE, changed_w = PETSC_FALSE;
   Vec X, F, Y, W, G, W1;
   SNESLineSearch line_search;
   PetscReal fnorm, xnorm, ynorm, gnorm;
   PetscReal ksp_rtol, ksp_abstol, ksp_dtol;
   PetscInt ksp_maxits;
   KSP ksp;
   SNES snes = _solver->snes();
 
   LibmeshPetscCall(SNESGetLineSearch(snes, &line_search));
   LibmeshPetscCall(SNESLineSearchGetVecs(line_search, &X, &F, &Y, &W, &G));
   LibmeshPetscCall(SNESLineSearchGetNorms(line_search, &xnorm, &fnorm, &ynorm));
   LibmeshPetscCall(SNESLineSearchGetSNES(line_search, &snes));
   LibmeshPetscCall(SNESLineSearchSetReason(line_search, SNES_LINESEARCH_SUCCEEDED));
   LibmeshPetscCall(SNESGetKSP(snes, &ksp));
   LibmeshPetscCall(KSPGetTolerances(ksp, &ksp_rtol, &ksp_abstol, &ksp_dtol, &ksp_maxits));
   LibmeshPetscCall(VecDuplicate(W, &W1));
 
   if (!_user_ksp_rtol_set)
   {
     _user_ksp_rtol = ksp_rtol;
     _user_ksp_rtol_set = true;
   }
 
   ++_nl_its;
 
   /* precheck */
   LibmeshPetscCall(SNESLineSearchPreCheck(line_search, X, Y, &changed_y));
 
   /* temporary update */
   _contact_lambda = 1.;
   LibmeshPetscCall(VecWAXPY(W, -_contact_lambda, Y, X));
 
   /* compute residual to determine whether contact state has changed since the last non-linear
    * residual evaluation */
   _current_contact_state.clear();
   LibmeshPetscCall(SNESComputeFunction(snes, W, F));
 #if PETSC_VERSION_LESS_THAN(3, 25, 0)
   PetscBool domainerror;
   LibmeshPetscCall(SNESGetFunctionDomainError(snes, &domainerror));
   if (domainerror)
     LibmeshPetscCall(SNESLineSearchSetReason(line_search, SNES_LINESEARCH_FAILED_DOMAIN));
 #else
   SNESConvergedReason reason;
   LibmeshPetscCall(SNESGetConvergedReason(snes, &reason));
   if (reason == SNES_DIVERGED_FUNCTION_DOMAIN)
     LibmeshPetscCall(SNESLineSearchSetReason(line_search, SNES_LINESEARCH_FAILED_FUNCTION_DOMAIN));
 #endif
 
   LibmeshPetscCall(VecNorm(F, NORM_2, &fnorm));
   std::set<dof_id_type> contact_state_stored = _current_contact_state;
   _current_contact_state.clear();
   printContactInfo(contact_state_stored);
 
   if (_affect_ltol)
   {
     if (contact_state_stored != _old_contact_state)
     {
       LibmeshPetscCall(KSPSetTolerances(ksp, _contact_ltol, ksp_abstol, ksp_dtol, ksp_maxits));
       _console << "Contact set changed since previous non-linear iteration!" << std::endl;
     }
     else
       LibmeshPetscCall(KSPSetTolerances(ksp, _user_ksp_rtol, ksp_abstol, ksp_dtol, ksp_maxits));
   }
 
   size_t ls_its = 0;
   while (ls_its < _allowed_lambda_cuts)
   {
     _contact_lambda *= 0.5;
     /* update */
     LibmeshPetscCall(VecWAXPY(W1, -_contact_lambda, Y, X));
 
     LibmeshPetscCall(SNESComputeFunction(snes, W1, G));
 #if PETSC_VERSION_LESS_THAN(3, 25, 0)
     LibmeshPetscCall(SNESGetFunctionDomainError(snes, &domainerror));
     if (domainerror)
       LibmeshPetscCall(SNESLineSearchSetReason(line_search, SNES_LINESEARCH_FAILED_DOMAIN));
 #else
     LibmeshPetscCall(SNESGetConvergedReason(snes, &reason));
     if (reason == SNES_DIVERGED_FUNCTION_DOMAIN)
       LibmeshPetscCall(
           SNESLineSearchSetReason(line_search, SNES_LINESEARCH_FAILED_FUNCTION_DOMAIN));
 #endif
 
     LibmeshPetscCall(VecNorm(G, NORM_2, &gnorm));
     if (gnorm < fnorm)
     {
       LibmeshPetscCall(VecCopy(G, F));
       LibmeshPetscCall(VecCopy(W1, W));
       fnorm = gnorm;
       contact_state_stored.swap(_current_contact_state);
       _current_contact_state.clear();
       printContactInfo(contact_state_stored);
       ++ls_its;
     }
     else
       break;
   }
 
   LibmeshPetscCall(VecScale(Y, _contact_lambda));
   /* postcheck */
   LibmeshPetscCall(SNESLineSearchPostCheck(line_search, X, Y, W, &changed_y, &changed_w));
 
   if (changed_y)
     LibmeshPetscCall(VecWAXPY(W, -1., Y, X));
 
   if (changed_w || changed_y)
   {
     LibmeshPetscCall(SNESComputeFunction(snes, W, F));
 #if PETSC_VERSION_LESS_THAN(3, 25, 0)
     LibmeshPetscCall(SNESGetFunctionDomainError(snes, &domainerror));
     if (domainerror)
       LibmeshPetscCall(SNESLineSearchSetReason(line_search, SNES_LINESEARCH_FAILED_DOMAIN));
 #else
     LibmeshPetscCall(SNESGetConvergedReason(snes, &reason));
     if (reason == SNES_DIVERGED_FUNCTION_DOMAIN)
       LibmeshPetscCall(
           SNESLineSearchSetReason(line_search, SNES_LINESEARCH_FAILED_FUNCTION_DOMAIN));
 #endif
     contact_state_stored.swap(_current_contact_state);
     _current_contact_state.clear();
     printContactInfo(contact_state_stored);
   }
 
   /* copy the solution over */
   LibmeshPetscCall(VecCopy(W, X));
 
   LibmeshPetscCall(SNESLineSearchComputeNorms(line_search));
 
   LibmeshPetscCall(VecDestroy(&W1));
 
   _old_contact_state = std::move(contact_state_stored);
 }

◆ printContactInfo()

void ContactLineSearchBase::printContactInfo ( const std::set< dof_id_type > & contact_set )

inherited

Method for printing the contact information.

Definition at line 44 of file ContactLineSearchBase.C.

Referenced by lineSearch().

 {
   if (!contact_set.empty())
     _console << contact_set.size() << " nodes in contact" << std::endl;
   else
     _console << "No nodes in contact" << std::endl;
 }

◆ reset()

void ContactLineSearchBase::reset ( )

virtualinherited

Reset the line search data.

Definition at line 63 of file ContactLineSearchBase.C.

Referenced by MechanicalContactConstraint::timestepSetup().

 {
   _current_contact_state.clear();
   zeroIts();
 }

◆ validParams()

InputParameters PetscContactLineSearch::validParams ( )

static

Definition at line 20 of file PetscContactLineSearch.C.

 {
   return ContactLineSearchBase::validParams();
 }

Member Data Documentation

◆ _affect_ltol

bool ContactLineSearchBase::_affect_ltol

protectedinherited

Whether to modify the linear tolerance.

Definition at line 77 of file ContactLineSearchBase.h.

Referenced by lineSearch().

◆ _allowed_lambda_cuts

unsigned ContactLineSearchBase::_allowed_lambda_cuts

protectedinherited

How many times the linsearch is allowed to cut lambda.

Definition at line 71 of file ContactLineSearchBase.h.

Referenced by lineSearch().

◆ _contact_lambda

Real ContactLineSearchBase::_contact_lambda

protectedinherited

The multiplier of the newton step.

Definition at line 68 of file ContactLineSearchBase.h.

Referenced by lineSearch().

◆ _contact_ltol

Real ContactLineSearchBase::_contact_ltol

protectedinherited

What the linear tolerance should be while the contact state is changing.

Definition at line 74 of file ContactLineSearchBase.h.

Referenced by lineSearch().

◆ _current_contact_state

std::set<dof_id_type> ContactLineSearchBase::_current_contact_state

protectedinherited

The current contact set.

Definition at line 58 of file ContactLineSearchBase.h.

Referenced by ContactLineSearchBase::insertSet(), lineSearch(), and ContactLineSearchBase::reset().

◆ _old_contact_state

std::set<dof_id_type> ContactLineSearchBase::_old_contact_state

protectedinherited

The old contact set.

Definition at line 60 of file ContactLineSearchBase.h.

Referenced by lineSearch().

◆ _solver

PetscNonlinearSolver<Real>* PetscContactLineSearch::_solver

protected

Definition at line 38 of file PetscContactLineSearch.h.

Referenced by lineSearch(), and PetscContactLineSearch().

◆ _user_ksp_rtol

Real ContactLineSearchBase::_user_ksp_rtol

protectedinherited

the linear tolerance set by the user in the input file

Definition at line 63 of file ContactLineSearchBase.h.

Referenced by lineSearch().

◆ _user_ksp_rtol_set

bool ContactLineSearchBase::_user_ksp_rtol_set

protectedinherited

Whether the user linear tolerance has been set yet in this object.

Definition at line 65 of file ContactLineSearchBase.h.

Referenced by lineSearch().

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

contact/include/linesearches/PetscContactLineSearch.h
contact/src/linesearches/PetscContactLineSearch.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PetscContactLineSearch()

Member Function Documentation

◆ insertSet()

◆ lineSearch()

◆ printContactInfo()

◆ reset()

◆ validParams()

Member Data Documentation

◆ _affect_ltol

◆ _allowed_lambda_cuts

◆ _contact_lambda

◆ _contact_ltol

◆ _current_contact_state

◆ _old_contact_state

◆ _solver

◆ _user_ksp_rtol

◆ _user_ksp_rtol_set