Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       3             : //*
       4             : //* All rights reserved, see COPYRIGHT for full restrictions
       5             : //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
       6             : //*
       7             : //* Licensed under LGPL 2.1, please see LICENSE for details
       8             : //* https://www.gnu.org/licenses/lgpl-2.1.html
       9             : 
      10             : #pragma once
      11             : 
      12             : // MOOSE includes
      13             : #include "NeighborResidualObject.h"
      14             : #include "GeometricSearchInterface.h"
      15             : 
      16             : /**
      17             :  * Base class for all Constraint types
      18             :  */
      19             : class Constraint : public NeighborResidualObject, protected GeometricSearchInterface
      20             : {
      21             : public:
      22             :   static InputParameters validParams();
      23             : 
      24             :   Constraint(const InputParameters & parameters);
      25             : 
      26        5127 :   virtual bool addCouplingEntriesToJacobian() { return true; }
      27           0 :   virtual void subdomainSetup() override final
      28             :   {
      29           0 :     mooseError("subdomain setup for constraints is not implemented");
      30             :   }
      31             : 
      32       11130 :   virtual void residualEnd() {}
      33             : 
      34             : protected:
      35             :   unsigned int _i, _j;
      36             :   unsigned int _qp;
      37             : };
      38             : 
      39             : #define usingConstraintMembers                                                                     \
      40             :   usingMooseObjectMembers;                                                                         \
      41             :   usingUserObjectInterfaceMembers;                                                                 \
      42             :   usingTaggingInterfaceMembers;                                                                    \
      43             :   using Constraint::_i;                                                                            \
      44             :   using Constraint::_qp;                                                                           \
      45             :   using Constraint::_tid