Loading [MathJax]/extensions/tex2jax.js
www.mooseframework.org
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
ADPresetNodalBC.C
Go to the documentation of this file.
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 #include "ADPresetNodalBC.h"
12 
13 template <ComputeStage compute_stage>
16 {
18 
19  params.addClassDescription(
20  "Nodal boundary condition base class with preset solution vector values.");
21 
22  // Utilize the new ADDirichletBCBase with preset, set true and don't let the user change it
23  params.set<bool>("preset") = true;
24  params.suppressParameter<bool>("preset");
25 
26  return params;
27 }
28 
29 template <ComputeStage compute_stage>
31  : ADDirichletBCBase<compute_stage>(parameters)
32 {
33  mooseDeprecated("Inherit from ADDirichletBCBase with preset = true instead of ADPresetNodalBC");
34 }
ADNodalBCTempl::validParams
static InputParameters validParams()
Definition: ADNodalBC.C:26
defineADLegacyParams
defineADLegacyParams(ADPresetNodalBC)
ADPresetNodalBC
Base class for automatic differentiation nodal BCs that (pre)set the solution vector entries.
Definition: ADPresetNodalBC.h:17
ADPresetNodalBC::validParams
static InputParameters validParams()
Definition: ADPresetNodalBC.C:15
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
InputParameters::set
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
Definition: InputParameters.h:987
ADPresetNodalBC::ADPresetNodalBC
ADPresetNodalBC(const InputParameters &parameters)
Definition: ADPresetNodalBC.C:30
ADPresetNodalBC.h
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump.
Definition: InputParameters.C:70
ADDirichletBCBase
Base class for automatic differentiation Dirichlet BCs.
Definition: ADDirichletBCBase.h:19
InputParameters::suppressParameter
void suppressParameter(const std::string &name)
This method suppresses an inherited parameter so that it isn't required or valid in the derived class...
Definition: InputParameters.h:1367
MooseObject::mooseDeprecated
void mooseDeprecated(Args &&... args) const
Definition: MooseObject.h:156