Simple constant damper. More...

#include <ContactSlipDamper.h>

Inheritance diagram for ContactSlipDamper:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	ContactSlipDamper (const InputParameters &parameters)

virtual void	timestepSetup ()

void	checkMinDamping (const Real cur_damping) const

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	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

virtual void	initialSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

virtual void	meshChanged ()

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 Types
typedef std::map< std::pair< unsignedint, unsignedint >, PenetrationLocator * >::iterator	pl_iterator
	Convenient typedef for frequently used iterator.

Protected Member Functions
virtual Real	computeDamping (const NumericVector< Number > &solution, const NumericVector< Number > &update)
	Compute the amount of damping.

bool	operateOnThisInteraction (const PenetrationLocator &pen_loc)
	Determine whether the damper should operate on the interaction corresponding to the supplied PenetrationLocator.

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

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

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

Protected Attributes
AuxiliarySystem &	_aux_sys

MooseSharedPointer< DisplacedProblem >	_displaced_problem

std::set< std::pair< int, int > >	_interactions

int	_num_contact_nodes

int	_num_sticking

int	_num_slipping

int	_num_slipping_friction

int	_num_stick_locked

int	_num_slip_reversed

Real	_max_iterative_slip

Real	_min_damping_factor

Real	_damping_threshold_factor

bool	_debug_output

SubProblem &	_subproblem

SystemBase &	_sys

const Real &	_min_damping

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

const Parallel::Communicator &	_communicator

Private Member Functions
RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)

RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

ExecFlagEnum	_empty_execute_enum

const RestartableDataMapName	_metaname

std::string	_restartable_name

Detailed Description

Simple constant damper.

Modifies the non-linear step by applying a constant damping factor

Definition at line 25 of file ContactSlipDamper.h.

Member Typedef Documentation

◆ pl_iterator

typedef std::map<std::pair<unsignedint,unsignedint>,PenetrationLocator*>::iterator ContactSlipDamper::pl_iterator

protected

Convenient typedef for frequently used iterator.

Definition at line 65 of file ContactSlipDamper.h.

Constructor & Destructor Documentation

◆ ContactSlipDamper()

ContactSlipDamper::ContactSlipDamper ( const InputParameters & parameters )

Definition at line 45 of file ContactSlipDamper.C.

  : GeneralDamper(parameters),
    _aux_sys(parameters.get<FEProblemBase *>("_fe_problem_base")->getAuxiliarySystem()),
    _displaced_problem(parameters.get<FEProblemBase *>("_fe_problem_base")->getDisplacedProblem()),
    _num_contact_nodes(0),
    _num_sticking(0),
    _num_slipping(0),
    _num_slipping_friction(0),
    _num_stick_locked(0),
    _num_slip_reversed(0),
    _max_iterative_slip(parameters.get<Real>("max_iterative_slip")),
    _min_damping_factor(parameters.get<Real>("min_damping_factor")),
    _damping_threshold_factor(parameters.get<Real>("damping_threshold_factor")),
    _debug_output(parameters.get<bool>("debug_output"))
{
  if (!_displaced_problem)
    mooseError("Must have displaced problem to use ContactSlipDamper");
 
  std::vector<BoundaryName> primary = getParam<std::vector<BoundaryName>>("primary");
  std::vector<BoundaryName> secondary = getParam<std::vector<BoundaryName>>("secondary");
 
  unsigned int num_interactions = primary.size();
  if (num_interactions != secondary.size())
    mooseError(
        "Sizes of primary surface and secondary surface lists must match in ContactSlipDamper");
  if (num_interactions == 0)
    mooseError("Must define at least one primary/secondary pair in ContactSlipDamper");
 
  for (unsigned int i = 0; i < primary.size(); ++i)
  {
    std::pair<int, int> ms_pair(_subproblem.mesh().getBoundaryID(primary[i]),
                                _subproblem.mesh().getBoundaryID(secondary[i]));
    _interactions.insert(ms_pair);
  }
}

Member Function Documentation

◆ computeDamping()

Real ContactSlipDamper::computeDamping	(	const NumericVector< Number > &	solution,
		const NumericVector< Number > &	update
	)

protectedvirtual

Compute the amount of damping.

Implements GeneralDamper.

Definition at line 109 of file ContactSlipDamper.C.

