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             : #include "NodalBC.h"
      13             : 
      14             : /**
      15             :  * Base boundary condition of a Dirichlet type
      16             :  */
      17             : class DirichletBCBase : public NodalBC
      18             : {
      19             : public:
      20             :   static InputParameters validParams();
      21             : 
      22             :   DirichletBCBase(const InputParameters & parameters);
      23             : 
      24             :   /**
      25             :    * Method to preset the nodal value if applicable
      26             :    */
      27             :   void computeValue(NumericVector<Number> & current_solution);
      28             : 
      29       61665 :   bool preset() const { return _preset; }
      30             : 
      31             : protected:
      32             :   virtual Real computeQpResidual() override;
      33             : 
      34             :   /**
      35             :    * Compute the value of the DirichletBC at the current quadrature point
      36             :    */
      37             :   virtual Real computeQpValue() = 0;
      38             : 
      39             :   /// Whether or not the value is to be preset
      40             :   const bool _preset;
      41             : };