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

#include <PetscProjectSolutionOntoBounds.h>

Inheritance diagram for PetscProjectSolutionOntoBounds:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PetscProjectSolutionOntoBounds (const InputParameters &parameters)

void	initialSetup () override

virtual void	lineSearch () override

void	zeroIts ()

size_t	nlIts () const

virtual void	timestepSetup ()

virtual void	customSetup (const ExecFlagType &)

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
NonlinearSystemBase &	_nl

PetscNonlinearSolver< Real > *	_solver

DisplacedProblem *	_displaced_problem

const GeometricSearchData *	_geometric_search_data

const std::map< std::pair< unsigned int, unsigned int >, PenetrationLocator * > *	_pentration_locators

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 35 of file PetscProjectSolutionOntoBounds.h.

Constructor & Destructor Documentation

◆ PetscProjectSolutionOntoBounds()

PetscProjectSolutionOntoBounds::PetscProjectSolutionOntoBounds ( const InputParameters & parameters )

Definition at line 30 of file PetscProjectSolutionOntoBounds.C.

   : LineSearch(parameters), _nl(_fe_problem.getNonlinearSystemBase(/*nl_sys_num=*/0))
 {
   _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

◆ initialSetup()

void PetscProjectSolutionOntoBounds::initialSetup ( )

overridevirtual

Reimplemented from LineSearch.

Definition at line 41 of file PetscProjectSolutionOntoBounds.C.

 {
   _displaced_problem = _fe_problem.getDisplacedProblem().get();
   if (!_displaced_problem)
     mooseError("This line search only makes sense in a displaced context");
 }

◆ lineSearch()

void PetscProjectSolutionOntoBounds::lineSearch ( )

overridevirtual

Reimplemented from LineSearch.

Definition at line 49 of file PetscProjectSolutionOntoBounds.C.

 {
   PetscBool changed_y = PETSC_FALSE;
   Vec X, F, Y, W, G;
   SNESLineSearch line_search;
   PetscReal fnorm, xnorm, ynorm;
   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(SNESLineSearchSetReason(line_search, SNES_LINESEARCH_SUCCEEDED));
 
   LibmeshPetscCall(SNESLineSearchPreCheck(line_search, X, Y, &changed_y));
 
   // apply the full newton step
   LibmeshPetscCall(VecWAXPY(W, -1., Y, X));
 
   {
     PetscVector<Number> solution(W, this->comm());
 
     _nl.setSolution(solution);
 
     // Displace the mesh and update the displaced geometric search objects
     _displaced_problem->updateMesh();
   }
 
   // A reference to the displaced MeshBase object
   const auto & mesh = _displaced_problem->mesh().getMesh();
 
   const auto & pen_locs = _displaced_problem->geomSearchData().getPenetrationLocators();
 
   // Keep track of the secondary nodes that we push back onto the primary face. We'll eventually
   // check to make sure that we didn't have a corner node at the intersection of two secondary faces
   // that we tried to displace twice. As this stands now this won't cover the case wherethe
   // intersection happens only across processes
   std::set<dof_id_type> nodes_displaced;
 
   std::vector<unsigned int> disp_nums;
 
   // Generate the displaced variable numbers
   for (const auto & disp_name : _displaced_problem->getDisplacementVarNames())
     disp_nums.push_back(_nl.system().variable_number(disp_name));
 
   for (const auto & pen_loc : pen_locs)
     for (const auto & pinfo_pair : pen_loc.second->_penetration_info)
     {
       auto node_id = pinfo_pair.first;
       auto pen_info = pinfo_pair.second;
 
       // We have penetration
       if (pen_info && pen_info->_distance > 0)
       {
 // Avoid warning in optimized modes about unused variables
 #ifndef NDEBUG
         // Make sure we haven't done this node before
         auto pair = nodes_displaced.insert(node_id);
         mooseAssert(pair.second, "Node id " << node_id << " has already been displaced");
 #endif
 
         const auto & node = mesh.node_ref(node_id);
 
         // If this is not a local node, we will let displacement happen on another process
         if (node.processor_id() != this->processor_id())
           continue;
 
         // The vector that we need to displace by
         auto required_solution_change = pen_info->_distance * pen_info->_normal;
 
         unsigned component = 0;
         std::vector<PetscInt> indices;
         std::vector<PetscScalar> values;
         for (auto disp_num : disp_nums)
         {
           auto dof_number = node.dof_number(/*sys=*/0, disp_num, /*component=*/0);
           indices.push_back(static_cast<PetscInt>(dof_number));
           values.push_back(static_cast<PetscScalar>(required_solution_change(component++)));
         }
         LibmeshPetscCall(VecSetValues(
             W, static_cast<PetscInt>(indices.size()), indices.data(), values.data(), ADD_VALUES));
       }
     }
 
   LibmeshPetscCall(VecAssemblyBegin(W));
   LibmeshPetscCall(VecAssemblyEnd(W));
 
   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));
 
   LibmeshPetscCall(VecCopy(W, X));
 
   LibmeshPetscCall(SNESLineSearchComputeNorms(line_search));
 }

◆ validParams()

InputParameters PetscProjectSolutionOntoBounds::validParams ( )

static

Definition at line 25 of file PetscProjectSolutionOntoBounds.C.

 {
   return LineSearch::validParams();
 }

Member Data Documentation

◆ _displaced_problem

DisplacedProblem* PetscProjectSolutionOntoBounds::_displaced_problem

protected

Definition at line 48 of file PetscProjectSolutionOntoBounds.h.

Referenced by initialSetup(), and lineSearch().

◆ _geometric_search_data

const GeometricSearchData* PetscProjectSolutionOntoBounds::_geometric_search_data

protected

Definition at line 49 of file PetscProjectSolutionOntoBounds.h.

◆ _nl

NonlinearSystemBase& PetscProjectSolutionOntoBounds::_nl

protected

Definition at line 46 of file PetscProjectSolutionOntoBounds.h.

Referenced by lineSearch().

◆ _pentration_locators

const std::map<std::pair<unsigned int, unsigned int>, PenetrationLocator *>* PetscProjectSolutionOntoBounds::_pentration_locators

protected

Definition at line 51 of file PetscProjectSolutionOntoBounds.h.

◆ _solver

PetscNonlinearSolver<Real>* PetscProjectSolutionOntoBounds::_solver

protected

Definition at line 47 of file PetscProjectSolutionOntoBounds.h.

Referenced by lineSearch(), and PetscProjectSolutionOntoBounds().

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

contact/include/linesearches/PetscProjectSolutionOntoBounds.h
contact/src/linesearches/PetscProjectSolutionOntoBounds.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

◆ PetscProjectSolutionOntoBounds()

Member Function Documentation

◆ initialSetup()

◆ lineSearch()

◆ validParams()

Member Data Documentation

◆ _displaced_problem

◆ _geometric_search_data

◆ _nl

◆ _pentration_locators

◆ _solver