ah::Criteria::Shape Class Reference

Recommend an updated resolution \(L_{\rm new}\) based on how well the shape of the apparent horizon is resolved in terms of its truncation error and pile up modes. More...

#include <Shape.hpp>

Classes
struct	MaxPileUpModes
struct	MaxTruncationError
struct	MinResolutionL
struct	MinTruncationError

Public Types
using	options
using	argument_tags = tmpl::list<>
using	compute_tags_for_observation_box = tmpl::list<>

Public Member Functions
	Shape (double min_truncation_error, double max_truncation_error, size_t max_pile_up_modes, size_t min_resolution_l, const Options::Context &context={})
std::string	observation_name () override
template<typename Metavariables, typename Frame>
size_t	operator() (const Parallel::GlobalCache< Metavariables > &cache, const ylm::Strahlkorper< Frame > &strahlkorper, const FastFlow::IterInfo &) const
void	pup (PUP::er &p) override
bool	is_equal (const Criterion &other) const override
Public Member Functions inherited from ah::Criterion
	Criterion (CkMigrateMessage *msg)
	WRAPPED_PUPable_abstract (Criterion)
template<typename ComputeTagsList, typename DataBoxType, typename Metavariables, typename Frame>
auto	evaluate (const ObservationBox< ComputeTagsList, DataBoxType > &box, Parallel::GlobalCache< Metavariables > &cache, const ylm::Strahlkorper< Frame > &strahlkorper, const FastFlow::IterInfo &info) const
	Evaluates the apparent horizon criteria by selecting the appropriate derived class and forwarding its argument_tags from the ObservationBox (along with the GlobalCache) to the call operator of the derived class.

Static Public Attributes
static constexpr Options::String	help

Detailed Description

Recommend an updated resolution \(L_{\rm new}\) based on how well the shape of the apparent horizon is resolved in terms of its truncation error and pile up modes.

Details

The returned recommended resolution \(L_{\rm new}\) depends on the following options:

• MinTruncationError: a minimum truncation error \(\mathcal{T}_{\rm min}\)
• MaxTruncationError: a maximum truncation error \(\mathcal{T}_{\rm max}\)
• MaxPileUpModes: a maximum number of pile up modes \(\mathcal{P}_{\rm max}\)
• MinResolutionL: a minimum resolution \(L_{\rm min}\)

The maximum resolution \(L_{\rm max}\) is supplied by the global cache entry ah::Tags::LMax. The value returned for \(L_{\rm new}\) is then determined as follows: The value returned for \(L_{\rm new}\) is then determined as follows:

• If \(L > L_{\rm min}\) and \(\mathcal{T} < \mathcal{T}_{\rm min}\), then \(L_{\rm new} = L - 1\)
• If \(L < L_{\rm max}\) and \(\mathcal{T} > \mathcal{T}_{\rm max}\) and \(\mathcal{P} \le \mathcal{P}_{\rm max}\), then \(L_{\rm new} = L + 1\)
• Otherwise, \(L_{\rm new} = L\) Note that the truncation error is obtained via PowerMonitors::relative_truncation_error, and the number of pileup modes is given by PowerMonitors::convergence_rate_and_number_of_pile_up_modes

Member Typedef Documentation

options

using ah::Criteria::Shape::options

Initial value:

 tmpl::list<MinTruncationError, MaxTruncationError,
                             MaxPileUpModes, MinResolutionL>

Member Function Documentation

is_equal()

bool ah::Criteria::Shape::is_equal ( const Criterion & other ) const

overridevirtual

Implements ah::Criterion.

observation_name()

std::string ah::Criteria::Shape::observation_name ( )

inlineoverridevirtual

Implements ah::Criterion.

Member Data Documentation

help

Options::String ah::Criteria::Shape::help

staticconstexpr

Initial value:

= {
      "Use Strahlkorper truncation error, number of pile up modes, and "
      "resolution to suggest a new resolution."}

---

The documentation for this class was generated from the following file:

• src/ParallelAlgorithms/ApparentHorizonFinder/Criteria/Shape.hpp