domain::creators::time_dependent_options::GridCentersOptions Struct Reference

Class that holds map options from the grid centers location. More...

#include <GridCenters.hpp>

Classes
struct	ScaleInspiralRateBy
struct	SpecEvolutionParametersPerlFile

Public Types
using	type = Options::Auto<GridCentersOptions, Options::AutoLabel::None>
using	options

Public Member Functions
	GridCentersOptions (const std::string &spec_evolution_parameters_perl_file, std::optional< double > in_scale_inspiral_rate_by, const Options::Context &context={})

Static Public Member Functions
static std::string	name ()

Public Attributes
std::array< DataVector, 3 >	initial_values {}
std::optional< double >	scale_inspiral_rate_by {std::nullopt}

Static Public Attributes
static constexpr Options::String	help

Detailed Description

Class that holds map options from the grid centers location.

This is needed in BNS simulations where the stars are not at the centers of the cubes.

Details

This class can also be used as an option tag with the type type alias, name() function, and help string.

Member Typedef Documentation

options

using domain::creators::time_dependent_options::GridCentersOptions::options

Initial value:

 
      tmpl::list<SpecEvolutionParametersPerlFile, ScaleInspiralRateBy>

Member Data Documentation

help

Options::String domain::creators::time_dependent_options::GridCentersOptions::help

staticconstexpr

Initial value:

= {
      "Sets the initial value of the GridCenters of the objects."}

---

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

• src/Domain/Creators/TimeDependentOptions/GridCenters.hpp