AdaptivityAction
The AdaptivityAction has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with an Action; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.
# AdaptivityAction
!syntax description /Executioner/Adaptivity/AdaptivityAction
## Overview
!! Replace these lines with information regarding the AdaptivityAction action.
## Example Input File Syntax
!! Describe and include an example of how to use the AdaptivityAction action.
!syntax parameters /Executioner/Adaptivity/AdaptivityAction
!syntax description /Executioner/Adaptivity/AdaptivityAction
Input Parameters
- active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector
Description:If specified only the blocks named will be visited and made active
- coarsen_fraction0The fraction of elements or error to coarsen. Should be between 0 and 1.
Default:0
C++ Type:double
Description:The fraction of elements or error to coarsen. Should be between 0 and 1.
- cycles_per_step1The number of adaptivity cycles per step
Default:1
C++ Type:unsigned int
Description:The number of adaptivity cycles per step
- error_estimatorKellyErrorEstimatorThe class name of the error estimator you want to use.
Default:KellyErrorEstimator
C++ Type:MooseEnum
Description:The class name of the error estimator you want to use.
- inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector
Description:If specified blocks matching these identifiers will be skipped.
- initial_adaptivity0The number of adaptivity steps to perform using the initial conditions
Default:0
C++ Type:unsigned int
Description:The number of adaptivity steps to perform using the initial conditions
- interval1The number of time steps betweeen each adaptivity phase
Default:1
C++ Type:unsigned int
Description:The number of time steps betweeen each adaptivity phase
- max_h_level0Maximum number of times a single element can be refined. If 0 then infinite.
Default:0
C++ Type:unsigned int
Description:Maximum number of times a single element can be refined. If 0 then infinite.
- recompute_markers_during_cyclesFalseRecompute markers during adaptivity cycles
Default:False
C++ Type:bool
Description:Recompute markers during adaptivity cycles
- refine_fraction0The fraction of elements or error to refine. Should be between 0 and 1.
Default:0
C++ Type:double
Description:The fraction of elements or error to refine. Should be between 0 and 1.
- show_initial_progressTrueShow the progress of the initial adaptivity
Default:True
C++ Type:bool
Description:Show the progress of the initial adaptivity
- start_time-1.79769e+308The time that adaptivity will be active after.
Default:-1.79769e+308
C++ Type:double
Description:The time that adaptivity will be active after.
- steps0The number of adaptivity steps to perform at any one time for steady state
Default:0
C++ Type:unsigned int
Description:The number of adaptivity steps to perform at any one time for steady state
- stop_time1.79769e+308The time after which adaptivity will no longer be active.
Default:1.79769e+308
C++ Type:double
Description:The time after which adaptivity will no longer be active.
- weight_namesList of names of variables that will be associated with weight_values
C++ Type:std::vector
Description:List of names of variables that will be associated with weight_values
- weight_valuesList of values between 0 and 1 to weight the associated weight_names error by
C++ Type:std::vector
Description:List of values between 0 and 1 to weight the associated weight_names error by