www.mooseframework.org
ConservedAction.h
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 #pragma once
11 
12 // MOOSE includes
13 #include "Action.h"
14 
15 #include "libmesh/fe_type.h"
16 
17 // Forward declaration
18 class ConservedAction;
19 
20 template <>
21 InputParameters validParams<ConservedAction>();
22 
23 class ConservedAction : public Action
24 {
25 public:
26  ConservedAction(const InputParameters & params);
27 
28  virtual void act() override;
29 
30 protected:
32  enum class SolveType
33  {
34  DIRECT,
37  };
39  std::string _chempot_name;
43  const NonlinearVariableName _var_name;
45  FEType _fe_type;
47  const Real _scaling;
48 };
49 
ConservedAction::act
virtual void act() override
Definition: ConservedAction.C:90
ConservedAction::_var_name
const NonlinearVariableName _var_name
Name of the variable being created.
Definition: ConservedAction.h:43
ConservedAction::_solve_type
const SolveType _solve_type
Type of solve to use used in the action.
Definition: ConservedAction.h:41
ConservedAction::SolveType
SolveType
Type of solve.
Definition: ConservedAction.h:32
ConservedAction::_chempot_name
std::string _chempot_name
Name of chemical potential variable for split solves.
Definition: ConservedAction.h:39
ConservedAction::_scaling
const Real _scaling
Scaling parameter.
Definition: ConservedAction.h:47
ConservedAction
Definition: ConservedAction.h:23
ConservedAction::_fe_type
FEType _fe_type
FEType for the variable being created.
Definition: ConservedAction.h:45
ConservedAction::SolveType::FORWARD_SPLIT
ConservedAction::SolveType::REVERSE_SPLIT
ConservedAction::SolveType::DIRECT
ConservedAction::ConservedAction
ConservedAction(const InputParameters &params)
Definition: ConservedAction.C:62
validParams< ConservedAction >
InputParameters validParams< ConservedAction >()
Definition: ConservedAction.C:27