www.mooseframework.org
ADPresetBC.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 "ADPresetBC.h"
11 
12 registerADMooseObjectDeprecated("MooseApp", ADPresetBC, "06/30/2020 24:00");
13 
15 
16 template <ComputeStage compute_stage>
19 {
21  params.addClassDescription(
22  "Similar to ADDirichletBC except the value is applied before the solve begins. Deprecated: "
23  "use ADDirichletBC with preset = true instead.");
24 
25  // Utilize the new ADDirichletBC with preset, set true and don't let the user change it
26  params.set<bool>("preset") = true;
27  params.suppressParameter<bool>("preset");
28 
29  return params;
30 }
31 
32 template <ComputeStage compute_stage>
34  : ADDirichletBC<compute_stage>(parameters)
35 {
36  mooseDeprecated("Use ADDirichletBC with preset = true instead of ADPresetBC");
37 }
ADPresetBC.h
ADPresetBC
Defines a boundary condition that (pre)sets the solution at the boundary to be a user specified value...
Definition: ADPresetBC.h: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
ADDirichletBC::validParams
static InputParameters validParams()
Definition: ADDirichletBC.C:18
registerADMooseObjectDeprecated
registerADMooseObjectDeprecated("MooseApp", ADPresetBC, "06/30/2020 24:00")
ADPresetBC::validParams
static InputParameters validParams()
Definition: ADPresetBC.C:18
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
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
ADDirichletBC
Boundary condition of a Dirichlet type.
Definition: ADDirichletBC.h:19
ADPresetBC::ADPresetBC
ADPresetBC(const InputParameters &parameters)
Definition: ADPresetBC.C:33
defineADLegacyParams
defineADLegacyParams(ADPresetBC)