SpECTRE  2021.08.02
StepChoosers::ElementSizeCfl< StepChooserUse, Dim, System > Class Template Reference

Suggests a step size 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<>, domain::Tags::SizeOfElement< Dim >, typename System::compute_largest_characteristic_speed >
 
using return_tags = tmpl::list<>
 
using compute_tags = tmpl::list< domain::Tags::SizeOfElementCompute< Dim >, typename System::compute_largest_characteristic_speed >
 

Public Member Functions

 ElementSizeCfl (const double safety_factor) noexcept
 
template<typename Metavariables >
std::pair< double, bool > operator() (const typename Metavariables::time_stepper_tag::type::element_type &time_stepper, const std::array< double, Dim > &element_size, const double speed, const double last_step_magnitude, const Parallel::GlobalCache< Metavariables > &) const noexcept
 
void pup (PUP::er &p) noexcept override
 

Static Public Attributes

static constexpr Options::String help
 

Detailed Description

template<typename StepChooserUse, size_t Dim, typename System>
class StepChoosers::ElementSizeCfl< StepChooserUse, Dim, System >

Suggests a step size 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 Data Documentation

◆ help

template<typename StepChooserUse , size_t Dim, typename System >
constexpr Options::String StepChoosers::ElementSizeCfl< StepChooserUse, Dim, System >::help
staticconstexpr
Initial value:
{
"Suggests a step size 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"}