Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://www.mooseframework.org
       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 "KokkosBoundaryCondition.h"
      13             : #include "CoupleableMooseVariableDependencyIntermediateInterface.h"
      14             : 
      15             : namespace Moose
      16             : {
      17             : namespace Kokkos
      18             : {
      19             : 
      20             : /**
      21             :  * The base class for Kokkos nodal boundary conditions
      22             :  */
      23             : class NodalBCBase : public BoundaryCondition,
      24             :                     public CoupleableMooseVariableDependencyIntermediateInterface
      25             : {
      26             : public:
      27             :   static InputParameters validParams();
      28             : 
      29             :   /**
      30             :    * Constructor
      31             :    * @param field_type The MOOSE variable field type
      32             :    */
      33             :   NodalBCBase(const InputParameters & parameters, Moose::VarFieldType field_type);
      34             :   /**
      35             :    * Copy constructor for parallel dispatch
      36             :    */
      37             :   NodalBCBase(const NodalBCBase & object);
      38             : 
      39             :   /**
      40             :    * Get the list of contiguous node IDs this object is operating on
      41             :    * @returns The list of contiguous node IDs
      42             :    */
      43             :   std::vector<ContiguousNodeID> getContiguousNodes() const;
      44             : 
      45             :   /**
      46             :    * For use in Dirichlet boundary conditions only
      47             :    */
      48             :   ///@{
      49          12 :   virtual bool preset() const { return false; }
      50           0 :   virtual void presetSolution(TagID /* tag */) {}
      51             :   ///@}
      52             : };
      53             : 
      54             : } // namespace Kokkos
      55             : } // namespace Moose
      56             : 
      57             : #define usingKokkosNodalBCBaseMembers usingKokkosBoundaryConditionMembers