https://mooseframework.inl.gov
NEML2PostKernel.C
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 #ifdef NEML2_ENABLED
11 
12 // MOOSE includes
13 #include "NEML2PostKernel.h"
14 
17 {
19  params.addRequiredParam<UserObjectName>(
20  "executor",
21  "The NEML2ModelExecutor used to perform the constitutive update (where stress is an output "
22  "variable). If you are using the NEML2 action, the parameter executor_name can be used to "
23  "specify the name of the NEML2ModelExecutor.");
24 
25  ExecFlagEnum & exec_enum = params.set<ExecFlagEnum>("execute_on", true);
27  exec_enum = {EXEC_INITIAL, EXEC_PRE_KERNELS};
28  params.suppressParameter<ExecFlagEnum>("execute_on");
29 
30  return params;
31 }
32 
34  : NEML2Kernel(parameters), _constitutive(getUserObject<NEML2ModelExecutor>("executor"))
35 {
36 }
37 
38 #endif
NEML2PostKernel(const InputParameters &parameters)
A MultiMooseEnum object to hold "execute_on" flags.
Definition: ExecFlagEnum.h:21
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void addAvailableFlags(const ExecFlagType &flag, Args... flags)
Add additional execute_on flags to the list of possible flags.
Definition: ExecFlagEnum.h:82
static InputParameters validParams()
Definition: NEML2Kernel.C:16
void addRequiredParam(const std::string &name, const std::string &doc_string)
This method adds a parameter and documentation string to the InputParameters object that will be extr...
void suppressParameter(const std::string &name)
This method suppresses an inherited parameter so that it isn&#39;t required or valid in the derived class...
NEML2ModelExecutor executes a NEML2 model.
static InputParameters validParams()
const ExecFlagType EXEC_PRE_KERNELS
Definition: Moose.C:56
NEML2Kernel is a conceptual extension of MOOSE kernel that operates on NEML2 tensors.
Definition: NEML2Kernel.h:33
const ExecFlagType EXEC_INITIAL
Definition: Moose.C:30