StepChoosers::ElementSizeCfl< Dim, System > Class Template Reference
Sets a goal based on the CFL stability criterion, but uses the full size of the element as the length scale in question. More...
#include <ElementSizeCfl.hpp>
Classes | |
| struct | SafetyFactor |
Public Types | |
| using | options = tmpl::list< SafetyFactor > |
| using | argument_tags = tmpl::list<::Tags::TimeStepper< TimeStepper >, domain::Tags::SizeOfElement< Dim >, typename System::compute_largest_characteristic_speed::base > |
| using | compute_tags = tmpl::list< domain::Tags::SizeOfElementCompute< Dim >, typename System::compute_largest_characteristic_speed > |
Public Member Functions | |
| ElementSizeCfl (const double safety_factor) | |
| TimeStepRequest | operator() (const TimeStepper &time_stepper, const std::array< double, Dim > &element_size, const double speed, const double last_step) const |
| bool | uses_local_data () const override |
| Whether the result can differ on different elements, so requiring communication to synchronize the result across the domain. This is ignored for LTS step changing. More... | |
| bool | can_be_delayed () const override |
| Whether the result can be applied with a delay. More... | |
| void | pup (PUP::er &p) override |
 Public Member Functions inherited from StepChooser< StepChooserUse::Slab > | |
| WRAPPED_PUPable_abstract (StepChooser) | |
| virtual bool | uses_local_data () const=0 |
| Whether the result can differ on different elements, so requiring communication to synchronize the result across the domain. This is ignored for LTS step changing. More... | |
| virtual bool | can_be_delayed () const=0 |
| Whether the result can be applied with a delay. More... | |
| TimeStepRequest | desired_step (const double last_step, const db::DataBox< DbTags > &box) const |
The last_step parameter describes the step size to be adjusted. It may be the step size or the slab size, or may be infinite if the appropriate size cannot be determined. More... | |
| Public Member Functions inherited from StepChooser< StepChooserUse::LtsStep > | |
| WRAPPED_PUPable_abstract (StepChooser) | |
| virtual bool | uses_local_data () const=0 |
| Whether the result can differ on different elements, so requiring communication to synchronize the result across the domain. This is ignored for LTS step changing. More... | |
| virtual bool | can_be_delayed () const=0 |
| Whether the result can be applied with a delay. More... | |
| TimeStepRequest | desired_step (const double last_step, const db::DataBox< DbTags > &box) const |
The last_step parameter describes the step size to be adjusted. It may be the step size or the slab size, or may be infinite if the appropriate size cannot be determined. More... | |
Static Public Attributes | |
| static constexpr Options::String | help |
Detailed Description
template<size_t Dim, typename System>
class StepChoosers::ElementSizeCfl< Dim, System >
class StepChoosers::ElementSizeCfl< Dim, System >
Sets a goal based on the CFL stability criterion, but uses the full size of the element as the length scale in question.
This is useful as a coarse estimate for slabs, or to place a ceiling on another dynamically-adjusted step chooser.
Member Function Documentation
◆ can_be_delayed()
template<size_t Dim, typename System >
|
inlineoverridevirtual |
Whether the result can be applied with a delay.
StepChoosers setting the .end or .end_hard_limit fields of TimeStepRequest must return false here.
Implements StepChooser< StepChooserUse::Slab >.
◆ uses_local_data()
template<size_t Dim, typename System >
|
inlineoverridevirtual |
Whether the result can differ on different elements, so requiring communication to synchronize the result across the domain. This is ignored for LTS step changing.
- Note
- As this is only used for slab-size changing, the
last_steppassed to the call operator is not considered local data.
Implements StepChooser< StepChooserUse::Slab >.
Member Data Documentation
◆ help
template<size_t Dim, typename System >
|
staticconstexpr |
Initial value:
{
"Sets a goal based on the CFL stability criterion, but in which "
"the entire size of the element is used as the spacing in the "
"computation. This is useful primarily for placing a ceiling on another "
"dynamically-adjusted step chooser"}
The documentation for this class was generated from the following file:
- src/Time/StepChoosers/ElementSizeCfl.hpp