www.mooseframework.org
Classes | Functions
AdaptivityAction.h File Reference

Go to the source code of this file.

Classes

class  AdaptivityAction
 

Functions

template<>
InputParameters validParams< AdaptivityAction > ()
 

Function Documentation

Definition at line 31 of file AdaptivityAction.C.

32 {
34  MooseEnum estimators("KellyErrorEstimator LaplacianErrorEstimator PatchRecoveryErrorEstimator",
35  "KellyErrorEstimator");
36 
37  params.addParam<unsigned int>(
38  "steps", 0, "The number of adaptivity steps to perform at any one time for steady state");
39  params.addRangeCheckedParam<unsigned int>(
40  "interval", 1, "interval>0", "The number of time steps betweeen each adaptivity phase");
41  params.addParam<unsigned int>(
42  "initial_adaptivity",
43  0,
44  "The number of adaptivity steps to perform using the initial conditions");
45  params.addParam<Real>("refine_fraction",
46  0.0,
47  "The fraction of elements or error to refine. Should be between 0 and 1.");
48  params.addParam<Real>("coarsen_fraction",
49  0.0,
50  "The fraction of elements or error to coarsen. Should be between 0 and 1.");
51  params.addParam<unsigned int>(
52  "max_h_level",
53  0,
54  "Maximum number of times a single element can be refined. If 0 then infinite.");
55  params.addParam<MooseEnum>(
56  "error_estimator", estimators, "The class name of the error estimator you want to use.");
57  params.addDeprecatedParam<bool>(
58  "print_changed_info",
59  false,
60  "Determines whether information about the mesh is printed when adaptivity occurs",
61  "Use the Console output parameter 'print_mesh_changed_info'");
62  params.addParam<Real>("start_time",
63  -std::numeric_limits<Real>::max(),
64  "The time that adaptivity will be active after.");
65  params.addParam<Real>("stop_time",
66  std::numeric_limits<Real>::max(),
67  "The time after which adaptivity will no longer be active.");
68  params.addParam<std::vector<std::string>>(
69  "weight_names", "List of names of variables that will be associated with weight_values");
70  params.addParam<std::vector<Real>>(
71  "weight_values",
72  "List of values between 0 and 1 to weight the associated weight_names error by");
73  params.addParam<unsigned int>("cycles_per_step", 1, "The number of adaptivity cycles per step");
74 
75  params.addParam<bool>(
76  "show_initial_progress", true, "Show the progress of the initial adaptivity");
77  params.addParam<bool>(
78  "recompute_markers_during_cycles", false, "Recompute markers during adaptivity cycles");
79  return params;
80 }
void addDeprecatedParam(const std::string &name, const T &value, const std::string &doc_string, const std::string &deprecation_message)
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...
Definition: MooseEnum.h:37
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...
void addRangeCheckedParam(const std::string &name, const T &value, const std::string &parsed_function, const std::string &doc_string)
InputParameters validParams< Action >()
Definition: Action.C:23