{
  std::map<unsigned int, const NumericVector<Number> *> nl_soln;
  nl_soln.emplace(_sys.number(), &solution);
 
  // Do new contact search to update positions of slipped nodes
  _displaced_problem->updateMesh(nl_soln, *_aux_sys.currentSolution());
 
  Real damping = 1.0;
 
  _num_contact_nodes = 0;
  _num_sticking = 0;
  _num_slipping = 0;
  _num_slipping_friction = 0;
  _num_stick_locked = 0;
  _num_slip_reversed = 0;
 
  GeometricSearchData & displaced_geom_search_data = _displaced_problem->geomSearchData();
  const auto & penetration_locators = displaced_geom_search_data._penetration_locators;
 
  for (const auto & pl : penetration_locators)
  {
    PenetrationLocator & pen_loc = *pl.second;
 
    if (operateOnThisInteraction(pen_loc))
    {
      for (const auto & secondary_node_num : pen_loc._nearest_node._secondary_nodes)
        if (pen_loc._penetration_info[secondary_node_num])
        {
          PenetrationInfo & info = *pen_loc._penetration_info[secondary_node_num];
          const Node & node = _displaced_problem->mesh().nodeRef(secondary_node_num);
 
          if (node.processor_id() == processor_id())
          {
            if (info.isCaptured())
            {
              _num_contact_nodes++;
              if (info._mech_status == PenetrationInfo::MS_STICKING)
                _num_sticking++;
              else if (info._mech_status == PenetrationInfo::MS_SLIPPING)
                _num_slipping++;
              else if (info._mech_status == PenetrationInfo::MS_SLIPPING_FRICTION)
                _num_slipping_friction++;
              if (info._stick_locked_this_step >= 2) // TODO get from contact interaction
                _num_stick_locked++;
 
              RealVectorValue tangential_inc_slip_prev_iter =
                  info._incremental_slip_prev_iter -
                  (info._incremental_slip_prev_iter * info._normal) * info._normal;
              RealVectorValue tangential_inc_slip =
                  info._incremental_slip - (info._incremental_slip * info._normal) * info._normal;
 
              RealVectorValue tangential_it_slip =
                  tangential_inc_slip - tangential_inc_slip_prev_iter;
              Real node_damping_factor = 1.0;
              if ((tangential_inc_slip_prev_iter * tangential_inc_slip < 0.0) &&
                  info._mech_status == PenetrationInfo::MS_SLIPPING_FRICTION)
              {
                info._slip_reversed = true;
                _num_slip_reversed++;
                Real prev_iter_slip_mag = tangential_inc_slip_prev_iter.norm();
                RealVectorValue prev_iter_slip_dir =
                    tangential_inc_slip_prev_iter / prev_iter_slip_mag;
                Real cur_it_slip_in_old_dir = tangential_it_slip * prev_iter_slip_dir;
 
                if (prev_iter_slip_mag > info._slip_tol ||
                    cur_it_slip_in_old_dir > -_damping_threshold_factor * prev_iter_slip_mag)
                  node_damping_factor =
                      1.0 - (cur_it_slip_in_old_dir + prev_iter_slip_mag) / cur_it_slip_in_old_dir;
 
                if (node_damping_factor < 0.0)
                  mooseError("Damping factor can't be negative");
 
                if (node_damping_factor < _min_damping_factor)
                  node_damping_factor = _min_damping_factor;
              }
 
              if (tangential_it_slip.norm() > _max_iterative_slip)
                node_damping_factor =
                    (tangential_it_slip.norm() - _max_iterative_slip) / tangential_it_slip.norm();
 
              if (_debug_output && node_damping_factor < 1.0)
                _console << "Damping node: " << node.id()
                         << " prev iter slip: " << info._incremental_slip_prev_iter
                         << " curr iter slip: " << info._incremental_slip
                         << " slip_tol: " << info._slip_tol
                         << " damping factor: " << node_damping_factor << std::endl;
 
              if (node_damping_factor < damping)
                damping = node_damping_factor;
            }
          }
        }
    }
  }
  _console << std::flush;
  _communicator.sum(_num_contact_nodes);
  _communicator.sum(_num_sticking);
  _communicator.sum(_num_slipping);
  _communicator.sum(_num_slipping_friction);
  _communicator.sum(_num_stick_locked);
  _communicator.sum(_num_slip_reversed);
  _communicator.min(damping);
 
  _console << "   ContactSlipDamper: Damping     #Cont    #Stick     #Slip #SlipFric #StickLock  "
              "#SlipRev\n";
 
  _console << std::right << std::setw(29) << damping << std::setw(10) << _num_contact_nodes
           << std::setw(10) << _num_sticking << std::setw(10) << _num_slipping << std::setw(10)
           << _num_slipping_friction << std::setw(11) << _num_stick_locked << std::setw(10)
           << _num_slip_reversed << "\n\n";
  _console << std::flush;
 
  return damping;
}

◆ operateOnThisInteraction()

bool ContactSlipDamper::operateOnThisInteraction ( const PenetrationLocator & pen_loc )

protected

Determine whether the damper should operate on the interaction corresponding to the supplied PenetrationLocator.

Definition at line 227 of file ContactSlipDamper.C.

{
  bool operate_on_this_interaction = false;
  std::set<std::pair<int, int>>::iterator ipit;
  std::pair<int, int> ms_pair(pen_loc._primary_boundary, pen_loc._secondary_boundary);
  ipit = _interactions.find(ms_pair);
  if (ipit != _interactions.end())
    operate_on_this_interaction = true;
  return operate_on_this_interaction;
}

Referenced by computeDamping(), and timestepSetup().

◆ timestepSetup()

void ContactSlipDamper::timestepSetup ( )

virtual

Reimplemented from GeneralDamper.

Definition at line 82 of file ContactSlipDamper.C.

