ah::HorizonOptions< Fr > Struct Template Reference

Options for finding an apparent horizon. More...

#include <OptionTags.hpp>

Classes
struct	BlocksForHorizonFind
struct	Criteria
struct	FastFlow
	See FastFlow for suboptions. More...
struct	InitialGuess
	See Strahlkorper for suboptions. More...
struct	MaxComputeCoordsRetries
struct	Verbosity

Public Types
using	options

Public Member Functions
	HorizonOptions (std::vector< std::unique_ptr< ah::Criterion > > criteria_in, ylm::Strahlkorper< Fr > initial_guess_in, ::FastFlow fast_flow_in, ::Verbosity verbosity_in, size_t max_compute_coords_retries_in, std::optional< std::vector< std::string > > blocks_for_horizon_find_in)
	HorizonOptions (const HorizonOptions &)=delete
HorizonOptions &	operator= (const HorizonOptions &)=delete
	HorizonOptions (HorizonOptions &&)=default
HorizonOptions &	operator= (HorizonOptions &&)=default
void	pup (PUP::er &p)

Public Attributes
std::vector< std::unique_ptr< ah::Criterion > >	criteria
ylm::Strahlkorper< Fr >	initial_guess {}
::FastFlow	fast_flow
::Verbosity	verbosity {::Verbosity::Quiet}
size_t	max_compute_coords_retries {}
std::optional< std::vector< std::string > >	blocks_for_horizon_find

Static Public Attributes
static constexpr Options::String	help

Detailed Description

template<typename Fr>
struct ah::HorizonOptions< Fr >

Options for finding an apparent horizon.

Member Typedef Documentation

options

template<typename Fr>

using ah::HorizonOptions< Fr >::options

Initial value:

 tmpl::list<Criteria, InitialGuess, FastFlow, Verbosity,
                             MaxComputeCoordsRetries, BlocksForHorizonFind>

Member Data Documentation

help

template<typename Fr>

Options::String ah::HorizonOptions< Fr >::help

staticconstexpr

Initial value:

= {
      "Provide an initial guess for the apparent horizon surface\n"
      "(Strahlkorper) and apparent-horizon-finding-algorithm (FastFlow)\n"
      "options."}

---

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

• src/ParallelAlgorithms/ApparentHorizonFinder/OptionTags.hpp