Split-based preconditioner for contact problems. More...

#include <ContactSplit.h>

Inheritance diagram for ContactSplit:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	ContactSplit (const InputParameters &params)

virtual void	setup (NonlinearSystemBase &nl, const std::string &prefix) override

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

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

Protected Member Functions
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
const std::vector< std::pair< BoundaryName, BoundaryName > >	_contact_pairs

std::vector< int >	_contact_displaced

const std::vector< std::pair< BoundaryName, BoundaryName > >	_uncontact_pairs

std::vector< int >	_uncontact_displaced

bool	_include_all_contact_nodes

	SplittingTypeAdditive

	SplittingTypeMultiplicative

	SplittingTypeSymmetricMultiplicative

	SplittingTypeSchur

FEProblemBase &	_fe_problem

std::vector< NonlinearVariableName >	_vars

std::vector< std::string >	_splitting

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

std::vector< SubdomainName >	_blocks

std::vector< BoundaryName >	_sides

std::vector< BoundaryName >	_unsides

MooseEnum	_splitting_type

MooseEnum	_schur_type

MooseEnum	_schur_pre

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

const RestartableDataMapName	_metaname

std::string	_restartable_name

Detailed Description

Split-based preconditioner for contact problems.

Definition at line 18 of file ContactSplit.h.

Constructor & Destructor Documentation

◆ ContactSplit()

ContactSplit::ContactSplit ( const InputParameters & params )

Definition at line 45 of file ContactSplit.C.

  : Split(params),
    _contact_pairs(getParam<BoundaryName, BoundaryName>("contact_primary", "contact_secondary")),
    _contact_displaced(getParam<std::vector<int>>("contact_displaced")),
    _uncontact_pairs(
        getParam<BoundaryName, BoundaryName>("uncontact_primary", "uncontact_secondary")),
    _uncontact_displaced(getParam<std::vector<int>>("uncontact_displaced")),
    _include_all_contact_nodes(getParam<bool>("include_all_contact_nodes"))
{
  if (!_contact_displaced.empty() && _contact_pairs.size() != _contact_displaced.size())
    mooseError("Primary and displaced contact lists must have matching sizes: ",
               _contact_pairs.size(),
               " != ",
               _contact_displaced.size());
 
  if (_contact_displaced.empty())
    _contact_displaced.resize(_contact_pairs.size());
 
  if (!_uncontact_displaced.empty() && _uncontact_pairs.size() != _uncontact_displaced.size())
    mooseError("Primary and displaced uncontact lists must have matching sizes: ",
               _uncontact_pairs.size(),
               " != ",
               _uncontact_displaced.size());
 
  if (!_uncontact_displaced.size())
    _uncontact_displaced.resize(_uncontact_pairs.size());
}

Member Function Documentation

◆ setup()

void ContactSplit::setup	(	NonlinearSystemBase &	nl,
		const std::string &	prefix
	)

overridevirtual

Reimplemented from Split.

Definition at line 74 of file ContactSplit.C.

{
  // A reference to the PetscOptions
  Moose::PetscSupport::PetscOptions & po = _fe_problem.getPetscOptions();
  // prefix
  const std::string dmprefix = '-' + prefix + "dm_moose_";
 
  // contacts options
  if (!_contact_pairs.empty())
  {
    // append PETSc options
    po.pairs.emplace_back(dmprefix + "ncontacts", Moose::stringify(_contact_pairs.size()));
 
    for (std::size_t j = 0; j < _contact_pairs.size(); ++j)
    {
      auto opt = dmprefix + "contact_" + Moose::stringify(j);
      po.pairs.emplace_back(opt, Moose::stringify(_contact_pairs[j], ","));
 
      if (_contact_displaced[j])
        po.pairs.emplace_back(opt + "_displaced", "yes");
    }
  }
 
  // uncontacts options
  if (!_uncontact_pairs.empty())
  {
    po.pairs.emplace_back(dmprefix + "nuncontacts", Moose::stringify(_uncontact_pairs.size()));
 
    for (std::size_t j = 0; j < _uncontact_pairs.size(); ++j)
    {
      auto opt = dmprefix + "uncontact_" + Moose::stringify(j);
      po.pairs.emplace_back(opt, Moose::stringify(_uncontact_pairs[j], ","));
 
      if (_uncontact_displaced[j])
        po.pairs.emplace_back(opt + "_displaced", "yes");
    }
  }
 
  // Whether to include all nodes on the contact surfaces
  // into the contact subsolver
  po.pairs.emplace_back(dmprefix + "includeAllContactNodes",
                        _include_all_contact_nodes ? "yes" : "no");
  Split::setup(nl, prefix);
}

◆ validParams()

InputParameters ContactSplit::validParams ( )

static

Definition at line 18 of file ContactSplit.C.

{
  InputParameters params = Split::validParams();
  params.addParam<std::vector<BoundaryName>>("contact_primary",
                                             "Primary surface list for included contacts");
  params.addParam<std::vector<BoundaryName>>("contact_secondary",
                                             "Secondary surface list for included contacts");
  params.addParam<std::vector<int>>(
      "contact_displaced",
      {},
      "List of indicators whether displaced mesh is used to define included contact");
  params.addParam<std::vector<BoundaryName>>("uncontact_primary",
                                             "Primary surface list for excluded contacts");
  params.addParam<std::vector<BoundaryName>>("uncontact_secondary",
                                             "Secondary surface list for excluded contacts");
  params.addParam<std::vector<int>>(
      "uncontact_displaced",
      {},
      "List of indicators whether displaced mesh is used to define excluded contact");
  params.addRequiredParam<bool>("include_all_contact_nodes",
                                "Whether to include all nodes on the contact surfaces");
  params.addClassDescription("Split-based preconditioner that partitions the domain into DOFs "
                             "directly involved in contact (on contact surfaces) and those "
                             "that are not");
  return params;
}

Member Data Documentation

◆ _contact_displaced

std::vector<int> ContactSplit::_contact_displaced

protected

Definition at line 28 of file ContactSplit.h.

Referenced by ContactSplit(), and setup().

◆ _contact_pairs

const std::vector<std::pair<BoundaryName, BoundaryName> > ContactSplit::_contact_pairs

protected

Definition at line 27 of file ContactSplit.h.

Referenced by ContactSplit(), and setup().

◆ _include_all_contact_nodes

bool ContactSplit::_include_all_contact_nodes

protected

Definition at line 31 of file ContactSplit.h.

Referenced by setup().

◆ _uncontact_displaced

std::vector<int> ContactSplit::_uncontact_displaced

protected

Definition at line 30 of file ContactSplit.h.

Referenced by ContactSplit(), and setup().

◆ _uncontact_pairs

const std::vector<std::pair<BoundaryName, BoundaryName> > ContactSplit::_uncontact_pairs

protected

Definition at line 29 of file ContactSplit.h.

Referenced by ContactSplit(), and setup().

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

contact/include/splits/ContactSplit.h
contact/src/splits/ContactSplit.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

Constructor & Destructor Documentation

◆ ContactSplit()

Member Function Documentation

◆ setup()

◆ validParams()

Member Data Documentation

◆ _contact_displaced

◆ _contact_pairs

◆ _include_all_contact_nodes

◆ _uncontact_displaced

◆ _uncontact_pairs