{
  GeometricSearchData & displaced_geom_search_data = _displaced_problem->geomSearchData();
  const auto & penetration_locators = displaced_geom_search_data._penetration_locators;
 
  for (const auto & pl : penetration_locators)
  {
    PenetrationLocator & pen_loc = *pl.second;
 
    if (operateOnThisInteraction(pen_loc))
    {
      for (const auto & secondary_node_num : pen_loc._nearest_node._secondary_nodes)
        if (pen_loc._penetration_info[secondary_node_num])
        {
          PenetrationInfo & info = *pen_loc._penetration_info[secondary_node_num];
          const Node & node = _displaced_problem->mesh().nodeRef(secondary_node_num);
 
          if (node.processor_id() == processor_id())
            //              && info.isCaptured())                  //TODO maybe just set this
            //              everywhere?
            info._slip_reversed = false;
        }
    }
  }
}

◆ validParams()

InputParameters ContactSlipDamper::validParams ( )

static

Definition at line 20 of file ContactSlipDamper.C.

{
  InputParameters params = GeneralDamper::validParams();
  params.addParam<std::vector<BoundaryName>>(
      "primary", "IDs of the primary surfaces for which slip reversals should be damped");
  params.addParam<std::vector<BoundaryName>>(
      "secondary", "IDs of the secondary surfaces for which slip reversals should be damped");
  params.addParam<Real>(
      "max_iterative_slip", std::numeric_limits<Real>::max(), "Maximum iterative slip");
  params.addRangeCheckedParam<Real>("min_damping_factor",
                                    0.0,
                                    "min_damping_factor < 1.0",
                                    "Minimum permissible value for damping factor");
  params.addParam<Real>("damping_threshold_factor",
                        1.0e3,
                        "If previous iterations's slip is below the slip tolerance, "
                        "only damp a slip reversal if the slip magnitude is greater "
                        "than than this factor times the old slip.");
  params.addParam<bool>("debug_output", false, "Output detailed debugging information");
  params.addClassDescription(
      "Damp the iterative solution to minimize oscillations in frictional contact "
      "constriants between nonlinear iterations");
  return params;
}

Member Data Documentation

◆ _aux_sys

AuxiliarySystem& ContactSlipDamper::_aux_sys

protected

Definition at line 35 of file ContactSlipDamper.h.

Referenced by computeDamping().

◆ _damping_threshold_factor

Real ContactSlipDamper::_damping_threshold_factor

protected

Definition at line 60 of file ContactSlipDamper.h.

Referenced by computeDamping().

◆ _debug_output

bool ContactSlipDamper::_debug_output

protected

Definition at line 61 of file ContactSlipDamper.h.

Referenced by computeDamping().

◆ _displaced_problem

MooseSharedPointer<DisplacedProblem> ContactSlipDamper::_displaced_problem

protected

Definition at line 36 of file ContactSlipDamper.h.

Referenced by computeDamping(), ContactSlipDamper(), and timestepSetup().

◆ _interactions

std::set<std::pair<int, int> > ContactSlipDamper::_interactions

protected

Definition at line 50 of file ContactSlipDamper.h.

Referenced by ContactSlipDamper(), and operateOnThisInteraction().

◆ _max_iterative_slip

Real ContactSlipDamper::_max_iterative_slip

protected

Definition at line 58 of file ContactSlipDamper.h.

Referenced by computeDamping().

◆ _min_damping_factor

Real ContactSlipDamper::_min_damping_factor

protected

Definition at line 59 of file ContactSlipDamper.h.

Referenced by computeDamping().

◆ _num_contact_nodes

int ContactSlipDamper::_num_contact_nodes

protected

Definition at line 52 of file ContactSlipDamper.h.

Referenced by computeDamping().

◆ _num_slip_reversed

int ContactSlipDamper::_num_slip_reversed

protected

Definition at line 57 of file ContactSlipDamper.h.

Referenced by computeDamping().

◆ _num_slipping

int ContactSlipDamper::_num_slipping

protected

Definition at line 54 of file ContactSlipDamper.h.

Referenced by computeDamping().

◆ _num_slipping_friction

int ContactSlipDamper::_num_slipping_friction

protected

Definition at line 55 of file ContactSlipDamper.h.

Referenced by computeDamping().

◆ _num_stick_locked

int ContactSlipDamper::_num_stick_locked

protected

Definition at line 56 of file ContactSlipDamper.h.

Referenced by computeDamping().

◆ _num_sticking

int ContactSlipDamper::_num_sticking

protected

Definition at line 53 of file ContactSlipDamper.h.

Referenced by computeDamping().

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

contact/include/dampers/ContactSlipDamper.h
contact/src/dampers/ContactSlipDamper.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ pl_iterator

Constructor & Destructor Documentation

◆ ContactSlipDamper()

Member Function Documentation

◆ computeDamping()

◆ operateOnThisInteraction()

◆ timestepSetup()

◆ validParams()

Member Data Documentation

◆ _aux_sys

◆ _damping_threshold_factor

◆ _debug_output

◆ _displaced_problem

◆ _interactions

◆ _max_iterative_slip

◆ _min_damping_factor

◆ _num_contact_nodes

◆ _num_slip_reversed

◆ _num_slipping

◆ _num_slipping_friction

◆ _num_stick_locked

◆ _num_sticking