GEOS
SolidMechanicsAugmentedLagrangianContact.hpp
1 /*
2  * ------------------------------------------------------------------------------------------------------------
3  * SPDX-License-Identifier: LGPL-2.1-only
4  *
5  * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
6  * Copyright (c) 2018-2024 TotalEnergies
7  * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
8  * Copyright (c) 2023-2024 Chevron
9  * Copyright (c) 2019- GEOS/GEOSX Contributors
10  * All rights reserved
11  *
12  * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
13  * ------------------------------------------------------------------------------------------------------------
14  */
15 
16 /*
17  * SolidMechanicsAugmentedLagrangianContact.hpp
18  *
19  */
20 
21 #ifndef GEOS_PHYSICSSOLVERS_CONTACT_SOLIDMECHANICSAUGMENTEDLAGRANGIANCONTACT_HPP_
22 #define GEOS_PHYSICSSOLVERS_CONTACT_SOLIDMECHANICSAUGMENTEDLAGRANGIANCONTACT_HPP_
23 
24 #include "physicsSolvers/solidMechanics/contact/ContactSolverBase.hpp"
25 
26 namespace geos
27 {
28 
30 {
31 public:
32  SolidMechanicsAugmentedLagrangianContact( const string & name,
33  Group * const parent );
34 
36 
41  static string catalogName()
42  {
43  return "SolidMechanicsAugmentedLagrangianContact";
44  }
48  string getCatalogName() const override { return catalogName(); }
49 
50  virtual void registerDataOnMesh( dataRepository::Group & meshBodies ) override final;
51 
52  virtual void setupDofs( DomainPartition const & domain,
53  DofManager & dofManager ) const override;
54 
55  virtual void setupSystem( DomainPartition & domain,
56  DofManager & dofManager,
58  ParallelVector & rhs,
59  ParallelVector & solution,
60  bool const setSparsity = true ) override final;
61 
62  virtual void implicitStepSetup( real64 const & time_n,
63  real64 const & dt,
64  DomainPartition & domain ) override final;
65 
66  virtual void implicitStepComplete( real64 const & time_n,
67  real64 const & dt,
68  DomainPartition & domain ) override final;
69 
70  virtual void assembleSystem( real64 const time,
71  real64 const dt,
72  DomainPartition & domain,
73  DofManager const & dofManager,
74  CRSMatrixView< real64, globalIndex const > const & localMatrix,
75  arrayView1d< real64 > const & localRhs ) override;
76 
77  virtual real64 calculateResidualNorm( real64 const & time_n,
78  real64 const & dt,
79  DomainPartition const & domain,
80  DofManager const & dofManager,
81  arrayView1d< real64 const > const & localRhs ) override;
82 
83  virtual void applySystemSolution( DofManager const & dofManager,
84  arrayView1d< real64 const > const & localSolution,
85  real64 const scalingFactor,
86  real64 const dt,
87  DomainPartition & domain ) override;
88 
89  void updateState( DomainPartition & domain ) override final;
90 
91  virtual bool updateConfiguration( DomainPartition & domain,
92  integer configurationLoopIter ) override final;
93 
94 
102  template< typename LAMBDA >
103  void forFiniteElementOnFractureSubRegions( string const & meshName, LAMBDA && lambda ) const
104  {
105 
106  std::map< string,
107  array1d< localIndex > > const & faceTypesToFaceElements = m_faceTypesToFaceElements.at( meshName );
108 
109  for( const auto & [finiteElementName, faceElementList] : faceTypesToFaceElements )
110  {
111  arrayView1d< localIndex const > const faceElemList = faceElementList.toViewConst();
112 
113  finiteElement::FiniteElementBase const & subRegionFE = *(m_faceTypeToFiniteElements.at( finiteElementName ));
114 
115  lambda( finiteElementName, subRegionFE, faceElemList );
116  }
117 
118  }
119 
127  template< typename LAMBDA >
128  void forFiniteElementOnStickFractureSubRegions( string const & meshName, LAMBDA && lambda ) const
129  {
130 
131  bool const isStickState = true;
132 
133  std::map< string, array1d< localIndex > > const &
134  faceTypesToFaceElements = m_faceTypesToFaceElementsStick.at( meshName );
135 
136  for( const auto & [finiteElementName, faceElementList] : faceTypesToFaceElements )
137  {
138  arrayView1d< localIndex const > const faceElemList = faceElementList.toViewConst();
139 
140  finiteElement::FiniteElementBase const & subRegionFE = *(m_faceTypeToFiniteElements.at( finiteElementName ));
141 
142  lambda( finiteElementName, subRegionFE, faceElemList, isStickState );
143  }
144 
145  }
146 
154  template< typename LAMBDA >
155  void forFiniteElementOnSlipFractureSubRegions( string const & meshName, LAMBDA && lambda ) const
156  {
157 
158  bool const isStickState = false;
159 
160  std::map< string, array1d< localIndex > > const &
161  faceTypesToFaceElements = m_faceTypesToFaceElementsSlip.at( meshName );
162 
163  for( const auto & [finiteElementName, faceElementList] : faceTypesToFaceElements )
164  {
165  arrayView1d< localIndex const > const faceElemList = faceElementList.toViewConst();
166 
167  finiteElement::FiniteElementBase const & subRegionFE = *(m_faceTypeToFiniteElements.at( finiteElementName ));
168 
169  lambda( finiteElementName, subRegionFE, faceElemList, isStickState );
170  }
171 
172  }
173 
180  void updateStickSlipList( DomainPartition const & domain );
181 
187  void createFaceTypeList( DomainPartition const & domain );
188 
194  void createBubbleCellList( DomainPartition & domain ) const;
195 
196 private:
197 
205  void addCouplingNumNonzeros( DomainPartition & domain,
206  DofManager & dofManager,
207  arrayView1d< localIndex > const & rowLengths ) const;
208 
215  void addCouplingSparsityPattern( DomainPartition const & domain,
216  DofManager const & dofManager,
217  SparsityPatternView< globalIndex > const & pattern ) const;
218 
219  void computeTolerances( DomainPartition & domain ) const;
220 
222  std::map< string, std::map< string, array1d< localIndex > > > m_faceTypesToFaceElements;
223 
225  std::map< string, std::map< string, array1d< localIndex > > > m_faceTypesToFaceElementsStick;
226 
228  std::map< string, std::map< string, array1d< localIndex > > > m_faceTypesToFaceElementsSlip;
229 
231  std::map< string, std::unique_ptr< geos::finiteElement::FiniteElementBase > > m_faceTypeToFiniteElements;
232 
233  struct viewKeyStruct : ContactSolverBase::viewKeyStruct
234  {
235 
236  constexpr static char const * normalDisplacementToleranceString() { return "normalDisplacementTolerance"; }
237 
238  constexpr static char const * normalTractionToleranceString() { return "normalTractionTolerance"; }
239 
240  constexpr static char const * slidingToleranceString() { return "slidingTolerance"; }
241 
242  constexpr static char const * dispJumpUpdPenaltyString() { return "dispJumpUpdPenalty"; }
243 
244  constexpr static char const * simultaneousString() { return "simultaneous"; }
245 
246  constexpr static char const * symmetricString() { return "symmetric"; }
247 
248  constexpr static char const * iterativePenaltyNFacString() { return "iterPenaltyN"; }
249 
250  constexpr static char const * iterativePenaltyTFacString() { return "iterPenaltyT"; }
251 
252  constexpr static char const * tolJumpDispNFacString() { return "tolJumpN"; }
253 
254  constexpr static char const * tolJumpDispTFacString() { return "tolJumpT"; }
255 
256  constexpr static char const * tolNormalTracFacString() { return "tolNormalTrac"; }
257 
258  constexpr static char const * tolTauLimitString() { return "tolTauLimit"; }
259 
260  };
261 
264  real64 m_slidingCheckTolerance = 5.e-02;
265 
267  int m_simultaneous = 1;
268 
271  int m_symmetric = 1;
272 
274  real64 m_iterPenaltyNFac = 10.0;
275 
277  real64 m_iterPenaltyTFac = 0.1;
278 
280  real64 m_tolJumpDispNFac = 1.e-07;
281 
283  real64 m_tolJumpDispTFac = 1.e-05;
284 
286  real64 m_tolNormalTracFac = 0.5;
287 
288 };
289 
290 } /* namespace geos */
291 
292 #endif /* GEOS_PHYSICSSOLVERS_CONTACT_SOLIDMECHANICSAUGMENTEDLAGRANGIANCONTACT_HPP_ */
The DoFManager is responsible for allocating global dofs, constructing sparsity patterns,...
Definition: DofManager.hpp:45
Partition of the decomposed physical domain. It also manages the connexion information to its neighbo...
virtual void setupSystem(DomainPartition &domain, DofManager &dofManager, CRSMatrix< real64, globalIndex > &localMatrix, ParallelVector &rhs, ParallelVector &solution, bool const setSparsity=true) override final
Set up the linear system (DOF indices and sparsity patterns)
static string catalogName()
name of the node manager in the object catalog
void createFaceTypeList(DomainPartition const &domain)
Create the list of finite elements of the same type for each FaceElementSubRegion (Triangle or Quadri...
void createBubbleCellList(DomainPartition &domain) const
Create the list of elements belonging to CellElementSubRegion that are enriched with the bubble basis...
virtual real64 calculateResidualNorm(real64 const &time_n, real64 const &dt, DomainPartition const &domain, DofManager const &dofManager, arrayView1d< real64 const > const &localRhs) override
calculate the norm of the global system residual
virtual void assembleSystem(real64 const time, real64 const dt, DomainPartition &domain, DofManager const &dofManager, CRSMatrixView< real64, globalIndex const > const &localMatrix, arrayView1d< real64 > const &localRhs) override
function to assemble the linear system matrix and rhs
virtual void setupDofs(DomainPartition const &domain, DofManager &dofManager) const override
Populate degree-of-freedom manager with fields relevant to this solver.
virtual void implicitStepComplete(real64 const &time_n, real64 const &dt, DomainPartition &domain) override final
perform cleanup for implicit timestep
virtual void registerDataOnMesh(dataRepository::Group &meshBodies) override final
Register wrappers that contain data on the mesh objects.
virtual bool updateConfiguration(DomainPartition &domain, integer configurationLoopIter) override final
updates the configuration (if needed) based on the state after a converged Newton loop.
void forFiniteElementOnFractureSubRegions(string const &meshName, LAMBDA &&lambda) const
Loop over the finite element type on the fracture subregions of meshName and apply callback.
void forFiniteElementOnSlipFractureSubRegions(string const &meshName, LAMBDA &&lambda) const
Loop over the finite element type on the slip fracture subregions of meshName and apply callback.
void updateState(DomainPartition &domain) override final
Recompute all dependent quantities from primary variables (including constitutive models)
virtual void applySystemSolution(DofManager const &dofManager, arrayView1d< real64 const > const &localSolution, real64 const scalingFactor, real64 const dt, DomainPartition &domain) override
Function to apply the solution vector to the state.
virtual void implicitStepSetup(real64 const &time_n, real64 const &dt, DomainPartition &domain) override final
function to perform setup for implicit timestep
void updateStickSlipList(DomainPartition const &domain)
Create the list of finite elements of the same type for each FaceElementSubRegion (Triangle or Quadri...
void forFiniteElementOnStickFractureSubRegions(string const &meshName, LAMBDA &&lambda) const
Loop over the finite element type on the stick fracture subregions of meshName and apply callback.
Base class for FEM element implementations.
ArrayView< T, 1 > arrayView1d
Alias for 1D array view.
Definition: DataTypes.hpp:179
GEOS_GLOBALINDEX_TYPE globalIndex
Global index type (for indexing objects across MPI partitions).
Definition: DataTypes.hpp:87
LvArray::CRSMatrix< T, COL_INDEX, INDEX_TYPE, LvArray::ChaiBuffer > CRSMatrix
Alias for CRS Matrix class.
Definition: DataTypes.hpp:305
std::string string
String type.
Definition: DataTypes.hpp:90
LvArray::SparsityPatternView< COL_INDEX, INDEX_TYPE const, LvArray::ChaiBuffer > SparsityPatternView
Alias for Sparsity pattern View.
Definition: DataTypes.hpp:301
double real64
64-bit floating point type.
Definition: DataTypes.hpp:98
LvArray::CRSMatrixView< T, COL_INDEX, INDEX_TYPE const, LvArray::ChaiBuffer > CRSMatrixView
Alias for CRS Matrix View.
Definition: DataTypes.hpp:309
mapBase< TKEY, TVAL, std::integral_constant< bool, true > > map
Ordered map type.
Definition: DataTypes.hpp:339
int integer
Signed integer type.
Definition: DataTypes.hpp:81
Array< T, 1 > array1d
Alias for 1D array.
Definition: DataTypes.hpp:175
LAInterface::ParallelVector ParallelVector
Alias for ParallelVector.