ah::InitialShapes::KerrSchild< Frame > Class Template Reference

An initial shape for a Strahlkorper corersponding to a Kerr-Schild black hole. More...

#include <KerrSchild.hpp>

Classes
struct	Center
struct	Mass
struct	Spin

Public Types
using	options = tmpl::list<Center, Mass, Spin>

Public Member Functions
	KerrSchild (std::array< double, 3 > center, double mass, std::array< double, 3 > spin)
ylm::Strahlkorper< Frame >	strahlkorper (size_t l_max, const Options::Context &context) const override
	Construct a Strahlkorper with both l_max and m_max set to l_max. The context is used to report option-parsing errors.
void	pup (PUP::er &p) override
Public Member Functions inherited from ylm::InitialShape< Frame >
	InitialShape (CkMigrateMessage *msg)
	WRAPPED_PUPable_abstract (InitialShape)

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

Static Public Attributes
static constexpr Options::String	help

Detailed Description

template<typename Frame>
class ah::InitialShapes::KerrSchild< Frame >

An initial shape for a Strahlkorper corersponding to a Kerr-Schild black hole.

Member Function Documentation

strahlkorper()

template<typename Frame>

ylm::Strahlkorper< Frame > ah::InitialShapes::KerrSchild< Frame >::strahlkorper ( size_t l_max, const Options::Context & context ) const

overridevirtual

Construct a Strahlkorper with both l_max and m_max set to l_max. The context is used to report option-parsing errors.

Implements ylm::InitialShape< Frame >.

Member Data Documentation

help

template<typename Frame>

Options::String ah::InitialShapes::KerrSchild< Frame >::help

staticconstexpr

Initial value:

= {
      "Construct a Kerr-Schild horizon for the given mass and dimensionless "
      "spin vector."}

---

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

• src/ParallelAlgorithms/ApparentHorizonFinder/KerrSchild.hpp