https://mooseframework.inl.gov
Loading...
Searching...
No Matches
Constraint.h
Go to the documentation of this file.
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
15
20{
21public:
23
25
26 virtual bool addCouplingEntriesToJacobian() { return true; }
27 virtual void subdomainSetup() override final
28 {
29 mooseError("subdomain setup for constraints is not implemented");
30 }
31
32 virtual void residualEnd() {}
33
34protected:
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
void mooseError(Args &&... args)
Emit an error message with the given stringified, concatenated args and terminate the application.
Definition MooseError.h:311
Base class for all Constraint types.
Definition Constraint.h:20
unsigned int _qp
Definition Constraint.h:36
virtual void residualEnd()
Definition Constraint.h:32
virtual void subdomainSetup() override final
Gets called when the subdomain changes (i.e.
Definition Constraint.h:27
unsigned int _j
Definition Constraint.h:35
virtual bool addCouplingEntriesToJacobian()
Definition Constraint.h:26
unsigned int _i
Definition Constraint.h:35
static InputParameters validParams()
Definition Constraint.C:15
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
const InputParameters & parameters() const
Get the parameters of the object.
Definition MooseBase.h:131
This is a base class for objects that can provide residual contributions for both local and neighbor ...